Guides · Checks

Checks

Declare the quick checks in .rei/config.json and run them with rei check or rei test.

Quick checks · exit code 0/1

When to use it

Use this guide when you want rei check to run your project's quick verifications —lint, logic tests, type-check— and give you a single result before implementing or requesting a review.

Requirements

  • A project initialized with .rei/config.json.
  • The quick checkpoints defined in .rei/docs/project/verification.md.
  • The commands available on the project's PATH.
  • No slow checks: the full build, e2e or integration do not go in the configuration.

Steps

  1. Identify the quick checkpoints in verification.md and their stable identifier, for example V1 or V4.
  2. Declare each one in checks inside .rei/config.json with id, description and command. The command is an array of arguments and runs without an intermediate shell.
  3. Run rei check to verify the harness and run the declared checks. Add --quiet if you want to omit the [OK] lines and the summary.
  4. Run rei test when you only want the checks from .rei/config.json, without the rest of the harness checks.
  5. If a check fails, fix the cause and run it again before requesting a review.
.rei/config.json
{
  "checks": [
    {
      "id": "V1",
      "description": "ESLint del proyecto",
      "command": ["pnpm", "lint"]
    },
    {
      "id": "V4",
      "description": "Tests de lógica y datos",
      "command": ["pnpm", "test"]
    }
  ]
}
Running
rei check
rei check --quiet
rei test

Verification

ResultCodeWhat it means
Everything passes0The declared checks finished with no failures.
Some failure1There is at least one [FAIL] or a project check failed.
No checks0rei test reports that no checks are configured.

Fix the failure and repeat the command. Do not request a review with a red check, and do not disable it to make it pass: the exit code is the signal the workflow uses.

Limits

  • Slow checkpoints, such as the production build, are documented in verification.md and run when the Work Item is closed.
  • rei check runs commands without an intermediate shell: it does not interpret redirections, pipes or shell variables.
  • The configuration does not replace verification.md and does not justify checks that prove nothing.
  • A check that takes too long is not added to the configuration: it turns daily verification into waiting.

Next step

With the checks green, the Work Item can go to review. If you want to update the harness or the binary, the update guide explains the order.

Planning approval

Pending

A human sign-off releases the sheet. Silence is not approval.

Approval is recorded from the CLI; the viewer does not replace it.