Help us learn about your current experience with the documentation. Take the survey.

glab orbit

GitLab Knowledge Graph commands. (EXPERIMENTAL)

Synopsis

Run the Orbit CLI for the GitLab Knowledge Graph (product name: Orbit).

Every command and flag is forwarded verbatim to the managed Orbit binary, which is downloaded, verified, and kept up to date for you on first use. glab orbit remote <command> authenticates automatically using your resolved GitLab credential; all other commands run the binary with no extra environment.

Prerequisites:

  • Run glab auth login to authenticate.
  • Orbit must be enabled for your namespace (the knowledge_graph feature flag).

Configuration options:

  • orbit_local_auto_run: Skip the run confirmation prompt.
  • orbit_local_auto_download: Skip the download confirmation prompt.

For more information, see the Orbit documentation.

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/.

glab orbit [<command>] [flags]

Examples

# Guided onboarding (choose your assistant)
$ glab orbit setup claude

# Discover and query the remote Knowledge Graph (authenticates automatically)
$ glab orbit remote status
$ glab orbit remote query ./query.json
$ glab orbit remote graph-status --full-path gitlab-org/gitlab

# Index and query a local copy of the graph
$ glab orbit local index
$ glab orbit local sql "SELECT 1"

# Show the Orbit binary version
$ glab orbit version

# Install or update the managed binary without running it
$ glab orbit --install
$ glab orbit --update

Options

      --install   Install the Orbit binary without running it.
      --update    Check for and install updates to the binary.
  -y, --yes       Skip confirmation prompts.

Options inherited from parent commands

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