orbit-cli

# Orbit local CLI skill The local CLI parses a checkout into a DuckDB property graph. `grep` finds every matching line in code, tests, config, and docs, labeled with its enclosing definition. `context` reads their source and relationships. `sql` runs read-only aggregations. `repo-map` orients you at the directory level. For production data, use the `orbit` skill. The binary is `orbit`, or `glab orbit` through the wrapper. In non-interactive shells, put glab's `--yes` before the subcommand so glab skips its install and run prompts: `glab orbit --yes sql "..."`. The binary rejects `--yes` after other subcommands. Only `setup` and `uninstall` take their own `--yes` (`glab orbit --yes setup --yes`). Run `orbit <command> --help` before you guess a flag. Run `orbit skills` to list available skills. Use `orbit skills get orbit [path]` to print the composed skill (`SKILL.md` by default), or specify a path to print a file from the skill tree. Wrapper details: [`references/local/cli.md`](references/local/cli.md). ## Fix inaccurate guidance If guidance is wrong or outdated (command, flag, or behavior), tell the user. With their confirmation, open a focused MR against `metadata.source-project` fixing `metadata.source-path` (one fix per MR, Conventional Commits). If they decline, note the discrepancy in one line and continue with the corrected command. ## Find, then read ```shell orbit index . orbit grep "rate limit" src --kind Method,Function orbit grep 'query_arrow|insert_batch|execute' crates/duckdb-client orbit context duckdb_client::search::DuckDbSearch::grep src/lib.rs:120-180 crates/duckdb-client ``` Quote `a|b|c` for OR alternatives. Plain words ignore case, `_`, and `-`; terms with regex characters match as regex. Each file is one row: matching lines are grouped under their enclosing definition as `Kind name:start-end`, followed by `←callers` and `→callees`. Files that define a term come first, then code, tests, and config or docs. A definition the query names prints first with its source. The usual rg and grep flags work: `-A`/`-B`/`-C`, `-l`, `-c`, `-w`, `-F`, `-g`. `--kind` takes definition kinds such as `Class,Method`. `--kind File` and `--kind Directory` list where the matches are, with their definitions. Pass names as printed by `grep`, paths, ranges, or directories to `context`. Definition targets show full source and indexed relationships. File targets show a compact map and at most ten connections per section, with omitted counts. `<--` is a caller and `-->` is a callee. Reuse the returned source. <!-- orbit:section quick-start --> ## Query and map ```shell orbit schema gl_definition orbit sql "SELECT definition_type, count(*) n FROM gl_definition GROUP BY 1 ORDER BY n DESC" orbit repo-map overview # then tree, api, class, extends, imports ``` <!-- /orbit:section --> Gotchas: - Queries are SQL against `gl_definition`, `gl_edge`, `gl_file`, `gl_directory`, and `gl_imported_symbol`. They are not the JSON DSL, which belongs to Orbit Remote. - `definition_type` values are capitalized. `WHERE definition_type='function'` returns zero rows. - `sql` queries all indexed revisions by default. Use `--repo .` for the current checkout revision, or `--db PATH` for one file. Index a commit before querying it. ## References | Topic | Location | |---|---| | CLI wrapper flags, config keys, pass-through args | [`references/cli.md`](references/local/cli.md) | | DuckDB tables and paste-ready SQL recipes | [`references/sql.md`](references/local/sql.md) | | Repository-map workflow (`orbit repo-map`) | [`references/repo_map.md`](references/local/repo_map.md) |