tofupilot schema

Last updated on November 10, 2026

The schema command prints the JSON Schema (draft 2020-12) of procedure.yaml: every field the loader accepts, with its description. It is generated from the same definitions the loader and tofupilot validate enforce, so it matches the CLI's version.

print
tofupilot schema

--out <FILE>

Writes the schema to a file instead.

write
tofupilot schema --out .tofupilot/procedure.schema.json

procedure.yaml refuses unknown keys, $schema included. To get completion in VS Code and other editors with the YAML language server, point a comment at the file instead, as tofupilot init does:

procedure.yaml
# yaml-language-server: $schema=./.tofupilot/procedure.schema.json
name: Board Test

How is this guide?

On this page