Verified Commit 9b59be7a authored by Dmitry Gruzd's avatar Dmitry Gruzd 2️⃣ Committed by GitLab
Browse files

docs(skills): update both Orbit skills for the flattened CLI

parent beed196e
Loading
Loading
Loading
Loading
+2 −2
Changes for CONTEXT.md: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -15,11 +15,11 @@ Retired engineering abbreviation for Orbit ("GitLab Knowledge Graph"). Still pre
_Avoid_: using GKG in user-facing contexts

**Orbit Remote**:
The hosted Orbit service. Indexes all GitLab.com SDLC and code data; queries are user-scoped and JWT-authenticated. The `orbit` binary reaches it with the `query`, `status`, `ontology`, `dsl`, `tools`, and `graph-status` verbs; `glab orbit remote` is `glab`'s own client for the same API.
The hosted Orbit service. Indexes all GitLab.com SDLC and code data; queries are user-scoped and JWT-authenticated. The flat `orbit` command tree reaches it with the `query`, `status`, `ontology`, `dsl`, `tools`, and `graph-status` verbs.
_Avoid_: "the server", "production GKG"

**Orbit Local**:
The local backend of the `orbit` binary: indexes a single repository into a DuckDB database for offline analysis, reached with the `index`, `grep`, `context`, `sql`, `schema`, `list`, `repo-map`, and `mcp` verbs. `glab orbit local` installs the binary and forwards commands to it.
The local backend of the `orbit` binary: indexes a single repository into a DuckDB database for offline analysis, reached in the same flat command tree with the `index`, `grep`, `context`, `sql`, `schema`, `list`, `repo-map`, and `mcp` verbs. `glab orbit` installs the binary and forwards all verbs to it.
_Avoid_: "the CLI" (ambiguous — one binary serves both backends)

### Graph model
+5 −5
Changes for README.md: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ What it indexes: directories, files, function and class definitions, and cross-f
| Access method | Use for |
|---|---|
| [`orbit` CLI](docs/source/local/access/cli.md) | Index, query, and inspect the local graph |
| [`glab orbit local`](docs/source/local/access/glab.md) | Install and run Orbit Local through `glab` |
| [`glab orbit`](docs/source/local/access/glab.md) | Install and run Orbit Local through `glab` |
| [MCP](docs/source/local/access/mcp.md) | Expose the local graph to AI coding agents over stdio |

Start with [Orbit Local getting started](docs/source/local/getting-started.md).
@@ -58,7 +58,7 @@ What it indexes: SDLC objects (including groups, projects, users, notes, merge r
|---|---|
| [GitLab Duo Agent Platform](docs/source/remote/access/duo.md) | Natural-language questions in the GitLab UI |
| [MCP](docs/source/remote/access/mcp.md) | Claude Code, Codex, Cursor, opencode, Gemini CLI |
| [`glab orbit remote`](docs/source/remote/access/glab.md) | Typed CLI subcommands for scripts and discovery |
| [`glab orbit`](docs/source/remote/access/glab.md) | Typed CLI subcommands for scripts and discovery |
| [REST API](docs/source/remote/access/api.md) | Pipelines, custom tooling, scripts |

Start with [Orbit Remote getting started](docs/source/remote/getting-started.md).
@@ -96,9 +96,9 @@ orbit sql 'SELECT count(*) FROM gl_definition'
### Quickstart: Orbit Remote

```shell
# Requires glab 1.94+, authenticated (glab auth login), with Orbit enabled on your group.
# Requires glab 1.117+, authenticated (glab auth login), with Orbit enabled on your group.
# See docs/source/remote/getting-started.md. Replace your-group/ with your top-level group path.
glab orbit remote schema
glab orbit ontology
```

Put the request body in `/tmp/orbit-query.json`:
@@ -120,7 +120,7 @@ Put the request body in `/tmp/orbit-query.json`:
```

```shell
glab orbit remote query /tmp/orbit-query.json
glab orbit query /tmp/orbit-query.json
```

The [cookbook](docs/source/remote/cookbook.md) has blast-radius, dependency, pipeline-health, and vulnerability recipes.
+1 −1
Changes for docs/design-documents/README.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ A secure query layer on top of the graph lets developers and AI agents query tha
  - **`Indexer`** (`gkg-server --mode Indexer`): Runs the shared indexing engine, consumes SDLC and code indexing requests from NATS JetStream, and writes graph data into ClickHouse.
  - **`DispatchIndexing`** (`gkg-server --mode DispatchIndexing`): On a schedule, detects enabled root namespaces with recent Siphon changes and publishes deduplicated per-namespace indexing requests to the internal `GKG_INDEXER` stream. It also runs scheduled dispatchers for code indexing tasks, namespace deletion, stale-edge reconciliation, and schema-migration lifecycle, including ontology archive publication.
  - **`HealthCheck`** (`gkg-server --mode HealthCheck`): Aggregates cluster health by probing Kubernetes deployments and ClickHouse instances, and exposes the result on a single `/health` endpoint.
- **Orbit Local's `orbit` CLI**, which parses a local repository, stores its code graph in DuckDB, accepts read-only DuckDB SQL, and serves local MCP tools over stdio. `glab orbit local` installs and runs this binary.
- **The `orbit` CLI**, which exposes one flat command tree. Local commands parse repositories, store code graphs in DuckDB, accept read-only DuckDB SQL, and serve MCP tools over stdio; hosted commands query Orbit Remote. `glab orbit` installs and runs this binary.
- **UI and product experiences**, which consume Orbit Remote through GitLab APIs and the GitLab Duo Agent Platform.

```mermaid
+4 −4
Changes for docs/dev/contributor-guides/first-query.md: 4 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -7,11 +7,11 @@ account.

You need:

- `glab` 1.94 or later.
- `glab` 1.117 or later.
- Any local Git repository with source files.

The examples use `orbit` directly after installation. If you prefer to stay
inside `glab`, replace `orbit` with `glab orbit local` in each command.
inside `glab`, replace `orbit` with `glab orbit` in each command.

The current Orbit Local command queries the local DuckDB graph with SQL. The
Orbit Remote Query DSL is linked at the end after the local graph concepts are
@@ -22,7 +22,7 @@ familiar.
Install the managed Orbit Local binary:

```shell
glab orbit local --install --yes
glab orbit --install --yes
```

Verify that the binary is available:
@@ -216,7 +216,7 @@ between them.
- [Orbit Local schema reference](../../source/local/schema.md) for the four
  local node types and their properties.
- [Orbit Local access methods](../../source/local/getting-started.md) for
  direct `orbit`, `glab orbit local`, and MCP usage.
  direct `orbit`, `glab orbit`, and MCP usage.
- [Orbit query language reference](../../source/remote/queries/query-language.md)
  for the Query DSL used by Orbit Remote and agent-facing graph queries.
- [Cookbook](../../source/remote/cookbook.md) for copy-paste query ideas.
+1 −1
Changes for docs/source/local/_index.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -45,7 +45,7 @@ the Query DSL instead. No GitLab account or network connection is required.
| Method | Description |
|---|---|
| [The GitLab Orbit CLI (`orbit`)](access/cli.md) | Run the `orbit` binary directly to index and query |
| [The GitLab CLI (`glab`)](access/glab.md) | Drive GitLab Orbit Local through `glab orbit local` |
| [The GitLab CLI (`glab`)](access/glab.md) | Drive GitLab Orbit Local through `glab orbit` |
| [MCP](access/mcp.md) | Expose the local graph to Claude Code, Codex, and other agents |

## Billing
Loading