From e56156be74acaea7119b3f599cf62435054924b8 Mon Sep 17 00:00:00 2001 From: hyperpolymath <6759885+hyperpolymath@users.noreply.github.com> Date: Wed, 20 May 2026 08:47:43 +0100 Subject: [PATCH] docs(readme): list iseriser CLI subcommands incl. abi-verify + abi-emit-manifest README's "Usage" section described the five-command interface shared by *generated* -isers (init/validate/generate/build/run). It did NOT list iseriser's own subcommands, including the two new ones added in #13 (`abi-verify`) and #14 (`abi-emit-manifest`). Adds a table under "Using Iseriser" with all 7 current subcommands + a one-line description each + a pointer to `examples/abi-manifests/README.adoc` for the abi-* pair's full schema + drift taxonomy. Pure docs. Refs hyperpolymath/standards#92 Co-Authored-By: Claude Opus 4.7 (1M context) --- README.adoc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.adoc b/README.adoc index 76edfc7..0f78b50 100644 --- a/README.adoc +++ b/README.adoc @@ -319,6 +319,27 @@ cargo test # tests pass immediately cargo run -- init ---- +=== Iseriser CLI subcommands + +In addition to scaffolding new -isers, iseriser itself ships with: + +[cols="1,3"] +|=== +| `init` | Initialise an `iseriser.toml` manifest in the current directory. +| `validate` | Structural + semantic validation of an `iseriser.toml`. +| `generate` | Scaffold a complete -iser repo from the manifest. +| `info` | Print a summary of a manifest. +| `scan` | Walk a repository and recommend applicable -iser tools. +| `abi-verify` | (Phase 1) Diff a cartridge's Zig FFI against its Idris2-derived ABI manifest; exit 0=clean, 2=drift. See `examples/abi-manifests/README.adoc` for the drift taxonomy. +| `abi-emit-manifest` | (Phase 1b) Emit the ABI manifest JSON from a cartridge's `Safe*.idr` source. The Idris2 source is the single authority — manifest is derived, not hand-authored. Combine with `abi-verify` to gate Zig FFI drift in CI. +|=== + +The `abi-*` pair implements +https://github.com/hyperpolymath/standards/issues/92[standards#92] +(Phase 1 + 1b); see +`examples/abi-manifests/README.adoc` for the schema, the drift +taxonomy, and end-to-end usage. + == Generated Repo Structure When iseriser generates a new -iser, it produces: