Verified Commit 00f5adaa authored by Uma Chandran's avatar Uma Chandran Committed by GitLab
Browse files

docs: refactor follow-up - remove extra disclaimers and fix CLI references

parent 3549db98
Loading
Loading
Loading
Loading
+2 −6
Original line number Diff line number Diff line
@@ -25,10 +25,6 @@ title: Orbit
> For more information, see the history.
> This feature is available for testing, but not ready for production use.

<!-- -->

> [!disclaimer]

Orbit indexes your GitLab instance and exposes your entire SDLC as a queryable knowledge graph.
Enable it on a group and Orbit maps everything: projects, users, merge requests, pipelines,
work items, security findings, and the source code itself, then builds a property graph of how they
@@ -76,14 +72,14 @@ Orbit Remote runs as a separate service and shares minimal load with your GitLab

## Orbit Local

Orbit Local runs entirely on your machine. The `orbit` CLI parses a local repository,
Orbit Local runs entirely on your machine. The Orbit CLI (`orbit`) parses a local repository,
extracts definitions and cross-file references, and writes the graph to a local DuckDB file.
No GitLab instance or network connection required.

```mermaid
flowchart LR
    accTitle: Orbit Local architecture
    accDescr: The orbit CLI parses a local repository, builds a code graph, and writes it to a local DuckDB file. You query the graph via the CLI.
    accDescr: The Orbit CLI parses a local repository, builds a code graph, and writes it to a local DuckDB file. You query the graph via the CLI.

    Repo[Local repository] --> CLI["orbit CLI"]
    CLI --> DB[("DuckDB\n~/.orbit/graph.duckdb")]
+2 −4
Original line number Diff line number Diff line
@@ -20,8 +20,6 @@ title: Orbit Local

{{< /history >}}

> [!disclaimer]

Orbit Local runs entirely on your machine. Build a code graph for any local
repository and query it using the same query language as Orbit Remote. No
GitLab account, no network connection required.
@@ -44,8 +42,8 @@ GitLab account, no network connection required.

| Method | Description |
|---|---|
| [orbit CLI](access/cli.md) | Run the `orbit` binary directly to index and query |
| [glab CLI](access/glab.md) | Drive Orbit Local through `glab orbit local` (planned) |
| [The Orbit CLI (`orbit`)](access/cli.md) | Run the `orbit` binary directly to index and query |
| [The GitLab CLI (`glab`)](access/glab.md) | Drive Orbit Local through `glab orbit local` (planned) |
| [MCP](access/mcp.md) | Expose the local graph to Claude Code, Codex, and other agents |

## Billing
+3 −5
Original line number Diff line number Diff line
@@ -2,8 +2,8 @@
stage: Analytics
group: Knowledge Graph
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Build and query a local code graph with the orbit CLI binary. No GitLab account or network connection required.
title: Use Orbit Local with the orbit CLI
description: Build and query a local code graph with the Orbit CLI (orbit) binary. No GitLab account or network connection required.
title: Use Orbit Local with the Orbit CLI (`orbit`)
---

{{< details >}}
@@ -20,9 +20,7 @@ title: Use Orbit Local with the orbit CLI

{{< /history >}}

> [!disclaimer]

The `orbit` CLI builds a code graph for any local repository and queries it
The Orbit CLI (`orbit`) builds a code graph for any local repository and queries it
against a local DuckDB file. No GitLab connection required.

> [!note]
+3 −3
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ stage: Analytics
group: Knowledge Graph
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: The glab orbit local subcommands and glab orbit setup are planned for a future glab release. Until they ship, build from source and use the orbit binary directly.
title: Use Orbit Local with the glab CLI
title: Use Orbit Local with the GitLab CLI (`glab`)
---

{{< details >}}
@@ -22,7 +22,7 @@ title: Use Orbit Local with the glab CLI

> [!disclaimer]

The [`glab` CLI](https://docs.gitlab.com/cli/) is the canonical way to install,
The [GitLab CLI (`glab`)](https://docs.gitlab.com/cli/) is the canonical way to install,
run, and integrate Orbit Local with your AI agent. `glab orbit local` mirrors
`glab orbit remote`, so the same patterns work whether you query the GitLab
instance or your local machine.
@@ -30,7 +30,7 @@ instance or your local machine.
> [!note]
> Both `glab orbit local` and `glab orbit setup` are planned for a future glab
> release. Every command on this page is the future shape, not the current one.
> Until they ship, build from source - see [Use the orbit CLI directly](cli.md).
> Until they ship, build from source - see [use `orbit` directly](cli.md).

Two top-level commands (both planned, not yet shipped):

+1 −3
Original line number Diff line number Diff line
@@ -20,8 +20,6 @@ title: Connect to Orbit Local via MCP

{{< /history >}}

> [!disclaimer]

Orbit Local can run as an MCP server, exposing the same two tools as Orbit
Remote (`query_graph`, `get_graph_schema`) but pointed at the local DuckDB
graph instead of a GitLab instance.
@@ -32,7 +30,7 @@ graph instead of a GitLab instance.

## Prerequisites

- The `orbit` CLI is installed. See [Use the orbit CLI directly](cli.md).
- The Orbit CLI (`orbit`) is installed. See [Use the Orbit CLI directly](cli.md).
- A local repository has been indexed (`orbit index <path>` or
  `glab orbit local index <path>`).

Loading