Overview
The Setup page provides quick access to install the CLI, connect your IDE, and browse the full command reference.
Navigate to Setup from the sidebar.
IDE extension
The top section offers one-click IDE setup. Click Connect IDE to open the connection modal, which auto-configures your API key, project, and MCP server for VS Code, Cursor, Windsurf, or Antigravity.
The extension captures:
- Git commits (SHA, message, files changed, diff)
- File save events
- Session lifecycle (auto-creates and closes sessions)
See Integrations for detailed setup steps per editor.
CLI installation
Install the CLI globally:
bash
npm install -g contox-cli
Command reference
Auth
| Command | Description |
|---|---|
contox login -k <key> | Store your Contox API key |
contox whoami | Verify API key and show connection info |
Setup
| Command | Description |
|---|---|
contox init -t <team> -n "Name" | Initialize project and create .contox.json |
contox init -t <team> | List available projects for a team |
Memory
| Command | Description |
|---|---|
contox memory | Load full project memory (use at session start) |
contox memory --json | Output project memory as structured JSON |
contox save "summary..." | Save session work into project memory |
contox save --json | Save structured session data from stdin |
Context
| Command | Description |
|---|---|
contox scan | Scan project and create hierarchical sub-contexts |
contox scan --dry-run | Preview sub-contexts without pushing |
contox scan --flat -o ctx.md | Generate single flat context file |
Sync
| Command | Description |
|---|---|
contox push <files...> | Push individual files as contexts |
contox pull | Pull contexts to local files |
Management
| Command | Description |
|---|---|
contox status | Show context status table |
API keys
Click API Keys in the top-right corner to navigate to the API Keys page where you can generate keys for CLI and MCP authentication.
Next steps
- Integrations — Connect AI editors and platform services
- API Keys — Generate authentication keys
- Memory — View and manage project memory in the dashboard