omnigraph/docs/user/quickstart.md

Quickstart

This walks the core loop end to end: define a schema, initialize a graph, load data, query it, and use a branch. It uses a local file-backed graph; swap the path for an s3://… URI to run the same flow against object storage.

Install the omnigraph CLI first.

1. Write a schema

A schema (.pg) declares your node and edge types. Save this as schema.pg:

node Person {
  name: String,
  title: String?,
}

See the schema language for types, constraints, and edges.

2. Initialize the graph

omnigraph init --schema schema.pg graph.omni

init creates an empty graph at the given URI with your schema applied.

3. Load data

load is the single bulk-write command. --mode is required (overwrite | append | merge):

omnigraph load --data people.jsonl --mode overwrite graph.omni

people.jsonl is newline-delimited JSON, one record per line. For finer-grained or inline writes, see mutations.

4. Query

Write a query (.gq) — save as queries.gq:

query find_people($title: String) {
  match { $p: Person { title: $title } }
  return { $p.name }
}

Run it:

omnigraph read --query queries.gq --name find_people \
  --params '{"title":"Engineer"}' --format table graph.omni

The query language covers match/return/order, and search covers vector and full-text search.

5. Work on a branch

Branches isolate changes until you merge them — Git-style, across the whole graph:

omnigraph branch create review/new-hires graph.omni
omnigraph load --data new-hires.jsonl --mode append --branch review/new-hires graph.omni
# inspect the branch, then integrate it
omnigraph branch merge review/new-hires --into main graph.omni

See branches & commits and merging.

Next steps

• CLI reference — every command and flag.
• Schema language and query language.
• Operating a cluster and running the server for multi-graph, multi-user deployments.