Supercode is an open source AI coding agent that works where you work — terminal, web, IDE, Slack, and more. Describe what you need, and Supercode handles the rest.
This documentation covers everything from installation to advanced usage.
Quick Start
Get Supercode running in under a minute:
npm install -g supercode-cli
Or try it without installing:
npx supercode-cli
curl -fsSL https://supercode.ai/install | bash
brew install supercode
Verify the install:
supercode --version
Then authenticate and start coding:
supercode login
cd /path/to/your-project
supercode
How It Works
Supercode is a terminal-based AI coding agent that understands your codebase. It uses AI models to read, write, and execute code based on natural language instructions.
- Codebase-aware — Supercode analyzes your project structure, coding patterns, and dependencies to make relevant changes
- Multi-provider — Use OpenAI, Anthropic, Google Gemini, OpenRouter, MiniMax, NVIDIA, and more
- Taste learning — Supercode learns your preferences as you work (package manager, libraries, code style)
- Undo/redo — Every change is reversible with
/undoand/redo
Three Modes
Supercode operates in three modes, each suited for different workflows:
| Mode | Description | Best for | |------|-------------|----------| | Chat | Direct conversation with AI, workspace context as system prompt | Questions, code review, explanations | | Tools | AI with file system access (read, search, grep) | Changes that need file exploration | | Agent | Autonomous coding agent that can read, write, and execute commands | Building features, refactoring, debugging |
Switch modes mid-session with the /mode command.
Web Terminal
Supercode also runs in your browser at supercode-terminal.vercel.app. Features include:
- Session management with conversation history
- Workspace file explorer
- Multi-session tabs
- Device authorization for secure CLI login
Key Features
Codebase Understanding
Run /init in any project to have Supercode analyze your codebase. It learns:
- Project structure and framework
- Coding patterns and conventions
- Dependencies and configuration
- Language and runtime specifics
Taste Profile
Supercode builds a taste profile as you work. Run supercode taste to see what it knows about your preferences. This profile carries between sessions and only relevant taste context loads per session.
Multi-step Reasoning
For complex tasks, Supercode can:
- Create detailed plans before making changes
- Search across files to find relevant code
- Make coordinated multi-file edits
- Run commands and interpret output
- Undo unwanted changes
Supported Platforms
| Platform | Status | |----------|--------| | macOS | ✅ Supported | | Linux | ✅ Supported (x86_64, aarch64) | | Windows | ✅ WSL recommended | | Web | ✅ Available at supercode-terminal.vercel.app |
Next Steps
- Quickstart — Get up and running in 5 minutes
- Authentication — Set up authentication and API keys
- Terminal Getting Started — Detailed terminal setup guide
- Architecture — How Supercode works under the hood
- Providers — Supported AI providers and configuration