OCTRI_API_KEY — Octri API key. Not needed if you have signed in with `octri auth login`.
OCTRI_PROJECT_ID — Project to use when a tool call names none. Defaults to the CLI's selected project.
OCTRI_PROFILE — Stored CLI profile to use instead of the current one.
HTTPS_PROXY — Proxy for requests to Octri, e.g. http://proxy.internal:3128. Needed behind a corporate proxy, since MCP clients rarely pass your shell's environment through.
NO_PROXY — Comma-separated hosts that skip HTTPS_PROXY.
Claude Code hat keinen Installationslink für einen lokalen Befehl. Kopieren Sie den Befehl unten und führen Sie ihn in einem Terminal aus.
octri is the command line for your Octri project. It does what the dashboard
does: push a spec, build SDKs, publish docs, and work through the errors those
SDKs report from production.
Octri takes an OpenAPI spec and gives you a documentation site, client libraries
in ten languages, an MCP server, and monitoring for the API behind all of it.
See octri.dev.
Push OpenAPI specs, build SDKs in ten languages, publish API docs, and triage production SDK errors.
octri auth login
octri projects use
octri specs push ./openapi.yaml
auth login prompts for your email and password, and for your authenticator
code if you have two-factor on. projects use with no argument opens a picker.
specs push waits for the pipeline, not the upload. Your spec parses in about a
second, then the doc pages, search index and changelog get written behind it.
The spinner names the stage it is on.
Build an SDK
octri sdk audit # what is costing you, scored
octri sdk build --lang go,typescript --download
In a terminal, sdk build draws a lane per language and repaints it through
generating, verifying, packaging, installing, ready. Piped or under
CI it prints append-only lines instead, and exits non-zero if any language
fails, so it works as a build step with no extra flags.
sdk audit scores the spec and marks which findings the generator can fix on
its own. octri sdk audit apply <key> writes one in.
For a look at real generator output without spending a build:
octri sdk preview --lang go
octri sdk preview --lang go --show client.go
monitoring issue prints the stack and marks which frames resolved against
uploaded source maps. When none of them did, the release those errors came from
has no symbols, and the CLI says so.
The two upload commands work differently. They talk to the monitoring service
directly with an ingest token, because a CI job has one secret and no way to log
in:
# CI
octri monitoring sourcemaps upload ./dist \
--url "$MONITORING_URL" --token "$MONITORING_TOKEN" \
--environment "$MONITORING_ENVIRONMENT" --release "$GIT_SHA"
# your own machine, already signed in
octri monitoring sourcemaps upload ./dist
Run octri monitoring config for the three values to store as CI secrets. The
release you upload under has to equal the release your SDK reports at runtime,
or the service has nothing to pair a trace with.
Commands
Group
What
auth
login · logout · whoami · token · profiles
config
list · set <k> <v> · use <profile> · path
projects
list · show · create · use · current
specs
list · push <file|-> · import <url> · status · delete
State lives in ~/.octri/config.json, mode 0600, since it holds session
tokens. OCTRI_CONFIG_DIR moves it.
Profiles keep environments side by side:
octri config use prod --api-url api.octri.dev
octri config set defaultLanguages go,rust,swift
Every value resolves flag first, then environment, then the stored profile.
Variable
Effect
OCTRI_PROFILE
Profile to use
OCTRI_API_URL
API root (local is shorthand for :3001)
OCTRI_TOKEN
Bearer token, bypassing the stored session
OCTRI_API_KEY
API key for the public routes
OCTRI_PROJECT_ID
Default project
OCTRI_CONFIG_DIR
Where config and the artifact cache live
OCTRI_DEBUG
Print stack traces on failure
Behind a proxy
The CLI and octri mcp serve read the standard proxy variables, in upper or
lower case, with no extra Node flag. https:// requests use HTTPS_PROXY, or
HTTP_PROXY when that is the only one set. Hosts listed in NO_PROXY, and
their subdomains, connect directly; * turns the proxy off.
If the proxy inspects TLS with its own certificate authority, point Node at
that CA with NODE_EXTRA_CA_CERTS=/path/to/ca.pem.
MCP clients usually start servers with a minimal environment, so set these in
the server's env block rather than relying on your shell.
MCP server
octri mcp serve
This speaks MCP over stdio and offers the same commands as typed tools. An
assistant can push a spec, wait for the build, read the generated Go, and then
read the production error that build caused.
To add it to Cursor or VS Code in one click, through npx so no global install
is needed:
The server uses the profile from octri auth login, so sign in first, or set
OCTRI_API_KEY in its environment. Listed in the official MCP Registry as
dev.octri/cli.
Credentials come from your stored profile and the assistant never sees them.
Reads are open. The two operations you cannot take back are refused unless you
start the server with the flag for them:
Tool failures come back as tool results rather than protocol errors, so an
assistant can read the message and correct itself.
Notes
Build progress is polled, not streamed. The /ws/sdk socket authenticates
from a header or cookie, which Node's built-in WebSocket cannot set, and a
WebSocket dependency would buy about a second of latency on a build that takes
minutes.
Artifact archives are extracted by hand-rolled tar and zip readers, so
neither binary needs to be installed. Both refuse entries that would write
outside the destination directory.
@modelcontextprotocol/sdk is the only runtime dependency. Colour, spinners,
progress bars, tables and prompts are all local.
Noch keine Tool-Liste. Remote-Server erhalten eine nach dem ersten Health-Check.
FAQ
Fragen
Wie installiere ich Octri CLI?
Kopieren Sie auf dieser Seite die stdio-Konfiguration für Cursor, Claude Desktop, Claude Code oder VS Code. Sie nutzt die Installation des Herausgebers, keinen PlugMCP-Proxy.
Benötigt Octri CLI einen API-Schlüssel?
Der Herausgeber nennt diese Umgebungsvariablen: OCTRI_API_KEY, OCTRI_PROJECT_ID, OCTRI_PROFILE, HTTPS_PROXY, NO_PROXY.
Welchen Transport verwendet Octri CLI?
Octri CLI läuft lokal über stdio.
Wann wurde Octri CLI zuletzt geprüft?
Zuletzt geprüft: 2026-11-08. Push OpenAPI specs, build SDKs in ten languages, publish API docs, and triage production SDK errors.