selfhostyourtech/cubbi
2
0
Fork 0
mirror of https://github.com/Monadical-SAS/cubbi.git synced 2025-12-21 04:39:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Prefer mcx alias in README examples

Browse Source
This commit is contained in:
Mathieu Virbel (aider)
2025-04-01 09:53:14 -06:00
committed by Mathieu Virbel
parent 6b2c1ebf1c
commit 9c21611a7f
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -8,7 +8,7 @@ Docker-in-Docker (DinD) environment. MC also supports connecting to MCP (Model C
## Quick Reference ## Quick Reference
- `mc session create` - Create a new session - `mc session create` - Create a new session
- `mcx` - Shortcut for `mc session create` (mount directories or clone repos) - `mcx` - Shortcut for `mc session create`
- `mcx .` - Mount the current directory - `mcx .` - Mount the current directory
- `mcx /path/to/dir` - Mount a specific directory - `mcx /path/to/dir` - Mount a specific directory
- `mcx https://github.com/user/repo` - Clone a repository - `mcx https://github.com/user/repo` - Clone a repository
@@ -38,11 +38,11 @@ mc --help
# Show help message (displays available commands) # Show help message (displays available commands)
mc mc
# Create a new session with the default driver # Create a new session with the default driver (using mcx alias)
mc session create mcx
# Create a session and run an initial command before the shell starts # Create a session and run an initial command before the shell starts
mc session create --run "echo 'Setup complete'; ls -l" mcx --run "echo 'Setup complete'; ls -l"
# List all active sessions # List all active sessions
mc session list mc session list
@@ -54,27 +54,27 @@ mc session connect SESSION_ID
mc session close SESSION_ID mc session close SESSION_ID
# Create a session with a specific driver # Create a session with a specific driver
mc session create --driver goose mcx --driver goose
# Create a session with environment variables # Create a session with environment variables
mc session create -e VAR1=value1 -e VAR2=value2 mcx -e VAR1=value1 -e VAR2=value2
# Mount custom volumes (similar to Docker's -v flag) # Mount custom volumes (similar to Docker's -v flag)
mc session create -v /local/path:/container/path mcx -v /local/path:/container/path
mc session create -v ~/data:/data -v ./configs:/etc/app/config mcx -v ~/data:/data -v ./configs:/etc/app/config
# Mount a local directory (current directory or specific path) # Mount a local directory (current directory or specific path)
mc session create . mcx .
mc session create /path/to/project mcx /path/to/project
# Connect to external Docker networks # Connect to external Docker networks
mc session create --network teamnet --network dbnet mcx --network teamnet --network dbnet
# Connect to MCP servers for extended capabilities # Connect to MCP servers for extended capabilities
mc session create --mcp github --mcp jira mcx --mcp github --mcp jira
# Clone a Git repository # Clone a Git repository
mc session create https://github.com/username/repo mcx https://github.com/username/repo
# Using the mcx shortcut (equivalent to mc session create) # Using the mcx shortcut (equivalent to mc session create)
mcx # Creates a session without mounting anything mcx # Creates a session without mounting anything