readme:generate
Generate Scribe managed README block.
Syntax#
vigil readme:generate [--dry-run] [--path README.md] [--json]
Options#
| Flag | Description |
|---|
--json | Emit the versioned JSON envelope. |
--dry-run | Command option declared by the pack contract. |
--path | Choose the README path. |
Examples#
vigil readme:generate --dry-run
vigil readme:generate
Example Use Cases#
- Use this command when you need to generate Scribe managed README block.
- Preview or review the operation before allowing repository changes.
Technical Contract#
| Binding | builtin:readme:generate |
|---|
| Stability | stable |
|---|
| Timeout | 10m0s |
|---|
| Required tools | None |
|---|
| Capabilities | filesystem:read, process, git:read, filesystem:write |
|---|
| Output formats | text, json |
|---|