ancha schema - Ancha

ancha schema prints JSON Schema (draft 2020-12) for every file you write for Ancha and every JSON output you parse from it.

ancha schema [options] [kind]

Argument	Description
`kind`	One of: ancha, scene, run_started, run_finished, explain, world_up, check, error (default: all)

Kind	Describes
`ancha`	`ancha.yaml`. See ancha.yaml.
`scene`	Scene files, the same schema `ancha scene schema` prints. See Test file.
`run_started`	The first NDJSON event of `ancha run --json`.
`run_finished`	The last event of `ancha run --json`, `ancha wait --json` and `ancha logs --follow --json`, with the run summary.
`explain`	The output of `ancha explain --json`.
`world_up`	The output of `ancha world up --json`.
`check`	The output of `ancha check --json`.
`error`	The `{"error": {...}}` object every command prints when it fails with `--json`.

Examples

ancha schema scene > scene.schema.json      # for your editor's YAML language server
ancha schema run_finished                   # what a harness parses after a run
ancha schema --json                         # every kind in one object

The output is always JSON, with or without --json. With a kind it prints {"version": 1, "kind": "run_finished", "schema": {...}}; without, {"version": 1, "kinds": [...], "schemas": {...}}. version changes only when a shape changes incompatibly. Adding a field keeps it.

Exit codes

0. An unknown kind exits 2:

Output

error[USAGE]: unknown schema: nope
hint: available: ancha, scene, run_started, run_finished, explain, world_up, check, error