mirror of https://github.com/ModernRelay/omnigraph.git synced 2026-06-12 01:45:14 +02:00

Devin AI 9ff4af47fb Merge branch 'main' into devin/1779464281-mr-656-inline-query-strings

Resolve conflicts: keep query/mutate canonical CLI subcommands and
top-level lint command (this branch) alongside the repo→graph terminology
rename from main. Update test helpers (repo_path → graph_path,
init_repo → init_graph, app_for_loaded_repo → app_for_loaded_graph) and
align tempdir variable names so the merged tests compile. Drop the now-
unused QueryCommand enum (Lint was promoted to a top-level Command).

Co-Authored-By: Ragnor Comerford <ragnor.comerford@gmail.com>

2026-05-24 17:27:48 +00:00

3.5 KiB

Raw Blame History

CLI Reference (`omnigraph`)

A reference for the omnigraph binary's command surface and omnigraph.yaml schema. For a quick-start guide, see cli.md.

17 top-level command families, 40+ subcommands. All commands accept either a positional URI, --uri, or a --target <name> resolved against omnigraph.yaml.

Top-level commands

Command	Purpose
`init`	`--schema <pg>` → initialize a graph (also scaffolds `omnigraph.yaml` if missing)
`load`	bulk load a branch (`--mode overwrite\|append\|merge`)
`ingest`	branch-creating transactional load (`--from <base>`)
`query` (alias: `read`)	run named read query; source via `--query <path>`, `-e`/`--query-string <GQ>`, or `--alias <name>` (exactly one). `read` is the deprecated previous name and prints a one-line warning to stderr
`mutate` (alias: `change`)	run mutation query; same `--query` / `-e` / `--alias` mutual-exclusion as `query`. `change` is the deprecated previous name and prints a one-line warning to stderr
`snapshot`	print current snapshot (per-table version + row count)
`export`	dump to JSONL on stdout (`--type T`, `--table K` filters)
`branch create \| list \| delete \| merge`	branching ops
`commit list \| show`	inspect commit graph
`run list \| show \| publish \| abort`	transactional run ops
`schema plan \| apply \| show (alias: get)`	migrations
`lint` (alias: `check`)	offline / graph-backed query validation. Replaces `query lint` / `query check`, which are kept as deprecated argv-level shims that print a one-line warning and rewrite to `omnigraph lint`
`optimize`	non-destructive Lance compaction
`cleanup --keep N --older-than 7d --confirm`	destructive version GC
`embed`	offline JSONL embedding pipeline
`policy validate \| test \| explain`	Cedar tooling
`version` / `-v`	print `omnigraph 0.3.x`

`omnigraph.yaml` schema

project: { name }
graphs:
  <name>:
    uri: <local|s3://|http(s)://>
    bearer_token_env: <ENV_NAME>
server:
  graph: <name>
  bind: <ip:port>
cli:
  graph: <name>
  branch: <name>
  output_format: json|jsonl|csv|kv|table
  table_max_column_width: 80
  table_cell_layout: truncate|wrap
query:
  roots: [<dir>, …]   # search path for .gq files
auth:
  env_file: ./.env.omni
aliases:
  <alias>:
    # accepted values: `read` / `query` (read alias), `change` / `mutate`
    # (write alias). `query` and `mutate` are recommended; `read` and
    # `change` remain accepted forever for back-compat.
    command: read|change|query|mutate
    query: <path-to-.gq>
    name: <query-name>
    args: [<positional-name>, …]
    graph: <name>
    branch: <name>
    format: <output-format>
policy:
  file: ./policy.yaml

Output formats (`query` command, alias: `read`)

json — pretty-printed object with metadata + rows
jsonl — one metadata line then one JSON object per row
csv — RFC 4180-ish quoting
table — fitted text table, honors table_max_column_width + table_cell_layout
kv — grouped per-row key/value blocks

Param resolution

Precedence (high to low): explicit --params / --params-file, alias positional args, omnigraph.yaml defaults. JS-safe-integer handling is built in (is_js_safe_integer_i64, JS_MAX_SAFE_INTEGER_U64) so 64-bit ids round-trip safely through JSON clients.

Bearer token resolution (CLI)

graphs.<name>.bearer_token_env
OMNIGRAPH_BEARER_TOKEN global env
auth.env_file referenced .env

Duration parsing (cleanup)

s | m | h | d | w units, e.g. --older-than 7d.

3.5 KiB Raw Blame History

CLI Reference (omnigraph)