Skip to main content
The outlit setup command installs the outlit skill for coding agents. It does not configure MCP clients. If you want Cursor, VS Code, Claude, or another MCP client, use the direct MCP Integration guide instead.

​
Supported Agents

Run the command for the agent you use, or run outlit setup --yes to detect installed agents automatically.
AgentSetup command
Claude Codeoutlit setup claude-code
Codexoutlit setup codex
Gemini CLIoutlit setup gemini
Droidoutlit setup droid
OpenCodeoutlit setup opencode
Pioutlit setup pi
OpenClawoutlit setup openclaw
Manual / multi-agentoutlit setup skills

​
Auto-Setup

Detect installed coding agents and install outlit for all of them: 
outlit setup --yes
Without --yes, the CLI lists detected agents before installing.

​
JSON Output

{
  "detected": ["claude-code", "opencode"],
  "configured": ["claude-code", "opencode"],
  "failed": [],
  "runner": "npx"
}

​
Interactive Skills Installer

Use this when you want to pick agents manually or optionally add outlit-sdk: 
outlit setup skills
This opens the interactive skills add flow scoped to github.com/OutlitAI/outlit-agent-skills.

​
Diagnostics

The doctor command checks your CLI auth plus coding-agent skill installs: 
outlit doctor

​
Checks Performed

CheckWhat it verifies
CLI versionWhether you’re running the latest version
API keyPresence and format of your API key
API validationLive test call to verify the key works
IntegrationsWhether Outlit can read integration status
Per-agent checksWhether detected coding agents already have the outlit skill

​
Example Output

  Outlit Doctor

  ✓ CLI version: v1.4.1 (latest)
  ✓ API key: Found (ok_ab...1234) via config
  ✓ API validation: Key is valid
  ! Claude Code: Installed, but Outlit skill not found
  ✓ Codex: Outlit skill installed

  Everything works, 1 suggestion(s).

​
JSON Output

outlit doctor --json

{
  "ok": true,
  "checks": [
    { "name": "CLI version", "status": "pass", "message": "v1.4.1 (latest)" },
    { "name": "API key", "status": "pass", "message": "Found (ok_ab...1234) via config" },
    { "name": "API validation", "status": "pass", "message": "Key is valid" },
    { "name": "Claude Code", "status": "warn", "message": "Installed, but Outlit skill not found" }
  ]
}
Filter for failures: 
outlit doctor --json | jq '.checks[] | select(.status == "fail")'

​
Exit Code

doctor exits with code 1 if any check fails, which makes it useful in CI: 
outlit doctor || echo "Setup issues detected"