Hal docs for reviewable coding loops

Install

Use the current website install command, then open the GitHub README if you need repository-specific setup details before running it in a project.

brew tap j-yw/tap && brew install --cask hal

Read the install guide for verification steps, engine prerequisites, and a safe repository setup.

First loop

Your first Hal loop should be boring on purpose. Pick a bounded change with clear acceptance criteria so you can inspect the plan, the changed files, and the final state in one sitting.

hal init
hal plan "add a small settings page with one saved preference"
hal convert
hal validate
hal run

What each command does

• hal init creates the local workflow structure for a repo.
• hal plan turns product intent into a PRD or structured requirements before the agent touches code.
• hal convert turns markdown requirements into runtime state.
• hal validate checks that stories are specific enough for the loop.
• hal run executes implementation iterations with the configured agent engine.

Review checklist

Before merging agent output, inspect the changed files, commits, reports, tests, and unresolved acceptance criteria. Hal structures the loop; the developer still owns acceptance.

Use the review-before-merge checklist before accepting any generated code.