GitLabgitlab-org

cli

main
ply7 git calls384 ms98 KiB5 cachedprotocol v2
83 lines3.0 KiBRaw

Query the GitLab Orbit context graph. (EXPERIMENTAL)

Synopsis

Run the GitLab Orbit CLI through glab.

Coding agents: run glab orbit --yes skills get orbit to load the Orbit skill. --yes installs the binary without a prompt on first use.

Every command and flag, including --help, is forwarded verbatim to the managed Orbit binary. glab downloads, verifies, and updates that binary for you on first use. Until the binary is installed, glab orbit and --help print install instructions instead. glab passes your resolved GitLab credential to the binary on every invocation, so remote commands such as glab orbit query need no separate login.

glab handles only the update command and the --install, --update, and --yes flags itself. Run glab help orbit to see them.

Prerequisites:

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

Configuration options:

  • orbit_cli_auto_run: Skip the run confirmation prompt.
  • orbit_cli_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/.

plaintext
glab orbit [<command>] [flags]

Examples

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

# Install on first use without a prompt, then load the Orbit skill
$ glab orbit --yes skills get orbit

# Show the Orbit binary's own help
$ glab orbit --help

Environment variables

plaintext
- `GLAB_ORBIT_CLI_BINARY_PATH`: Use a local binary instead of the managed one. Skips
  download, version checks, and updates. Can also be set via the `orbit_cli_binary_path`
  configuration key.
- `ORBIT_CLI_AUTO_DOWNLOAD`: Set to `true` to download the binary without a
  prompt. Required to run in a non-interactive environment such as CI.
- `ORBIT_CLI_AUTO_RUN`: Set to `true` to run the binary without a prompt.
  Required to run in a non-interactive environment such as CI.

Options

plaintext
  -h, --help      Show the Orbit binary's help, or install instructions until the binary is installed.
      --install   Install the Orbit binary without running it.
      --update    Check for and install updates to the binary. Same as the update command.
  -y, --yes       Skip confirmation prompts.

Subcommands

1---
2title: '`glab orbit`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Query the GitLab Orbit context graph. (EXPERIMENTAL)
15## Synopsis
17Run the GitLab Orbit CLI through glab.
19Coding agents: run `glab orbit --yes skills get orbit` to load the Orbit skill. `--yes` installs the binary without a prompt on first use.
21Every command and flag, including `--help`, is forwarded verbatim to the managed Orbit binary. glab downloads, verifies, and updates that binary for you on first use. Until the binary is installed, `glab orbit` and `--help` print install instructions instead. glab passes your resolved GitLab credential to the binary on every invocation, so remote commands such as `glab orbit query` need no separate login.
23glab handles only the `update` command and the `--install`, `--update`, and `--yes` flags itself. Run `glab help orbit` to see them.
25Prerequisites:
27- Run `glab auth login` to authenticate.
28- Orbit must be enabled for your namespace (the `knowledge_graph` feature flag).
30Configuration options:
32- `orbit_cli_auto_run`: Skip the run confirmation prompt.
33- `orbit_cli_auto_download`: Skip the download confirmation prompt.
35For more information, see the [Orbit documentation](https://docs.gitlab.com/orbit/).
37This feature is an experiment and is not ready for production use.
38It might be unstable or removed at any time.
39For more information, see
40<https://docs.gitlab.com/policy/development_stages_support/>.
42```plaintext
43glab orbit [<command>] [flags]
44```
46## Examples
48```console
49# Install the managed binary without running it, or update it
50$ glab orbit --install --yes
51$ glab orbit update
53# Install on first use without a prompt, then load the Orbit skill
54$ glab orbit --yes skills get orbit
56# Show the Orbit binary's own help
57$ glab orbit --help
58```
60## Environment variables
62```plaintext
63- `GLAB_ORBIT_CLI_BINARY_PATH`: Use a local binary instead of the managed one. Skips
64 download, version checks, and updates. Can also be set via the `orbit_cli_binary_path`
65 configuration key.
66- `ORBIT_CLI_AUTO_DOWNLOAD`: Set to `true` to download the binary without a
67 prompt. Required to run in a non-interactive environment such as CI.
68- `ORBIT_CLI_AUTO_RUN`: Set to `true` to run the binary without a prompt.
69 Required to run in a non-interactive environment such as CI.
70```
72## Options
74```plaintext
75 -h, --help Show the Orbit binary's help, or install instructions until the binary is installed.
76 --install Install the Orbit binary without running it.
77 --update Check for and install updates to the binary. Same as the update command.
78 -y, --yes Skip confirmation prompts.
79```
81## Subcommands
83- [`update`](update.md)
Diagnostics7 git calls · 384 ms
CallStatusSizeTime0384 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=5
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit5 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=4
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=5
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:02001.7 KiB · hit4 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=1744
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200139 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=369
git.response.bytes=139
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=11e1c93faefe1a12707d1e700a66b50886cb542c
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=139
git.pkt.payload.max=112
git.sideband.band1.bytes=112
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=112
git.pack.trailer=785d2810cf618dc198f82a8839ebcdd90fa19b9c
Open pack map
fetch2001.4 KiB369 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1384
git.response.cache=MISS
git.response.duration_ms=369
git.fetch.wants=09168e92b7193f3eeddfede95c1df32ab2c1c45b
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1384
git.pkt.payload.max=1357
git.sideband.band1.bytes=1357
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e16cfd2e1b4b2a
Request
fa6a07fb…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format