Skip to content

cli-usage.md

Latest commit

 

History

History
164 lines (114 loc) · 3.79 KB

cli-usage.md

File metadata and controls

164 lines (114 loc) · 3.79 KB
Raw

DockaShell CLI Usage

📝 Quick Start

# Check system health
dockashell status

# Build default development image
dockashell build

# Create and start a project
dockashell create web-app
dockashell start web-app

# Monitor activity
dockashell logs web-app

📖 Command Reference

System Status

dockashell status [--json] Show comprehensive system status including Docker daemon, default image, and all projects with container states.

dockashell status                   # Human-readable overview
dockashell status --json            # For scripts/automation

Image Management

dockashell build [--force] Build the default DockaShell development image with Python 3.12, Node.js 20 LTS, and essential development tools.

dockashell build                    # Build if missing
dockashell build --force            # Force fresh rebuild

Project Management

dockashell create <project> Create a new project with default configuration.

dockashell create my-web-app        # Create web project
dockashell create data-science      # Create data project

dockashell start <project> Start a project container. Creates container from config if needed.

dockashell start web-app            # Start web-app project
dockashell start data-analysis      # Start data project

dockashell stop <project> Stop a running project container gracefully.

dockashell stop web-app             # Stop specific project

dockashell rebuild <project> Stop, remove, and restart project container to apply configuration changes.

dockashell rebuild web-app          # Apply config changes

Monitoring

dockashell logs [project] Launch interactive trace viewer (TUI) for monitoring project activity.

dockashell logs                     # Show project selector
dockashell logs web-app             # Open specific project

Keyboard shortcuts in trace viewer:

  • ↑↓ Navigate traces
  • Enter: View trace details
  • f: Filter by type
  • /: Search
  • q: Quit

MCP Integration

dockashell serve Start MCP (Model Context Protocol) server for AI agent integration.

dockashell serve                    # Start stdio server

dockashell remote [options] Start remote MCP server with HTTP transport and authentication.

dockashell remote --setup-auth      # Setup authentication
dockashell remote                   # Start on default port 3333
dockashell remote -p 8080           # Start on custom port

Options:

  • -p, --port <port> - Port to run server on (default: 3333)
  • --setup-auth - Setup initial authentication credentials

Help

dockashell help [command] Show detailed help for command.

dockashell help                     # Show main help
dockashell help status              # Show detailed help for status

🔄 Common Workflows

Web Development Project

# Setup
dockashell build
dockashell create web-app
dockashell start web-app

# Development
dockashell logs web-app             # Monitor in separate terminal

# Apply config changes
# (edit ~/.dockashell/projects/web-app/config.json)
dockashell rebuild web-app

Multi-Project Management

# Overview
dockashell status

# Start multiple projects
dockashell start web-app
dockashell start api-service
dockashell start frontend

# Monitor all activity
dockashell logs                     # Use project selector

# Stop when done
dockashell stop web-app
dockashell stop api-service
dockashell stop frontend

AI Agent Integration

# Local AI client integration
dockashell serve

# Remote AI client integration
dockashell remote --setup-auth      # One-time setup
dockashell remote                   # Start server

For detailed help on any command: dockashell help <command>