brunch
v5.0.1
Published
AI chat interface built on HASH
Downloads
32,114
Readme
The
brunchnpm package name was previously used by a different project, a web app build tool: https://github.com/brunch/brunch From version5.0.0onwards, it is used by a new, entirely new project, an AI-guided spec elicitation tool: https://github.com/hashintel/brunch The two projects are completely unrelated.4.0.2is the latest and last version of the web app build tool.
The new project is under development and is immature. We do not yet recommend using it. It starts at version
5.0.0to avoid confusion with the old project, rather than because of its maturity.
Brunch
Brunch is an AI-guided spec elicitation tool that turns a rough project idea into a structured specification through a multi-phase interview. It runs locally, keeps workspace state in a project-scoped SQLite database, and opens a browser UI for working through grounding, design, requirements, and acceptance criteria.
Run Brunch
Brunch requires Node 22+ and an Anthropic API key.
Create a .env file in the project directory where you want to use Brunch:
echo "ANTHROPIC_API_KEY=sk-ant-..." > .envThen launch it in that directory:
npx brunchBrunch will create or reuse the local .brunch/ workspace for that project, start the web UI, and open it in your browser.
If you prefer a global install:
npm install -g brunch
brunchEnvironment Variables
| Variable | Required | Description |
|---|---|---|
| ANTHROPIC_API_KEY | Yes | Anthropic API key |
| ANTHROPIC_MODEL | No | Interviewer model override |
| OBSERVER_MODEL | No | Observer model override |
| BRUNCH_PORT | No | Port for the local web server |
Help
npx brunch --helpFor Contributors
Development setup, architecture notes, fixture workflows, release steps, and internal planning docs live in CONTRIBUTING.md.
