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

# Reference

> Complete command reference for the Outcrawl CLI.

export const OutcrawlStyles = () => {
  if (typeof document !== 'undefined' && !document.getElementById('outcrawl-overrides')) {
    const s = document.createElement('style');
    s.id = 'outcrawl-overrides';
    s.textContent = `
      /* Match the product's radius grid (4 / 6 / 8 / 9999), not Mintlify's default. */
      .rounded-sm { border-radius: 0.375rem !important; } /* 6px, --r-ctl */
      .rounded-md { border-radius: 0.375rem !important; } /* 6px, --r-ctl */
      .rounded-lg { border-radius: 0.5rem !important; }   /* 8px, --r-panel */
      .rounded-l-sm { border-top-left-radius: 0.375rem !important; border-bottom-left-radius: 0.375rem !important; }
      .rounded-r-sm { border-top-right-radius: 0.375rem !important; border-bottom-right-radius: 0.375rem !important; }
      .rounded-l-md { border-top-left-radius: 0.375rem !important; border-bottom-left-radius: 0.375rem !important; }
      .rounded-r-md { border-top-right-radius: 0.375rem !important; border-bottom-right-radius: 0.375rem !important; }
      .rounded-l-lg { border-top-left-radius: 0.5rem !important; border-bottom-left-radius: 0.5rem !important; }
      .rounded-r-lg { border-top-right-radius: 0.5rem !important; border-bottom-right-radius: 0.5rem !important; }

      /* Cards: never pure white in light mode, matching the one-big-card surface tone. */
      .card { background-color: #fcfcfc !important; border-radius: 0.5rem !important; }
      html.dark .card { background-color: #141311 !important; }

      /* Docs hero box */
      .oc-hero { background-color: #fcfcfc; border: 1px solid #e5e2dc; }
      html.dark .oc-hero { background-color: #141311; border-color: #26241f; }
      html.dark .oc-hero h1 { color: #edeae4; }

      /* Thin, transparent-track, hide-until-hover scrollbar. */
      ::-webkit-scrollbar { width: 6px; height: 6px; background-color: transparent; }
      ::-webkit-scrollbar-track { background-color: transparent; }
      ::-webkit-scrollbar-thumb { background-color: rgba(155, 155, 155, 0.5); border-radius: 10px; transition: opacity 0.3s ease; opacity: 0; }
      ::-webkit-scrollbar-thumb:hover { background-color: rgba(155, 155, 155, 0.7); }
      *:hover::-webkit-scrollbar-thumb,
      *:focus::-webkit-scrollbar-thumb,
      *:active::-webkit-scrollbar-thumb { opacity: 1; }
      * { scrollbar-width: thin; scrollbar-color: rgba(155, 155, 155, 0.5) transparent; }
    `;
    document.head.appendChild(s);
  }
  return null;
};

<OutcrawlStyles />

Every command below comes from the registry's own `cliCommand` column, 44 of 46 rows. Nothing here is hand-maintained separately from the API it calls.

| Command | Description |
| - | - |
| **Sign-in** | |
| `outcrawl login` | Sign in with a browser, device grant, no key needed |
| `outcrawl logout` | End the stored session |
| **Scrape, crawl, search** | |
| `outcrawl scrape <url>` | Fetch one URL, return clean content |
| `outcrawl crawl <url>` | Walk a site from a seed, stream every page |
| `outcrawl crawl status <id>` | Where a crawl has got to |
| `outcrawl crawl results <id>` | Pages delivered so far |
| `outcrawl crawl cancel <id>` | Stop a crawl |
| `outcrawl search <query>` | Web search, optionally rendered |
| **Agent** | |
| `outcrawl agent "<task>"` | Submit a task, get an id back |
| `outcrawl agent list` | Your runs, newest first |
| `outcrawl agent status <id>` | Status, plan, spend |
| `outcrawl agent events <id>` | The step-by-step log, streamed |
| `outcrawl agent results <id>` | What it has produced |
| `outcrawl agent cancel <id>` | Stop it |
| `outcrawl agent control <id> [--release]` | Take the wheel, or hand it back with `--release` |
| `outcrawl agent answer <id> --answer "<answer>"` | Answer the question a paused run asked |
| `outcrawl agent files add <id> <path>` | Attach a file to a run |
| **Monitors** | |
| `outcrawl monitors create` | Watch a URL on a schedule |
| `outcrawl monitors ls` | List monitors with their last check |
| `outcrawl monitors rm <id>` | Delete a monitor |
| **Profiles** | |
| `outcrawl profiles create` | Create a profile that keeps logins |
| `outcrawl profiles ls` | List profiles |
| `outcrawl profiles get <id>` | Fetch one profile |
| `outcrawl profiles rm <id>` | Delete a profile |
| **Secrets** | |
| `outcrawl secrets create` | Store a credential under a handle |
| `outcrawl secrets ls` | List handles, never values |
| `outcrawl secrets rm <id>` | Delete a credential |
| **Rules** | |
| `outcrawl rules get` | The workspace rules, enforced or guidance |
| `outcrawl rules set` | Replace the rules, get the classification back |
| **Integrations** | |
| `outcrawl integrations connect <name>` | Connect an MCP server for an agent to call |
| `outcrawl integrations test` | Check an MCP server works, storing nothing |
| `outcrawl integrations ls` | Everything an agent can reach outside the browser |
| `outcrawl integrations update <id>` | Change a connector's tools or secret in place |
| `outcrawl integrations rm <id>` | Disconnect a server |
| **Sessions** | |
| `outcrawl sessions list` | Past sessions, newest first |
| `outcrawl sessions get <id>` | One session: replay, share, tabs, cost |
| `outcrawl sessions events <id>` | Stream a session's recorded events |
| `outcrawl sessions network <id>` | Stream every request a session made |
| `outcrawl sessions digest <id>` | What went wrong in a session, briefly |
| `outcrawl sessions request <id> <rid>` | One request in full, with its body |
| `outcrawl sessions console <id>` | A session's console lines |
| `outcrawl sessions har <id>` | Save a session's network as a HAR file |
| `outcrawl sessions videos <id>` | Links to a session's video |
| `outcrawl sessions share <id>` | Choose who may watch a session |
| **Usage and credits** | |
| `outcrawl usage` | Aggregate usage |
| `outcrawl credits` | Granted, spent, remaining |
| **Other** | |
| `outcrawl upgrade [--check\|--force]` | Verify and install the published release |

<Note>
  Two rows carry no CLI command: `sessions.export` and `secrets.intent`. Export a recording from the SDK or the API; a secret intent is minted by your own app server for a page a person types into.
</Note>

## `usage` date ranges

```bash theme={"theme":{"light":"github-light","dark":"catppuccin-mocha"}}
outcrawl usage                                    # this calendar month, the default
outcrawl usage --period 7d                        # 24h | 7d | 30d | this-month | last-month
outcrawl usage --from 2026-09-01 --to 2026-09-30  # --from and --to, always together
```

`--period` and `--from`/`--to` are alternatives: combining them is refused, and `--from` without `--to` (or the reverse) is refused the same way it always has been. Give neither and the range defaults to the current calendar month, in UTC.

## `secrets create` values

```bash theme={"theme":{"light":"github-light","dark":"catppuccin-mocha"}}
outcrawl secrets create card_amex_personal --kind card
```

Prompts for the value, hidden, when run at a terminal, and reads it from stdin instead when the command is piped.

<Warning>
  `--value` still works, for a script that already passes it, but the value never reaches output. Using it prints a warning to stderr, once, every time (D19): a credential does not belong on a command line a shell history file can read.
</Warning>

## Tips

| Exit code | Meaning |
| - | - |
| `0` | Worked |
| `1` | The call was made and did not work |
| `2` | The invocation was wrong, nothing was sent |
| `3` | The API refused: auth, plan, or tenant scope |

Set `OUTCRAWL_TIMING=1` for a per-phase timing breakdown on stderr (startup, parse, config, DNS, connect, TLS, request, server, body, render). Set `OUTCRAWL_NO_VERSION_CHECK=1` to disable the background update check entirely. Run `outcrawl <command> --help` for detailed usage on any command.


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