adameddahmouni/Agent-Ready
Validate, inspect, generate, check, analyze, schema, doctor, explain, init, upgrade, and verify a repository's agent-ready.yaml contract, using this repository's own CLI built from source. See docs/specification/ci-integration.md.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| command | The agent-ready subcommand to run: validate, inspect, generate, check, analyze, schema, doctor, explain, init, upgrade, or verify. | yes | — |
| config | Explicit path to the contract file (agent-ready.yaml). | no | — |
| code | (explain) Diagnostic code to explain. | no | — |
| json | Print machine-readable JSON output instead of human-readable text. | no | false |
| write | (generate/init/upgrade) Write planned files to disk. | no | false |
| check | (generate) Exit non-zero if generated output would differ from what's on disk. Never writes. | no | false |
| force | (generate --write) Overwrite existing files that lack the managed-file marker. | no | false |
| staged | (check) Check staged changes instead of the full working tree. | no | false |
| against | (check) Check changes relative to this explicit Git ref instead of HEAD. | no | — |
| execute | (verify) Actually run the contract's verification.required commands. Without this, verify only prints the plan. | no | false |
| timeout | (verify --execute) Per-command timeout in seconds (default: 900). | no | — |
| record | (verify --execute) Write a JSON evidence file (agent-ready-verify-result.json) to the repository root. | no | false |
| node-version | Node.js version to build and run Agent-Ready with. | no | 22 |
Outputs
no outputs