Skip to content

memhtml agents-doc

1. Synopsis

Regenerate AGENTS.md from this command table. --check fails on drift.

Terminal window
memhtml agents-doc [options]

2. Arguments

This command takes no positional arguments.

3. Flags

Flag Type Default Values Description
--check flag false no fixed set Compare the committed doc to the regenerated one and fail on a difference.
--out string no default no fixed set Where to write. Defaults to ./AGENTS.md.

Every command also accepts the global flags.

4. Response

On success the command writes one JSON envelope to stdout, and its type is agents.doc.

On failure it writes the failure envelope, whose code comes from error codes.

The JSON envelope gives the fields both shapes carry. Response types lists every value type takes across the binary.

5. Further reading

No guide block names this command. The guide is the workflow prose the CLI ships beside the command table: which command to reach for, and in what order.

6. Provenance

A loader generates this page from apps/cli/src/commands.ts while the site builds, so no file in the repository holds it: the COMMANDS array there is the one source of argument parsing, of memhtml manifest, and of AGENTS.md. Change the registry and this page changes with it.