Skip to content

Repository files navigation

orbit-graph

orbit-graph builds a local SQLite index of a source tree and answers graph queries — search, references, callees, impact, command traces — from a Rust library and a CLI. It is standalone: no Orbit checkout, runtime, or configuration is required.

Install

Requires Rust 1.89+ and Git.

cargo install --path crates/orbit-graph-cli --locked

As an Orbit plugin, the same queries (search, show, refs, callees, impact, trace, deps, overview) are read-only orbit.graph.* tools that answer from an index the plugin's graph_sync maintenance builds, and orbit.graph.changes analyses a change for affected callers and tests to run; see docs/plugin.md. The installable source plugin is the .orbit-plugin/ directory.

Quick start

cd /path/to/repo
orbit-graph sync
orbit-graph search helper --kind symbol
orbit-graph refs 'symbol:src/lib.rs#helper:function'
orbit-graph callees 'symbol:src/lib.rs#entry:function'
orbit-graph changes main..HEAD --json   # affected callers and tests to run

Pass --format json for machine-readable output. orbit-graph --help lists every command.

Index lifecycle and location

Queries never refresh the index; run orbit-graph sync after source changes (--full to rebuild). The index lives in .orbit-graph/ at the worktree root and should not be committed; orbit-graph db-path prints its location and orbit-graph clean reports obsolete databases (clean --confirm removes them).

Documentation

License

MIT. See LICENSE.md.

About

Standalone code graph indexing and queries, recovered from Orbit

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages