ドキュメントに関する現在のご利用体験についてお聞かせください。アンケートにご協力ください。

GitLab Orbit Remoteを使ってみる

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

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

前提条件

GitLab Orbitを有効にするには、トップレベルグループのオーナーロール
インデックス作成済みのグループをクエリするには、レポーターロール以上
セキュリティデータを表示するには、セキュリティマネージャーロール。詳細については、GitLab Orbitのクエリに必要なロールを参照してください。

GitLab Orbitはトップレベルグループのみをインデックス作成します。サブグループとプロジェクトは自動的にインデックス作成を継承します。

ステップ1: GitLab Orbitを有効にする

左サイドバーでマイワークを展開します。
Orbit > 設定を選択します。
インデックスリストでトップレベルグループを見つけます。
有効にするを切り替えます。

GitLab Orbitはすぐにインデックス作成を開始します。初回のインデックス作成は、小規模なグループでは数分、数千のプロジェクトを持つグループでは最大30分かかります。

インデックス作成のステータスはいつでも確認できます。

glab orbit remote status

ステップ2: 最初のクエリを実行する

GitLab Orbit Remoteは同じグラフを3つのインターフェースで公開しています。クエリを実行するユーザーに合ったものを選択してください。

方法	最適な用途	セットアップ	課金
GitLab Duo Agent Platform	GitLab UIのエンドユーザー	不要	消費対象外
MCP	Claude Code、Codex、その他のAIエージェント	エージェントの初回設定	GitLab Credits
REST API	スクリプト、ダッシュボード、カスタムツール	APIトークン	GitLab Credits

GitLab Duo Agent Platform（セットアップ不要）

GitLab OrbitはGitLab Duo Agent Platformに組み込まれています。GitLab Duo Agent、Planner Agent、Security Analyst Agent、Data Analyst Agent、CI Expert Agent、Developer Flowは、グラフトラバーサルで回答するのが最適な質問に対して、GitLab Orbitのlist_commandsとinvoke_commandツールを自動的に呼び出し、query_graphやget_graph_schemaなどのコマンドを実行します。ツールの選択や設定は不要です。

たとえば、deploy_userメソッドの名前変更を依頼する作業アイテムを登録すると、Developer FlowはGitLab Orbitを使用してそのメソッドを呼び出しているすべてのサービスを特定し、それぞれを更新するMRを作成します。

GitLab Duoのクエリは消費対象外であり、GitLab Creditsを消費しません。

MCP（Claude Code、Codex、その他のエージェント）

セットアップについてはMCPを使用してGitLab Orbitにアクセスするを参照してください。設定が完了すると、query_graphとget_graph_schemaの2つのツールが使用できます。

AIエージェント向けGitLab Orbitスキルをインストールする

GitLab OrbitスキルはAIエージェントにクエリレシピ、DSLガイダンス、トラブルシューティングを提供し、初回から正しいGitLab Orbitクエリを作成できるようにします。

glab skills install --global orbit

プロジェクトスコープのインストール、アップデート手順、スキルの内容については、GitLab Orbitスキルを使用してAIコーディングエージェントをセットアップするを参照してください。

REST API

your-groupをGitLab Orbitを有効にしたトップレベルグループのパスに置き換えてください。full_pathフィルターはクエリのスコープを絞り込み、GitLab Orbitの選択性検証を通過させます。

リクエストボディをrequest.jsonに保存してください。

{
  "query": {
    "query_type": "traversal",
    "nodes": [{
      "id": "p",
      "entity": "Project",
      "columns": ["name", "full_path"],
      "filters": {
        "full_path": {"starts_with": "your-group/"}
      }
    }],
    "limit": 10
  },
  "format": "raw"
}

curl --request POST \
  --header "Authorization: Bearer <your_token>" \
  --header "Content-Type: application/json" \
  --data @request.json \
  "https://gitlab.com/api/v4/orbit/query"

次に試すこと

GitLab Orbitのインデックス対象 - クエリを作成する前にカバレッジを理解する
スキーマリファレンス - 28種類のノードタイプとそのプロパティを確認する
Cookbook - 一般的なユースケース向けのコピー&ペーストクエリ
GitLab Orbit Localを使ってみる - ローカルリポジトリをオフラインでクエリする