Skip to main content

Introduction

ratchet is an AI-native CLI for spec-driven development. A change is described by executable Gherkin features and an implementation plan, then implemented against those features and verified before it is archived. Each scenario is re-checked by a scored eval suite, so behavior that has been verified cannot silently regress.

This site renders the reference documentation kept in the repository's docs/ directory. Reference entries describe ratchet's machinery — its CLI commands, flags, configuration keys, generated artifacts, and behavior — so it can be looked up without reading the source.

Install​

ratchet is published to npm as ratchet-ai (the installed command is ratchet). Run it without a global install:

npx ratchet-ai@beta init

init configures the project for a coding agent; pass --tools to select one non-interactively, or answer the prompt. ratchet is currently a beta prerelease, so the @beta tag is required.

Where to start​

  • Commands — what each ratchet command does and the flags it accepts.
  • Engine API — the bundled, in-process engine that advances change work and spawns coding agents through the SWE-ReX agent runtime.
  • Configuration — the .ratchet/config.yaml keys ratchet reads and the artifacts it generates.

More reference content is published here as it is added under docs/.