Check a Repository
Run Validation against a discovered or explicit Repository Root, interpret complete and incomplete Check Reports, and follow recovery guidance.
Use this guide when you need to validate repository documentation or integrate a Check into automation.
Choose the Repository Root
Run from inside the target repository to use nearest-ancestor discovery. Use --root <path> when the invocation should name one explicit Repository Root. Relative paths resolve from the current directory, and an invalid explicit root never falls back to an ancestor.
Run the Check
Run Validation against the discovered Repository Root.
presswork checkFor automation that names the boundary, pass the Repository Root explicitly.
presswork check --root /path/to/repositoryUse --json when the consumer needs one machine-readable Check Report object followed by a newline. Use --no-color when human output must not contain ANSI decoration.
Interpret the outcome
| Exit | Report state | Next action |
|---|---|---|
0 |
Complete, with no Violations. | No report recovery is required. |
1 |
Complete, with one or more Violations. | Change each identified source according to its recovery guidance. |
2 |
Incomplete, with Operational Diagnostics. | Restore each named resource or operation according to its recovery field. |
After applying the reported recovery actions, rerun the same Check command. The recovery is complete when the report has complete: true, violations: [], and operationalDiagnostics: [].
Use Check Report for fields and ordering, Rules and diagnostics for identifiers, or Presswork Configuration to change repository policy.