Documentation Index
Fetch the complete documentation index at: https://docs.vibekit.sh/llms.txt
Use this file to discover all available pages before exploring further.
Essential Commands
Setup & Installation
# Install VibeKit CLI globally
npm install -g vibekit
# Configure settings
vibekit
# Set up global aliases (optional)
vibekit setup-aliases
Running Agents
# Run Claude with default settings
vibekit claude "Create a REST API"
# Run Claude with Docker sandbox (maximum security)
vibekit claude --sandbox docker "Add authentication"
# Run Gemini with network access
vibekit gemini --network "Create a web scraper"
# Pass additional arguments to the underlying agent
vibekit claude --help
vibekit claude --model claude-3-5-sonnet-20241022 "Generate code"
Sandbox Options
# No sandbox (default, fast startup)
vibekit claude --sandbox none "Fix the bug"
# Docker sandbox (complete isolation)
vibekit claude --sandbox docker "Run untrusted code"
# Docker with no network access (maximum security)
vibekit claude --sandbox docker --no-network "Secure development"
# Use fresh container instead of persistent one
vibekit claude --sandbox docker --fresh-container "Clean environment"
Monitoring & Analytics
# View recent logs
vibekit logs
# View logs for specific agent
vibekit logs --agent claude --lines 100
# View analytics and statistics
vibekit analytics --days 7
# View analytics for specific agent
vibekit analytics --agent claude --summary
# Export analytics to file
vibekit analytics --export analytics.json
Dashboard & Web Interface
# Start analytics dashboard and open in browser
vibekit dashboard
# Start dashboard on specific port
vibekit dashboard start --port 3001 --open
# Stop dashboard
vibekit dashboard stop
Common Workflows
Secure Development
# 1. Enable Docker sandbox in settings
vibekit
# 2. Run agents in isolated containers
vibekit claude --sandbox docker "Implement user authentication"
# 3. Sync changes back to your project when ready
vibekit sync
# 4. Monitor activity in dashboard
vibekit dashboard
Debugging & Analysis
# 1. Run agent and capture all interactions
vibekit claude --sandbox docker "Debug the payment system"
# 2. Check logs for errors
vibekit logs --agent claude --lines 50
# 3. View analytics to understand patterns
vibekit analytics --agent claude --days 1
# 4. Check container status if needed
vibekit docker --status
Team Collaboration
# 1. Enable proxy for request logging
vibekit proxy start
# 2. Run agents through proxy
vibekit claude --proxy http://localhost:8080 "Add new feature"
# 3. Share analytics and logs with team
vibekit analytics --export team-report.json
# 4. Clean up when done
vibekit clean
Proxy & Security
# Start proxy server for request logging
vibekit proxy start --port 8080
# Kill proxy server on specific port
vibekit proxy kill --port 8080
# Run agent through custom proxy
vibekit claude --proxy http://proxy.example.com:8080 "Generate code"
Docker Management
# Check Docker container status
vibekit docker --status
# Stop persistent container
vibekit docker --stop
# Restart persistent container
vibekit docker --restart
# Sync changes from sandbox to project
vibekit sync
Maintenance
# Clean all data
vibekit clean
# Clean only logs
vibekit clean --logs
# Clean only Docker resources
vibekit clean --docker
# Clean only analytics
vibekit clean --analytics
Environment Variables Quick Reference
# In .env file or shell
export ANTHROPIC_API_KEY="sk-ant-..." # For Claude
export GOOGLE_API_KEY="..." # For Gemini
export HTTP_PROXY="http://..." # Proxy for all requests
export HTTPS_PROXY="http://..." # HTTPS proxy
export VIBEKIT_DEBUG="1" # Enable debug logging
Keyboard Shortcuts
When using interactive commands:
↑/↓ - Navigate options
Space - Select/deselect option
Enter - Confirm selection
Ctrl+C - Cancel operation
Common Flags
| Flag | Description | Example |
|---|
--sandbox <type> | Sandbox type (none, docker) | --sandbox docker |
--proxy <url> | HTTP proxy URL | --proxy http://localhost:8080 |
--network / --no-network | Network access control | --no-network |
--fresh-container | Use new Docker container | --fresh-container |
-a, --agent <agent> | Filter by agent | --agent claude |
-n, --lines <number> | Number of lines | --lines 100 |
--json | JSON output | --json |
--export <file> | Export to file | --export report.json |
-p, --port <port> | Port number | --port 3001 |
Exit Codes
0 - Success
1 - General error
127 - Command not found
130 - Interrupted (Ctrl+C)
Getting Help
# General help
vibekit --help
# Command-specific help
vibekit claude --help
vibekit analytics --help
vibekit dashboard --help
# Show version
vibekit --version
# Diagnose setup issues
vibekit diagnose-aliases