mix hieroglyph.manifest (hieroglyph v1.7.0)

Copy Markdown View Source

Generates a static api_manifest.json from the library's descripex annotations.

The manifest is a JSON-serializable representation of every public function in the library — params, return types, errors, specs, and descriptions. Suitable for downstream codegen (cartouche-generated contract bindings), agent discovery, validators, and CI contract-stability diffs across hieroglyph version bumps.

mix hieroglyph.manifest
mix hieroglyph.manifest path/to/output.json
mix hieroglyph.manifest --check
mix hieroglyph.manifest --check path/to/output.json

--check regenerates the manifest in memory and compares it against the committed file, ignoring only generated_at. Exits non-zero with a readable diff when they differ. Wired into mix ci so a descripex upgrade or an api() edit cannot silently drift the artifact.

Uses ABI.__descripex_modules__/0 as the single source of truth for which modules to include. Output defaults to api_manifest.json in the project root.