Overview

octri is the command line for your Octri project. It does what the dashboard does: push a spec, build SDKs, publish docs, run your MCP server, and work through the errors your SDKs report from production. Every command has its own page here, with its flags and an example of what it prints.

Install

npm install -g @octri/cli
octri --help

It needs Node 20 or newer.

octri auth login
octri projects use

auth login asks for your email and password, and stores the session in ~/.octri/config.json. projects use shows your projects to pick from. Every later command acts on that project, unless you pass --project <id>.

For CI, use an API key in OCTRI_API_KEY instead of signing in.

A first run

octri specs push ./openapi.yaml
octri sdk build --lang go,typescript --download
octri docs versions publish <specId>

specs push waits for the whole pipeline, not only the upload, so the next command sees the new version. sdk build draws a live lane per language and saves the SDKs when they're done. docs versions publish puts that spec version on your docs site.

How each page reads

Every command page has the same parts:

Part	What it tells you
Usage	The command with its arguments. Square brackets mean optional
Arguments	What goes after the command, and which are required
Flags	Each option, its type and its default
Subcommands	For a command with actions, such as `docs nav set`, each action with its own arguments and flags
Examples	Real runs, with what the CLI printed

Flags every command takes, such as --json and --project, are on global flags and output rather than repeated on each page. octri <group> --help lists one group's commands in the terminal.

Example output

The examples were run against a test project, so names, IDs and times are sample values. Commands that need a finished SDK build, or that publish something, show the command without its output.

Every command

Command	What it does
`octri auth login`	Sign in to Octri and store the session in your profile.
`octri auth whoami`	Print the signed-in user, organisation, plan, role and selected project.
`octri auth token`	Print the session's bearer token, for calling the API yourself.
`octri auth profiles`	List the profiles on this machine and which one is in use.
`octri auth logout`	End the session on the server and clear it from this machine.
`octri config`	Show, change and switch profiles: API address, default project and languages.

Projects

Command	What it does
`octri projects list`	List the projects in your organisation, marking the selected one.
`octri projects use`	Select the project later commands act on.
`octri projects current`	Print the selected project's ID and the profile it's stored in.
`octri projects show`	Print one project's ID, slug, description and docs address.
`octri projects create`	Create a project and select it.

Specs

Command	What it does
`octri specs push`	Upload an OpenAPI spec and follow it through parsing, pages and search.
`octri specs import`	Import a spec from a public URL and follow ingestion.
`octri specs list`	List the project's spec versions, marking the current one.
`octri specs status`	Show one spec's parse status and every job in the pipeline behind it.
`octri specs delete`	Permanently delete a spec version.
`octri specs convert`	See whether the current spec came from a conversion, and import or save its report.
`octri jobs`	The generation queue: what's waiting, running and failed.

SDKs

Command	What it does
`octri sdk languages`	List the languages the generator supports, with the settings each one reads.
`octri sdk operations`	List the operations the generator parsed from the current spec.
`octri sdk settings`	Read and change SDK Studio settings, such as retries, naming and auth.
`octri sdk validate`	Check the current spec against the generator before you spend a build.
`octri sdk audit`	Score the spec for SDK quality, then apply or ignore each finding.
`octri sdk quickstart`	Choose the endpoint every SDK's README leads with.
`octri sdk preview`	Generate one language without spending a build, and read the files.
`octri sdk build`	Build SDKs for the languages you choose and follow each one live.
`octri sdk builds`	List builds, newest first, with each one's status and languages.
`octri sdk watch`	Follow a running build's lanes until every language settles.
`octri sdk artifacts`	List each language's package from a build, with share links.
`octri sdk download`	Download a build's packages and unpack them to read the source.
`octri sdk retry`	Run a build's failed languages again.
`octri sdk publish`	Publish a build's packages to npm, PyPI and the other registries.
`octri sdk repos`	See and set up each language's GitHub repository.
`octri sdk stats`	Build health: durations, and which languages and stages fail most.

Generator lab

Command	What it does
`octri lab run`	Validate, build, download and unpack in one command, with a verdict per language.
`octri lab runs`	List the runs kept on this machine for the project.
`octri lab pull`	Download and keep a build that already ran, so the lab commands can read it.
`octri lab files`	Show the file tree one language generated in a kept run.
`octri lab cat`	Print one generated file from a kept run.
`octri lab diff`	Compare two kept runs file by file, per language.

Docs

Command	What it does
`octri docs pages`	List, regenerate, retitle and publish the endpoint pages generated from your spec.
`octri docs show`	Print one endpoint page.
`octri docs guides`	List, read and publish the guides you've written.
`octri docs nav`	Print, replace and publish the site's navigation, home page and redirects.
`octri docs home`	Choose the guide served at the root of your docs site.
`octri docs redirects`	List, add and remove redirect rules from old addresses.
`octri docs versions`	Publish spec versions to your docs site, label them and pick the default.
`octri docs domain`	Serve your docs on your own hostname: set it, see the DNS records, verify, remove.
`octri docs theme`	Read and change appearance: colours, logo, fonts, layout and code themes.
`octri docs buttons`	Add and remove the buttons at the right of the top bar.
`octri docs socials`	Set the social links shown at the bottom of each page.
`octri docs seo`	Read and change your site's search and social metadata.
`octri docs feedback`	Turn the page feedback widget on or off.
`octri docs playground`	Configure the request playground: on or off, base URL, default auth.
`octri docs custom-code`	Load your own CSS and HTML on every docs page.
`octri docs components`	Push, show and remove the custom components your pages use.
`octri docs endpoints`	Draft endpoints to add or remove, then publish them into the spec.
`octri docs changelog`	List the API changelog entries generated between spec versions.
`octri docs releases`	The API Studio's release history, with what each publish changed.

GitHub

Command	What it does
`octri github status`	Show the connected repository, branch, spec path and when it last synced.
`octri github connect`	Point the project at a spec file in a GitHub repository.
`octri github sync`	Pull the spec from the connected repository now.
`octri github auto-sync`	Ingest the spec automatically on every push that changes it.
`octri github disconnect`	Disconnect the repository and remove Octri's webhook from it.
`octri github docs`	Pull your repository's Markdown files, or keep page drafts in sync with them.
`octri github app`	Check whether the project is linked to the Octri GitHub App.

Webhooks

Command	What it does
`octri webhooks list`	List the project's webhooks, with type, address and state.
`octri webhooks events`	List the events a webhook can carry.
`octri webhooks create`	Add a webhook for the events you choose, and get its signing secret.
`octri webhooks update`	Change a webhook's address, events or label, or switch it on or off.
`octri webhooks test`	Send a test.ping delivery to a webhook.
`octri webhooks deliveries`	A webhook's delivery history: event, status, HTTP code and error.
`octri webhooks delete`	Delete a webhook and its delivery history.

MCP server

Command	What it does
`octri mcp tools`	List the tools your published MCP server gives agents.
`octri mcp usage`	Count agent calls per tool, split by outcome.
`octri mcp calls`	List the latest tool calls: which tool, when, and how it went.
`octri mcp changes`	The tool changes agents were told about, release by release.
`octri mcp outages`	Which tools sit behind an endpoint your uptime checks see failing.
`octri mcp permissions`	See and set what an agent may do with each tool: auto, confirm or off.
`octri mcp score`	Score the tools agents are served out of 10, and fail CI below a floor.
`octri mcp test`	Have real models work through sample tasks with your tools, as a dry run.
`octri mcp workflows`	Check the workflow tools made from your guides still match them.
`octri mcp domain`	Put the hosted MCP server on your own hostname.
`octri mcp installations`	Server addresses backed by a stored credential, for a team or a script.
`octri mcp connections`	List and sign out the people signed in to the hosted server.
`octri mcp audit`	Every write an agent attempted, approved or not, filtered and exportable.
`octri mcp package`	Your MCP server's npm and PyPI packages, plus bundle, Docker and Worker downloads.
`octri mcp plugin`	Your project's Claude Code plugin: install lines, commands, and a download.
`octri mcp serve`	Run the CLI itself as an MCP server, so an assistant can manage your Octri account.

Monitoring

Command	What it does
`octri monitoring status`	Show whether monitoring is on, its environment and ingest address.
`octri monitoring enable`	Turn monitoring on for the project.
`octri monitoring disable`	Turn monitoring off. Events are refused from then on.
`octri monitoring config`	Print the three values a CI job needs to upload symbols.
`octri monitoring test-event`	Send one test error through the real ingest path.
`octri monitoring summary`	The window's totals: events, errors, error rate and distinct issues.
`octri monitoring releases`	Error rate, new issues and regressions per release.
`octri monitoring issues`	List errors grouped into issues, filtered by status, level or text.
`octri monitoring issue`	One issue with its status, release, culprit and stack trace.
`octri monitoring resolve`	Mark an issue resolved. If it happens again, it's a regression.
`octri monitoring ignore`	Mark an issue ignored, so it stays out of your list.
`octri monitoring reopen`	Put a resolved or ignored issue back to unresolved.
`octri monitoring comment`	Add a comment to an issue, under your name.
`octri monitoring logs`	Query individual events, newest first, when you need every occurrence.
`octri monitoring traces`	Recent traces, or one trace's spans.
`octri monitoring performance`	The slowest transactions with p50 and p95, then suspected N+1 queries.
`octri monitoring slos`	Set latency and error targets per transaction, and fail CI on a breach.
`octri monitoring alerts`	Alert rules: create, test against live data, delete.
`octri monitoring checks`	Uptime checks: generate them from your spec and run one now.
`octri monitoring incidents`	Post incidents and their updates to your public status page.
`octri monitoring announcements`	Banners on your status page, such as planned maintenance.
`octri monitoring sourcemaps`	Upload JavaScript and Dart source maps so stack traces are readable.
`octri monitoring sources`	Upload Go, Rust, JVM and Swift source so stack frames show code.

Organisation and keys

Command	What it does
`octri orgs list`	List the organisations you belong to, marking the one you're acting as.
`octri orgs switch`	Act as another organisation you belong to.
`octri orgs show`	The organisation's plan, limits and SDK languages.
`octri orgs usage`	What the organisation has used this billing period, against its limits.
`octri orgs billing`	Plan status and invoices.
`octri orgs members`	The organisation's members: change a role, or remove someone.
`octri orgs invites`	Invite people, and resend or revoke pending invites.
`octri keys`	API keys for CI and scripts: create, list and revoke.

Not the CLI inside your SDK

This is Octri's own CLI. It's unrelated to the CLI generated inside your SDK, which is a command-line client for your API that your customers run.