Octri CLI

@octri/cli

octri は Octri プロジェクト用のコマンドラインツールです。ダッシュボードと同じ操作ができます。仕様をプッシュし、SDK をビルドし、ドキュメントを公開し、本番環境から SDK が報告するエラーに対応します。

Octri は OpenAPI 仕様を受け取り、ドキュメントサイト、10 言語のクライアントライブラリ、MCP サーバー、およびそれらすべての基盤となる API のモニタリングを提供します。 octri.dev をご覧ください。

Node 20 以降が必要です。

インストール

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

まずはこちら

octri auth login
octri projects use
octri specs push ./openapi.yaml

auth login を実行すると、メールアドレスとパスワード、および二要素認証を有効にしている場合は認証アプリのコードを求められます。引数なしで projects use を実行すると、選択メニューが開きます。

specs push はアップロードではなく、パイプラインの完了を待ちます。仕様の解析は約 1 秒で完了し、その後、ドキュメントページ、検索インデックス、変更履歴が生成されます。スピナーには現在のステージが表示されます。

SDK をビルドする

octri sdk audit                            # what is costing you, scored
octri sdk build --lang go,typescript --download

ターミナルで sdk build を実行すると、言語ごとにレーンが表示され、generating、verifying、packaging、installing、ready の各段階に応じて更新されます。パイプ経由または CI 環境では、追記のみの行が出力されます。また、いずれかの言語で失敗するとゼロ以外の終了コードを返すため、追加のフラグなしでビルドステップとして使用できます。

sdk audit は仕様を評価し、ジェネレーターが自動修正できる指摘事項を示します。octri sdk audit apply <key> を実行すると、そのうち 1 つを修正します。

ビルドを実行せずに、実際のジェネレーターの出力を確認するには、次のコマンドを実行します。

octri sdk preview --lang go
octri sdk preview --lang go --show client.go

ドキュメントを公開する

octri docs versions publish <specId>
octri docs versions label <specId> "Stable"
octri docs domain set docs.example.com

docs domain を実行すると、作成する CNAME レコードと TXT レコードが表示され、その後 docs domain verify で確認できます。

モニタリング

読み取りとトリアージはセッション上で実行されるため、ログインするだけで利用できます。

octri monitoring summary
octri monitoring issues --status unresolved
octri monitoring issue <id>
octri monitoring resolve <id>

monitoring issue はスタックを表示し、アップロード済みのソースマップと照合できたフレームを示します。どのフレームも照合できない場合、そのエラーが発生したリリースにはシンボルがありません。CLI はその旨を表示します。

アップロード用の 2 つのコマンドは、仕組みが異なります。CI ジョブにはシークレットが 1 つあり、ログインする方法がないため、インジェストトークンを使ってモニタリングサービスに直接接続します。

# 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

CI シークレットとして保存する 3 つの値を確認するには、octri monitoring config を実行します。アップロードするリリースは、SDK が実行時に報告するリリースと一致している必要があります。一致しないと、サービスはトレースとリリースを関連付けられません。

コマンド

グループ	内容
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
sdk	languages · operations · settings get|set · validate · audit · preview · build · builds · watch · artifacts · download · retry · publish · repos · stats
docs	pages [generate|regenerate|publish|title] · show <slug> · guides · nav · versions · domain · changelog
monitoring	status · enable · summary · issues · issue <id> · resolve|ignore|reopen|comment · logs · traces · performance · releases · alerts · checks · sourcemaps upload · sources upload · config
orgs	list · show · switch · usage · billing · invoices · members · invites
keys	list · create <name> · revoke <id>
github	status · connect <owner/repo> · sync · auto-sync <on|off>
jobs	list · show <id>
mcp	tools · serve

グループ単独のヘルプを表示するには、octri <group> --help を実行します。

グローバルフラグ：--project <id>、--profile <name>、--api-url <url>、--json、 --quiet、--plain、--no-color。

出力

モード	条件	出力内容
インタラクティブ	ターミナル	色、スピナー、リアルタイムのビルドレーン、テーブル
プレーン	パイプ経由、または CI が設定されている場合	追記のみの行、エスケープシーケンスなし
--json	指定した場合	stdout に 1 つの JSON ドキュメント、stderr にエラー

スクリプトで使う場合は --json を指定してください。

octri sdk builds --json | jq '.[0].status'
octri monitoring issues --status unresolved --json | jq 'length'

NO_COLOR と FORCE_COLOR の両方に対応しています。

設定

状態は ~/.octri/config.json に保存されます。セッショントークンを保持するため、モードは 0600 です。OCTRI_CONFIG_DIR で保存先を変更できます。

プロファイルを使うと、複数の環境を並べて管理できます。

octri config use prod --api-url api.octri.dev
octri config set defaultLanguages go,rust,swift

各値は、まずフラグ、次に環境変数、最後に保存済みプロファイルの順で解決されます。

変数	効果
OCTRI_PROFILE	使用するプロファイル
OCTRI_API_URL	API のルート（local は :3001 の省略形です）
OCTRI_TOKEN	保存済みセッションを使わずに指定する Bearer トークン
OCTRI_API_KEY	公開ルート用の API キー
OCTRI_PROJECT_ID	デフォルトのプロジェクト
OCTRI_CONFIG_DIR	設定ファイルとアーティファクトキャッシュの保存場所
OCTRI_DEBUG	失敗時にスタックトレースを表示

プロキシ経由の場合

CLI と octri mcp serve は、追加の Node フラグなしで、大文字・小文字どちらの標準プロキシ環境変数も読み取ります。https:// リクエストには HTTPS_PROXY を使用し、これだけが設定されている場合は HTTP_PROXY を使用します。NO_PROXY に記載されたホストとそのサブドメインには直接接続し、* を指定するとプロキシを無効にします。

export HTTPS_PROXY=http://user:[email protected]:3128
export NO_PROXY=localhost,127.0.0.1,corp.example
octri specs push ./openapi.yaml

プロキシが独自の認証局証明書で TLS を検査する場合は、NODE_EXTRA_CA_CERTS=/path/to/ca.pem でその CA を Node に指定してください。

MCP クライアントは通常、最小限の環境変数でサーバーを起動するため、シェルに頼らず、サーバーの env ブロックにこれらを設定してください。

MCP サーバー

octri mcp serve

このサーバーは stdio 経由で MCP を使用し、入力可能なコマンドと同じ機能をツールとして提供します。アシスタントは仕様を送信し、ビルドを待ち、生成された Go コードを読み、そのビルドが引き起こした本番環境のエラーを確認できます。

グローバルインストールなしで npx 経由で Cursor または VS Code にワンクリックで追加できます。

サーバーは octri auth login で使用したプロファイルを使います。先にサインインするか、環境変数に OCTRI_API_KEY を設定してください。公式 MCP Registry には dev.octri/cli として登録されています。

// Claude Desktop / Cursor
{
  "mcpServers": {
    "octri": {
      "command": "octri",
      "args": ["mcp", "serve"]
    }
  }
}

認証情報は保存済みプロファイルから取得され、アシスタントには表示されません。読み取りは制限なく行えます。取り消せない 2 つの操作は、それらを許可するフラグを付けてサーバーを起動しない限り拒否されます。

octri mcp serve --allow-publish   # publishing to package registries
octri mcp serve --allow-delete    # deleting specs

ツールの失敗はプロトコルエラーではなくツールの結果として返されるため、アシスタントはメッセージを確認して修正できます。

備考

• ビルドの進行状況はストリーミングではなくポーリングで確認します。/ws/sdk ソケットはヘッダーまたは Cookie で認証しますが、Node 組み込みの WebSocket ではこれらを設定できません。また、数分かかるビルドに対して、WebSocket 依存関係を追加してもレイテンシーが約 1 秒短縮されるだけです。
• アーティファクトアーカイブは独自実装の tar および zip リーダーで展開するため、どちらのバイナリもインストールする必要はありません。どちらも出力先ディレクトリの外に書き込むエントリーを拒否します。
• @modelcontextprotocol/sdk は唯一のランタイム依存関係です。色表示、スピナー、進行状況バー、テーブル、プロンプトはすべてローカル実装です。

---

Octri のその他のサービス

製品	機能
API Studio	OpenAPI 仕様から、ページごとに編集できるライブリクエストプレイグラウンド付きのホスト型ドキュメントサイトを作成します。
SDK Studio	同じ仕様から 10 言語のクライアントライブラリを生成し、バージョン管理してまとめてリリースします。
MCP	同じ仕様から、AI アシスタントが呼び出せるツールとして API エンドポイントとドキュメントを生成します。
Monitoring	API のエラー、トレース、稼働時間、リリースを、API に到達した SDK 呼び出しと関連付けて表示します。

Monitoring runtimes

Node · Python · Go · Ruby · Rust · PHP · Java · Kotlin · Swift · Dart

Documentation · Pricing · Changelog

MIT licensed.