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

# Octen CLI

> Configure a client and run the Octen API from your terminal.

<p style={{ fontSize: "0.8rem", opacity: 0.6 }}>For AI agents: <a href="https://docs.octen.ai/integrations/octen-cli.md">docs.octen.ai/integrations/octen-cli.md</a></p>

`@octen.ai/cli` is the official command-line tool for Octen.
One command wires Octen's MCP server and Agent Skills into your AI client. It also brings the full Octen API straight to your terminal.

<CardGroup cols={3}>
  <Card title="Get API Key" icon="key" href="https://octen.ai/platform/api-keys">
    Create a key from the API Platform.
  </Card>

  <Card title="GitHub" icon="github" href="https://github.com/Octen-Team/octen-cli">
    View the source and releases.
  </Card>

  <Card title="npm" icon="npm" href="https://www.npmjs.com/package/@octen.ai/cli">
    The `@octen.ai/cli` package.
  </Card>
</CardGroup>

## Install

<Tabs>
  <Tab title="npm">
    Requires Node.js 18+.

    ```bash theme={null}
    npm i -g @octen.ai/cli
    ```

    Or run without installing: `npx @octen.ai/cli <command>`.
  </Tab>

  <Tab title="Homebrew">
    ```bash theme={null}
    brew install Octen-Team/tap/octen
    ```
  </Tab>
</Tabs>

## Authenticate

<Note>
  You'll need an Octen API key first. Create one from the [API Platform](https://octen.ai/platform/api-keys).
</Note>

Set your key as an environment variable — every command picks it up automatically:

```bash theme={null}
export OCTEN_API_KEY="your-key"          # add to ~/.zshrc or ~/.bashrc to persist
```

You can also pass `--api-key <key>` on any single command. To point at a staging or self-hosted endpoint, set `OCTEN_API_URL` or pass `--base-url <url>`.

## Set Up Your AI Agent

One command merges the Octen MCP server or Agent Skills into your client.

<Tabs>
  <Tab title="Agent Skills">
    Install the Octen Skills into your AI agent:

    ```bash theme={null}
    octen configure-skills --claude-code --set-key
    ```

    Supported: Claude Code, Cursor, Codex, OpenClaw, Hermes. For Claude Desktop, use --claude-code.
  </Tab>

  <Tab title="MCP server">
    Add the Octen MCP server:

    ```bash theme={null}
    octen configure-mcp --claude-code
    ```

    Supported: Claude Code, Claude Desktop, Cursor, Windsurf, VS Code, Codex.
  </Tab>
</Tabs>

<Note>
  `--all` configures every client found on your machine at once.
</Note>

## Use Octen from the Terminal

| Command | What it does |
| - | - |
| `octen broad-search <query>` | Broad, multi-angle web search across auto-generated sub-queries. |
| `octen search <query>` | Live web search with model-ready highlights and optional full content. |
| `octen news <query>` | News search for current events and headlines. |
| `octen image-search <query>` | Image search by text or a reference image. |
| `octen video-search <query>` | Video search by text query. Beta — contact us for access. |
| `octen extract <urls...>` | Content extraction from 1–20 URLs into clean, LLM-ready markdown or text. |
| `octen chat [prompt]` | Chat completions from leading models, with optional live web search. |
| `octen embed [text...]` | Text embeddings for semantic search, RAG, and recommendations. |
| `octen vl-embed <content...>` | Multimodal embeddings from text, images, and video for cross-modal search. |

***

<p style={{ fontSize: "0.8rem", opacity: 0.6 }}>Last modified on October 13, 2026</p>


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