mirror of https://github.com/ModernRelay/omnigraph.git synced 2026-06-09 01:35:18 +02:00

Ragnor Comerford a335d98854

Refactor AGENTS.md from encyclopedia to map; move spec into docs/

Splits the 990-line AGENTS.md into a 184-line map (architecture,
where-to-find index, always-on invariants, capability matrix,
maintenance contract) plus 18 new docs/*.md files holding the deep
content per topic (storage, schema and query languages, indexes,
embeddings, branches/commits, runs, merge, changes, execution, policy,
server, CLI reference, audit, errors, CI, constants, v0.3.1 notes).

Adds scripts/check-agents-md.sh and a check_agents_md CI job that
verifies every docs/ link in AGENTS.md resolves and every doc in the
canonical set is linked. CLAUDE.md remains a symlink to AGENTS.md.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

2026-04-28 23:31:08 +02:00

2.9 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.

13 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 repo (also scaffolds `omnigraph.yaml` if missing)
`load`	bulk load a branch (`--mode overwrite\|append\|merge`)
`ingest`	branch-creating transactional load (`--from <base>`)
`read`	run named query (params via `--params`, `--params-file`, or alias args)
`change`	run mutation query
`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
`query lint \| check`	offline / repo-backed validation
`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>:
    command: read|change
    query: <path-to-.gq>
    name: <query-name>
    args: [<positional-name>, …]
    graph: <name>
    branch: <name>
    format: <output-format>
policy:
  file: ./policy.yaml

Output formats (read command)

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.

2.9 KiB Raw Blame History

CLI Reference (omnigraph)