omnigraph/README.md

Omnigraph

Typed graph engine built for reasoning paths, not just storage.
Git-style workflows, schema-as-code graph modeling, S3-optimized.

Use Cases

• On-prem & hybrid context graphs
• Backbone for multi-agentic research
• Enterprise knowledge systems

Quick Install

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/install.sh | bash

This installs omnigraph and omnigraph-server into ~/.local/bin from published release binaries.

Or install with Homebrew:

brew tap ModernRelay/tap
brew install ModernRelay/tap/omnigraph

For starter graphs and agent skills to bootstrap and operate Omnigraph, see ModernRelay/omnigraph-starters.

One-Command Local RustFS Bootstrap

curl -fsSL https://raw.githubusercontent.com/ModernRelay/omnigraph/main/scripts/local-rustfs-bootstrap.sh | bash

That bootstrap:

• starts RustFS on 127.0.0.1:9000
• creates a bucket and S3-backed repo
• loads the checked-in context fixture
• launches omnigraph-server on 127.0.0.1:8080

Docker must be installed and running first.

The RustFS bootstrap prefers the rolling edge binaries and only falls back to source builds when release assets are unavailable.

If a previous run left objects under the same repo prefix but did not finish initializing the repo, rerun with RESET_REPO=1 or set PREFIX to a new value.

Omnigraph CORE

• Typed schema, typed queries, and typed mutations
• Schema-as-code, query validation and linting
• Git-style graph workflows: branches, commits, merges, and transactional runs
• Local, on-prem & cloud S3-native storage with snapshot-pinned reads
• Graph traversal + text, fuzzy, BM25, vector, and RRF search in one runtime
• Policy-as-code for server-side access control
• Single CLI for multiple deployments

Common Commands

The same URI works for local paths, s3://…, or http://host:port.

omnigraph init   --schema ./schema.pg ./repo.omni
omnigraph load   --data   ./data.jsonl ./repo.omni
omnigraph read   --query  ./queries.gq --name get_person --params '{"name":"Alice"}' ./repo.omni
omnigraph change --query  ./queries.gq --name insert_person --params '{"name":"Mina"}' ./repo.omni
omnigraph branch create --from main feature-x ./repo.omni
omnigraph branch merge  feature-x --into main ./repo.omni

See docs/cli.md for schema apply, snapshots, ingest, runs, and policy commands.

Docs

• Install guide
• CLI guide
• Deployment guide

Build And Test

cargo build --workspace
cargo check --workspace
cargo test --workspace

Notes:

• Rust stable toolchain, edition 2024
• CI runs cargo test --workspace --locked
• Full CI and some local test flows require protobuf-compiler
• S3 integration tests expect an S3-compatible endpoint such as RustFS

Workspace Crates

• crates/omnigraph-compiler: shared schema/query parser, typechecker, catalog, and IR lowering
• crates/omnigraph: storage/runtime, branching, merge, change detection, and query execution
• crates/omnigraph-cli: CLI for init/load/ingest/read/change/branch/snapshot/export/policy operations
• crates/omnigraph-server: Axum HTTP server for remote reads, changes, ingest, export, branches, commits, and runs

Contributing

Please open an issue, spec, or design discussion before sending large code changes. Design feedback and concrete problem statements are the fastest way to collaborate on the roadmap.