-
-
Notifications
You must be signed in to change notification settings - Fork 140
Quick Start
unohee edited this page Apr 16, 2026
·
1 revision
npm install -g @intrect/openswarm
openswarm
This launches the rich TUI chat interface. No configuration file needed.
| Key | Action |
|---|---|
Tab |
Switch tabs (Chat / Projects / Tasks / Stuck / Logs) |
Enter |
Send message |
Shift+Enter |
Newline |
i |
Focus input |
Esc |
Exit input focus |
Ctrl+C |
Quit |
The status bar shows: provider · model · message count · cumulative cost.
openswarm run "Fix the login bug" -p ~/dev/my-project
This runs a Worker agent on the given task. Add --pipeline for the full Worker → Reviewer pipeline.
openswarm run "Add user auth" -p ~/dev/my-project --pipeline --model claude-sonnet-4-20250514
openswarm chat
openswarm chat my-session # Resume a named sessionIf you want autonomous operation (Linear + Discord integration):
openswarm init # Generates config.yaml scaffold openswarm validate # Validates config.yaml
See Configuration for full config reference.
| Component | Required For | How to Get |
|---|---|---|
| Node.js >= 22 | Everything | nodejs.org |
| Claude Code CLI | Claude adapter (default) |
npm i -g @anthropic-ai/claude-code + claude auth
|
| OpenAI Codex CLI | Codex adapter | npm i -g @openai/codex |
| OpenAI API key | GPT adapter | openswarm auth login --provider gpt |
| Ollama / LMStudio | Local adapter | ollama.ai / lmstudio.ai |
| Discord Bot token | Discord control | Discord Developer Portal |
| Linear API key | Issue tracking | Linear Settings → API |
GitHub CLI (gh) |
CI monitoring | brew install gh |
- CLI Reference — Full command reference
-
Configuration — Set up
config.yamlfor autonomous mode - Adapters — Configure different AI providers
Getting Started
Reference
Deep Dive
Help