@altopelago/aeon-cli
v0.9.6
Published
Command-line tools for parsing, finalizing, and inspecting AEON documents.
Maintainers
Readme
@altopelago/aeon-cli
Command-line tools for parsing, checking, formatting, finalizing, and inspecting AEON documents.
Installation
pnpm add -D @altopelago/aeon-cliOr run a pinned release directly:
npx @altopelago/[email protected] check ./document.aeonQuick Start
aeon check ./document.aeon
aeon inspect ./document.aeon --json
aeon finalize ./document.aeon --json
aeon fmt ./document.aeon --writeCommands
aeon version- show the CLI versionaeon check <file>- validate an AEON document with CI-friendly exit codesaeon doctor- check environment and contract registry wiringaeon fmt [file]- format AEON source, writing to stdout unless--writeis usedaeon inspect <file>- inspect Assignment Events, diagnostics, and optional annotationsaeon finalize <file>- materialize AEON into JSON, map, header, or full viewsaeon bind <file>- run the typed runtime binding pipeline with a schemaaeon integrity validate|verify|sign <file>- work with integrity envelopes
Common Options
--json- emit machine-readable JSON where supported--annotations- include annotation stream records--annotations-only- inspect only annotation stream records--sort-annotations- sort annotations deterministically--scope payload|header|full- choose finalization scope--projectedand--include-path <path>- materialize selected canonical paths--recovery- emit partial tooling output while still reporting errors--max-input-bytes <n>- fail closed on oversized UTF-8 input--datatype-policy reserved_only|allow_custom- control custom datatype acceptance--rich- shortcut for--datatype-policy allow_custom
Exit Codes
0- no errors1- AEON diagnostics or validation errors were present2- CLI usage error, missing file, bad option, or unreadable input
Output Contract
The CLI is designed for stable automation. Its observable command behavior is
tracked in OUTPUT_CONTRACT.md.
Notes
- The default processing path is fail-closed.
--recoveryis intended for editors and diagnostics, not production loading.- The CLI does not execute AEON documents or coerce values into application semantics.
