Quick Start

Go from zero to a fully configured testing environment in under 2 minutes.

1. Install NoFlake

npm install -D noflake

2. Initialize your project

npx noflake init --hook

This will:

  • Create a .noflake/ state directory
  • Generate a .noflakerc.json config file
  • Set up tests/e2e/ directory
  • Create a playwright.config.tsif you don't have one
  • Install a post-commit git hook (with --hook flag)

3. Install Playwright browsers

If this is your first time with Playwright:

npx playwright install

4. Generate your test suite

npx noflake write

NoFlake 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