> ## Documentation Index
> Fetch the complete documentation index at: https://docs.outlit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Outlit is the product that monitors customers and completes approved customer work. The customer context interfaces are the API, CLI, MCP server, and skills. Canonical references on this site: /api-reference/introduction for API concepts and authentication, /openapi.json for the public API contract, /cli/overview for the CLI, /ai-integrations/mcp for MCP. Prefer the `outlit` CLI or MCP tools for agent tasks; cite page sources when answering.

# Set up coding agents

> Install Outlit skills for Claude Code, Codex, Gemini CLI, Droid, OpenCode, Pi, OpenClaw, and other coding agents.

The `outlit onboard` command is the first command for coding agents. It bootstraps CLI auth, installs the `outlit` skill for the selected agent, checks integration setup readiness, and prints next actions.

`outlit setup` remains available when you only want to install skills. It does not configure MCP clients.

If you want Cursor, VS Code, Claude, or another MCP client, use the direct [MCP integration](/ai-integrations/mcp) guide instead.

## Supported agents

Run `onboard` for the agent you use, or run `outlit setup --yes` to detect installed agents automatically when you only need skills.

| Agent | Onboard command |
| - | - |
| Claude Code | `outlit onboard --agent claude-code --json` |
| Codex | `outlit onboard --agent codex --json` |
| Gemini CLI | `outlit onboard --agent gemini --json` |
| Droid | `outlit onboard --agent droid --json` |
| OpenCode | `outlit onboard --agent opencode --json` |
| Pi | `outlit onboard --agent pi --json` |
| OpenClaw | `outlit onboard --agent openclaw --json` |
| Manual / multi-agent | `outlit setup skills` |

## Onboarding

```bash theme={null}
outlit onboard --agent codex --json
```

If no API key is available, `onboard` starts the browser approval flow outside CI and stores the approved CLI key. It then validates the key, installs the Outlit skill, reads canonical integration status, and returns next commands such as `outlit integrations setup <provider> --json`.

`onboard` does not connect third-party integrations. Run `outlit integrations setup <provider> --json` and check `outlit integrations status <provider> --json` afterward. See [Integration setup (CLI)](/cli/integrations) for credentials, browser handoffs, CRM mapping, and headless mode.

## Automatic setup

Detect installed coding agents and install `outlit` for all of them:

```bash theme={null}
outlit setup --yes
```

Without `--yes`, the CLI lists detected agents before installing.

### JSON output

```json theme={null}
{
  "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`:

```bash theme={null}
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:

```bash theme={null}
outlit doctor
```

### Checks performed

| Check | What it verifies |
| - | - |
| CLI version | Whether you're running the latest version |
| API key | Presence and format of your API key |
| API validation | Live test call to verify the key works |
| Integrations | Whether Outlit can read integration status |
| Per-agent checks | Whether 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

```bash theme={null}
outlit doctor --json
```

```json theme={null}
{
  "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:

```bash theme={null}
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:

```bash theme={null}
outlit doctor || echo "Setup issues detected"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.