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

# Octolens CLI

> The terminal interface to Octolens — read, triage and act on your mentions from a shell, by hand or from a script.

The `octolens` CLI brings your Octolens workspace to the terminal: the
mentions Octolens collects for you across Reddit, X, LinkedIn, Hacker News and
the rest, plus the keywords, feeds, filters, notifications and analytics
around them.

It is built for two kinds of user at once:

* **People at a terminal** — skim new mentions over coffee, open one in the
  browser, mark the false positives, watch a launch unfold live.
* **Agents and scripts** — every command takes `--json` and emits exactly one
  JSON document on stdout, errors are a single machine-readable envelope on
  stderr, and exit codes are stable. If you are wiring the CLI into CI or an
  agent, read [The --json contract](/docs/cli/contract/json-output) and
  [Exit codes](/docs/cli/contract/exit-codes) first.

## What it feels like

Search on demand — one-time, AI-scored, no setup first (new workspaces can be
created from the terminal too — [Signup & the Agents plan](/docs/cli/agents)):

```bash theme={null}
octolens search "your brand" --days 7
```

Triage a mention — inspect it, then correct the AI's relevance call:

```bash theme={null}
octolens mentions get reddit_t3_1abc234
octolens mentions update reddit_t3_1abc234 --relevance not_relevant
```

Watch your mentions live during a launch, narrowed to one source:

```bash theme={null}
octolens feeds watch --source reddit
```

Export a filtered slice to CSV for a spreadsheet or a report:

```bash theme={null}
octolens mentions export --source reddit -o mentions.csv
```

## Where to start

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/docs/cli/quickstart">
    Your first ten minutes: log in, initialize the workspace, read and triage
    your first mentions.
  </Card>

  <Card title="Install & login" icon="download" href="/docs/cli/install">
    npm install, the browser login, API keys for CI, and what each scope
    allows.
  </Card>

  <Card title="Initialize a workspace" icon="rocket" href="/docs/cli/init">
    The guided onboarding: company profile, keywords, filters and your first
    feed — all from the terminal.
  </Card>

  <Card title="Command reference" icon="terminal" href="/docs/cli/commands/mentions">
    The full command set, group by group, exactly as the binary states it.
  </Card>
</CardGroup>

Scripting against the CLI? The contract pages — the
[--json contract](/docs/cli/contract/json-output),
[exit codes](/docs/cli/contract/exit-codes),
[the error envelope](/docs/cli/contract/error-envelope) and
[global flags](/docs/cli/contract/global-flags) — hold for every command on this
site.