|
| 1 | +# Roo CLI Documentation |
| 2 | + |
| 3 | +Welcome to the Roo Command Line Interface (CLI) documentation. Roo CLI is a powerful AI-powered development assistant that brings the capabilities of the Roo Code VS Code extension to the command line. |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +### Installation |
| 8 | + |
| 9 | +```bash |
| 10 | +npm install -g roo-cli |
| 11 | +``` |
| 12 | + |
| 13 | +### Basic Usage |
| 14 | + |
| 15 | +```bash |
| 16 | +# Start interactive mode |
| 17 | +roo-cli |
| 18 | + |
| 19 | +# Run a single task |
| 20 | +roo-cli --batch "Create a hello world function" |
| 21 | + |
| 22 | +# Run with specific configuration |
| 23 | +roo-cli --config ./my-config.json |
| 24 | + |
| 25 | +# Generate default configuration |
| 26 | +roo-cli --generate-config ~/.roo-cli/config.json |
| 27 | +``` |
| 28 | + |
| 29 | +## Documentation Structure |
| 30 | + |
| 31 | +### 📚 Getting Started |
| 32 | + |
| 33 | +- [Installation Guide](./installation.md) - Installation and setup instructions |
| 34 | +- [Getting Started](./getting-started.md) - First steps with Roo CLI |
| 35 | + |
| 36 | +### ⚙️ Configuration |
| 37 | + |
| 38 | +- [Configuration Overview](./configuration/overview.md) - Configuration system overview |
| 39 | +- [File Format](./configuration/file-format.md) - Configuration file format reference |
| 40 | +- [Environment Variables](./configuration/environment-variables.md) - Environment variable reference |
| 41 | +- [Examples](./configuration/examples.md) - Configuration examples |
| 42 | + |
| 43 | +### 🖥️ Commands |
| 44 | + |
| 45 | +- [Commands Overview](./commands/overview.md) - All available commands |
| 46 | +- [Core Commands](./commands/core-commands.md) - Essential commands |
| 47 | +- [Tool Commands](./commands/tool-commands.md) - Tool-related commands |
| 48 | +- [Session Commands](./commands/session-commands.md) - Session management |
| 49 | +- [MCP Commands](./commands/mcp-commands.md) - Model Context Protocol commands |
| 50 | + |
| 51 | +### 🔧 Tools |
| 52 | + |
| 53 | +- [Tools Overview](./tools/overview.md) - Available tools and capabilities |
| 54 | +- [File Operations](./tools/file-operations.md) - File manipulation tools |
| 55 | +- [Browser Tools](./tools/browser-tools.md) - Web browser automation |
| 56 | +- [Terminal Tools](./tools/terminal-tools.md) - Terminal and command execution |
| 57 | +- [Custom Tools](./tools/custom-tools.md) - Creating custom tools |
| 58 | + |
| 59 | +### 📖 Guides |
| 60 | + |
| 61 | +- [Workflows](./guides/workflows.md) - Common workflow patterns |
| 62 | +- [Automation](./guides/automation.md) - Automating tasks with Roo CLI |
| 63 | +- [Integration](./guides/integration.md) - Integrating with other tools |
| 64 | +- [Best Practices](./guides/best-practices.md) - Best practices and tips |
| 65 | + |
| 66 | +### 🔍 Troubleshooting |
| 67 | + |
| 68 | +- [Common Issues](./troubleshooting/common-issues.md) - Frequently encountered problems |
| 69 | +- [Debugging](./troubleshooting/debugging.md) - Debugging techniques |
| 70 | +- [Performance](./troubleshooting/performance.md) - Performance optimization |
| 71 | +- [Platform-Specific](./troubleshooting/platform-specific.md) - OS-specific issues |
| 72 | + |
| 73 | +### 🚀 Migration |
| 74 | + |
| 75 | +- [From VS Code](./migration/from-vscode.md) - Migrating from VS Code extension |
| 76 | +- [Feature Comparison](./migration/feature-comparison.md) - CLI vs VS Code features |
| 77 | +- [Workflow Adaptation](./migration/workflow-adaptation.md) - Adapting workflows |
| 78 | + |
| 79 | +### 🔌 API Reference |
| 80 | + |
| 81 | +- [Interfaces](./api/interfaces.md) - Core interfaces and types |
| 82 | +- [Services](./api/services.md) - Service layer documentation |
| 83 | +- [Extensions](./api/extensions.md) - Extending Roo CLI |
| 84 | + |
| 85 | +## Key Features |
| 86 | + |
| 87 | +- **Interactive Mode**: Full-featured REPL for conversational development |
| 88 | +- **Batch Processing**: Execute multiple tasks from files or command line |
| 89 | +- **Multiple Output Formats**: JSON, YAML, CSV, Markdown, and plain text |
| 90 | +- **Session Management**: Save, load, and manage development sessions |
| 91 | +- **MCP Integration**: Connect to Model Context Protocol servers |
| 92 | +- **Browser Automation**: Headless and headed browser control |
| 93 | +- **Configuration Management**: Flexible configuration system |
| 94 | +- **Cross-Platform**: Works on Windows, macOS, and Linux |
| 95 | + |
| 96 | +## Support |
| 97 | + |
| 98 | +- **Documentation**: [https://docs.roocode.com/cli](https://docs.roocode.com/cli) |
| 99 | +- **GitHub Issues**: [https://github.com/roo-dev/roo/issues](https://github.com/roo-dev/roo/issues) |
| 100 | +- **Community**: [Discord](https://discord.gg/roo) | [GitHub Discussions](https://github.com/roo-dev/roo/discussions) |
| 101 | + |
| 102 | +## Quick Reference |
| 103 | + |
| 104 | +### Most Common Commands |
| 105 | + |
| 106 | +```bash |
| 107 | +roo-cli # Interactive mode |
| 108 | +roo-cli --batch "task description" # Single task |
| 109 | +roo-cli config --show # Show configuration |
| 110 | +roo-cli session list # List sessions |
| 111 | +roo-cli mcp list # List MCP servers |
| 112 | +roo-cli --help # Show help |
| 113 | +``` |
| 114 | + |
| 115 | +### Environment Variables |
| 116 | + |
| 117 | +```bash |
| 118 | +export ROO_API_KEY="your-api-key" |
| 119 | +export ROO_CONFIG_PATH="./config.json" |
| 120 | +export ROO_OUTPUT_FORMAT="json" |
| 121 | +``` |
| 122 | + |
| 123 | +For detailed information, explore the documentation sections above or run `roo-cli --help` for command-line help. |
0 commit comments