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

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

glab orbitは管理されたorbitバイナリを実行します。各コマンドをバイナリに転送し、glabがダウンロード、検証、および最新状態の維持を自動で行います。バイナリ独自のコマンドリファレンスはglab orbit remote <command> --helpで確認できます。

• glab orbit remote: GitLab Orbit Remote REST APIをクエリします。glabがGitLabの認証情報を自動的に注入します。glab 1.94以降で利用可能です。
• glab orbit setup: GitLab OrbitスキルのインストールとAIエージェントの設定をガイド付きオンボーディングで行います。

前提条件

• GitLab Orbitがグループで有効化されていること。

• glabがインストールされ、認証済みであること:

  glab auth login

• ユーザーがGitLab Orbitを有効にした少なくとも1つのトップレベルグループにアクセスできること。

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

glab orbit setupは、AIコーディングエージェント（Claude Code、OpenCode、Cursor、Codex、Gemini CLI）がグラフを参照できるよう設定し、GitLab Orbitスキルをインストールします。

glab orbit setup

MCPクライアントを接続する場合は、手動で設定してください。

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

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

glabが認証情報を解決してバイナリに渡すため、追加の認証手順は不要です。--hostnameで特定のGitLabインスタンスを指定し、--yesでスクリプト内のワンタイム実行確認をスキップできます。

スキーマを確認する

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

クエリを実行する

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

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

{
  "query": {
    "query_type": "traversal",
    "nodes": [{
      "id": "p",
      "entity": "Project",
      "filters": {
        "full_path": {"starts_with": "your-group/"}
      }
    }],
    "limit": 5
  }
}

glab orbit remote query query.json

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

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

--response-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を解析せずに分岐処理を行えます。

課金

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