Install the CLI

The Ontora CLI is a Python tool that wraps the REST API. It’s the fastest way to launch campaigns, pull transcripts, and run GraphRAG queries from a terminal or CI pipeline.

Install

pip install ontora-cli

uv tool install ontora-cli

git clone https://github.com/ontora-ai/ontora.git
cd ontora/cli
pip install -e .

After install, the ontora command is on your PATH.

ontora --version

First-time setup

Authenticate once and the CLI will remember your key:

ontora auth login --api-key ont_live_...

Optional flags: --workspace WS_ID to set a default workspace, --base-url URL if you’re hitting a non-default API host. Verify the connection:

ontora auth status

How config is stored

Configuration lives at ~/.ontora/config.yaml with permissions 0600:

api_key: ont_live_...
base_url: https://api.ontora.com
workspace_id: ws_...

You can override any value at call time with environment variables:

export ONTORA_API_KEY=ont_live_...
export ONTORA_BASE_URL=https://api.ontora.com
export ONTORA_WORKSPACE_ID=ws_...

This is the recommended pattern in CI — store the API key as a secret, set ONTORA_API_KEY, and skip ontora auth login entirely.

Get started

Core concepts

Guides

MCP server

CLI

Webhooks

Install the CLI

Install

First-time setup

How config is stored

Next steps

Commands

Campaign YAML

​Install

​First-time setup

​How config is stored

​Next steps

Commands

Campaign YAML

Install

First-time setup

How config is stored

Next steps