Skip to content

Commit 84f9e31

Browse files
docs(readme): list iseriser CLI subcommands incl. abi-verify + abi-emit-manifest (#16)
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) <noreply@anthropic.com>
1 parent 570d337 commit 84f9e31

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,27 @@ cargo test # tests pass immediately
319319
cargo run -- init
320320
----
321321

322+
=== Iseriser CLI subcommands
323+
324+
In addition to scaffolding new -isers, iseriser itself ships with:
325+
326+
[cols="1,3"]
327+
|===
328+
| `init` | Initialise an `iseriser.toml` manifest in the current directory.
329+
| `validate` | Structural + semantic validation of an `iseriser.toml`.
330+
| `generate` | Scaffold a complete -iser repo from the manifest.
331+
| `info` | Print a summary of a manifest.
332+
| `scan` | Walk a repository and recommend applicable -iser tools.
333+
| `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.
334+
| `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.
335+
|===
336+
337+
The `abi-*` pair implements
338+
https://github.com/hyperpolymath/standards/issues/92[standards#92]
339+
(Phase 1 + 1b); see
340+
`examples/abi-manifests/README.adoc` for the schema, the drift
341+
taxonomy, and end-to-end usage.
342+
322343
== Generated Repo Structure
323344

324345
When iseriser generates a new -iser, it produces:

0 commit comments

Comments
 (0)