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. You're done!

Your project is now set up and ready for NoFlake. Your testing environment is configured with sensible defaults.

What's next?When v1.0 ships, you'll be able to run npx noflake write to auto-generate your full E2E test suite. For now, you can write Playwright tests manually in tests/e2e/ and run them with npx playwright test.

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