omnigraph/og-cheet-sheet.md
Ragnor Comerford c2db7b5002
fix(cli,server): correct remaining --target references to --graph
L6 renamed the flag but left stragglers. Two were functional: the
`resolve_target_uri` "URI must be provided …" error still named `--target`, and
`docker/entrypoint.sh` passed `--target` to omnigraph-server (which now only
accepts `--graph`) — so the container failed to boot. Both fixed (plus the
entrypoint smoke test's expected args). The rest are code comments across the
config/server/cli crates and tests, and the cheat sheet, swept `--target` →
`--graph`. `--target-branch` (policy explain) is a distinct flag and untouched;
past release notes keep `--target` (accurate for those versions).
2026-06-04 08:56:39 +02:00

1.1 KiB

Omnigraph Cheat Sheet

Local Query Validation

Use an explicit schema file:

omnigraph lint  --query ./queries.gq --schema ./schema.pg --json
omnigraph check --query ./queries.gq --schema ./schema.pg

Use a local or s3:// repo target:

omnigraph lint  --query ./queries.gq ./repo.omni --json
omnigraph check --query ./queries.gq s3://bucket/repo

Use omnigraph.yaml target resolution:

omnigraph lint --query ./queries.gq --graph local --config ./omnigraph.yaml

The previous omnigraph query lint / omnigraph query check spellings are kept as deprecated argv shims that print a one-line warning to stderr and rewrite to the canonical omnigraph lint / omnigraph check.

What It Checks

  • parses every query in the file
  • typechecks each query against the resolved schema
  • warns on hardcoded mutation queries with no params
  • warns when nullable node fields have no update-query coverage

Current Limits

  • repo-backed lint is local/S3-only in v1
  • HTTP targets need --schema
  • exit code is nonzero only when there are strict validation errors