Quick Start
Go from zero to a fully configured testing environment in under 2 minutes.
1. Install NoFlake
npm install -D noflake2. Initialize your project
npx noflake init --hookThis will:
- Create a
.noflake/state directory - Generate a
.noflakerc.jsonconfig file - Set up
tests/e2e/directory - Create a
playwright.config.tsif you don't have one - Install a post-commit git hook (with
--hookflag)
3. Install Playwright browsers
If this is your first time with Playwright:
npx playwright install4. Generate your test suite
npx noflake writeNoFlake scans your codebase, generates Playwright E2E tests, runs them, and self-heals any failures. Tests are written to tests/e2e/ ā your source code is never modified.
š Safe by design: NoFlake only writes to
tests/e2e/ and .noflake/. Your application source code (src/, app/, pages/) is read-only input ā never modified.Subscription required: The
write command uses AI and requires a Starter ($9/mo) tier or above. The Free tier includes init, templates, git hooks, and the dashboard.Project structure after init
your-project/
āāā .noflake/
ā āāā manifest.md # Test manifest (created on first write)
ā āāā manifest.json # Machine-readable manifest
ā āāā test-plan.md # AI-generated test plan
ā āāā coverage-map.md # Route coverage tracking
ā āāā run-history.md # Pass/fail history
āāā tests/
ā āāā e2e/ # Your test files go here
āāā .noflakerc.json # NoFlake configuration
āāā playwright.config.ts # Playwright configuration