GitLab CLI（`glab`）でOrbitを使用する

プラン: Premium、Ultimate
提供形態: GitLab.com
ステータス: ベータ版

この機能の利用可否は機能フラグによって制御されています。詳細については、履歴を参照してください。この機能はテスト目的で利用可能ですが、本番環境での使用には対応していません。

このページには、今後リリース予定の製品や機能に関する情報が記載されています。重要な注意点として、ここで提供される内容は情報提供のみを目的としています。この情報のみに基づいて購入や計画に関する判断を行うことはお控えください。製品や機能の開発、リリース、提供時期は変更または遅延する可能性があり、GitLab Inc.の単独の裁量によって決定されます。

GitLab CLI（glab）は、コマンドラインからOrbitをセットアップおよびクエリするための標準的な方法です。

トップレベルコマンドは2つあります。

glab orbit remote: Orbit Remote REST APIを呼び出す型付きサブコマンドです。glab 1.94以降で利用可能です。
glab orbit setup: AIエージェント向けにOrbitスキルとMCP設定をワンコマンドでインストールします。将来のglabリリースで提供予定です。リリースまでの間は、MCPクライアントを手動で設定してください。

前提条件

Orbitがグループで有効化されていること。
glabがインストールされ、認証済みであること:
```
glab auth login
```
ユーザーがOrbitを有効にした少なくとも1つのトップレベルグループにアクセスできること。

AIエージェントをセットアップする

glab orbit setupは将来のglabリリースで提供予定です。リリース後は、ワンコマンドでOrbitスキルのインストールとAIエージェント（Claude Code、OpenCode、Cursor、Codex、Gemini CLI）向けのMCP設定の書き込みが行えるようになります。

リリースまでの間は、MCPクライアントを手動で設定してください。

コマンドラインからOrbitにクエリを実行する

glab orbit remote（またはエイリアスr）を使用して、Orbit Remote APIを直接呼び出します。スクリプト作成、デバッグ、クエリ作成前のスキーマ調査に役立ちます。glab 1.94以降が必要です。

サブコマンド	エンドポイント	目的
`glab orbit remote status`	`GET orbit/status`	クラスターの正常性確認。
`glab orbit remote schema [node...]`	`GET orbit/schema`	グラフオントロジー。位置引数で特定のノードを展開します。
`glab orbit remote tools`	`GET orbit/tools`	完全なDSL JSONスキーマを含むMCPツールマニフェスト。
`glab orbit remote query [file\|-]`	`POST orbit/query`	ファイルまたは標準入力からクエリを実行します。
`glab orbit remote graph-status`	`GET orbit/graph_status`	ネームスペース、プロジェクト、またはフルパスのインデックス作成の進捗状況。

スキーマを確認する

glab orbit remote status
glab orbit remote schema
glab orbit remote schema MergeRequest Project
glab orbit remote tools

クエリを実行する

your-groupを実際のグループパスに置き換えてください。このクエリはそのグループの最初の5つのプロジェクトを返します。

リクエストボディをquery.jsonに記述します。

{
  "query": {
    "query_type": "traversal",
    "node": {
      "id": "p",
      "entity": "Project",
      "filters": {
        "full_path": { "op": "starts_with", "value": "your-group/" }
      }
    },
    "limit": 5
  }
}

glab orbit remote query query.json

--formatフラグはリクエストボディのresponse_formatにマップされます。

--format llm - AIエージェントの処理に最適化されたコンパクトなテキスト形式。
--format raw - jqへのパイプに適した構造化されたJSON形式。

--formatが未設定の場合、ボディのresponse_formatが優先され、最終的なフォールバックとしてllmが使用されます。

インデックス作成の進捗状況を確認する

スコープフラグをいずれか1つ指定してください。

glab orbit remote graph-status --full-path your-group/your-project
glab orbit remote graph-status --namespace-id 24
glab orbit remote graph-status --project-id 2

終了コード

glab orbit remoteはHTTPエラーを安定した終了コードにマップするため、スクリプトやエージェントはstderrを解析せずに分岐処理を行えます。

ステータス	終了コード	意味
`200`	`0`	成功。
`404`	`2`	`knowledge_graph`機能フラグがオフ、またはパスのタイポ。
`401`	`3`	トークンが存在しないか期限切れ。
`403`	`4`	Knowledge Graphが有効なネームスペースが存在しない。
`429`	`5`	レート制限。`Retry-After`を確認してバックオフしてください。
その他	`1`	非構造化エラー。レスポンスボディがある場合は含まれます。

課金

glab orbit remote queryはMCPクエリと同様にGitLabクレジットを消費します。status、schema、tools、graph-statusの呼び出しは消費対象外です。

GitLab CLI（glab）でOrbitを使用する