> ## Documentation Index
> Fetch the complete documentation index at: https://outlit-codex-platform-actions-create-update-cli.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# AI Agent Setup

> 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, checks integration capabilities/status, and returns next commands such as `outlit integrations setup <provider> --json`.

`onboard` does not connect third-party integrations by itself. Use `outlit integrations capabilities --json`, then `outlit integrations setup <provider> --json` for auth or credentials, and follow-up commands like `outlit integrations setup hubspot mappings --json` or `outlit integrations setup pylon webhooks --json` when capabilities list required post-connect steps.

## Auto-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"
```