正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

glab orbit remote

Interact with the remote GitLab Knowledge Graph. (EXPERIMENTAL)

Synopsis

Query the remote GitLab Knowledge Graph (product name: Orbit) directly from the CLI. All endpoints are user-scoped (not project-scoped) and gated behind the knowledge_graph feature flag.

Start with these discovery commands. They return the authoritative ontology and query DSL schema:

glab orbit remote status                         # Is the service up?
glab orbit remote schema                         # What entities and edges exist?
glab orbit remote schema MergeRequest Project    # Show details for specific nodes
glab orbit remote tools                          # Full DSL JSON Schema

After you know the shape of the graph, run a query:

glab orbit remote query path/to/query.json
cat query.json | glab orbit remote query -

Inspect indexing progress for a namespace or project:

glab orbit remote graph-status --full-path gitlab-org/gitlab

Exit codes:

  • 1: Generic error.
  • 2: Orbit endpoint unavailable (HTTP 404, for example, when the feature flag is off).
  • 3: Not authenticated (HTTP 401).
  • 4: Access denied (HTTP 403, for example, when no Knowledge Graph enabled namespaces exist).
  • 5: Rate limited (HTTP 429).

This feature is an experiment and is not ready for production use. It might be unstable or removed at any time. For more information, see https://docs.gitlab.com/policy/development_stages_support/.

Aliases

r

Examples

# Discovery workflow (always start here)
$ glab orbit remote status
$ glab orbit remote schema
$ glab orbit remote schema User Project MergeRequest
$ glab orbit remote tools

# Run a query from a file
$ glab orbit remote query ./query.json

# Run a query from stdin (raw output for jq pipelines)
$ echo '{"query":{"query_type":"traversal","node":{"id":"p","entity":"Project"},"limit":5}}' \
    | glab orbit remote query --format raw -

# Inspect indexing progress
$ glab orbit remote graph-status --full-path gitlab-org/gitlab

Options inherited from parent commands

  -h, --help   Show help for this command.

Subcommands