readme:check
Check Scribe managed README block freshness.
Syntax#
vigil readme:check [--json]
Options#
| Flag | Description |
|---|
--json | Emit the versioned JSON envelope. |
--path | Choose the README path. |
Examples#
vigil readme:check [--json]
vigil readme:check --json
Example Use Cases#
- Use this command when you need to check Scribe managed README block freshness.
- Run it in local checks, scripts, or CI when read-only evidence is needed.
Technical Contract#
| Binding | builtin:readme:check |
|---|
| Stability | stable |
|---|
| Timeout | 10m0s |
|---|
| Required tools | None |
|---|
| Capabilities | filesystem:read, process, git:read |
|---|
| Output formats | text, json |
|---|