cairn-dev
v0.1.1
Published
Run Cairn locally against any repo — no clone. `npx cairn-dev dev`.
Maintainers
Readme
cairn-dev — run Cairn locally, no clone
export GOOGLE_GENERATIVE_AI_API_KEY=AIza... # your Gemini key
npx cairn-dev dev --target http://localhost:3000Maps your repo's user flows, generates Playwright tests, and runs them against
your local dev server — no GitHub, no login, no cloud. Opens a local
dashboard at http://localhost:3000/local.
What it does
npx cairn-dev dev pulls the published cairn-web + cairn-worker images and
runs the whole stack with Docker Compose:
- Postgres (a throwaway DB), schema applied + local repo seeded automatically
- worker (the runner) + a keyless inngest dev server
- web (the dashboard) on
--port
Your repo is bind-mounted in (so Cairn reads its source), and your app under test
— running on the host — is reached via host.docker.internal.
Options
| Flag | Meaning | Default |
| ---------- | ------------------------------- | ----------------------- |
| --path | the repo to map | current directory |
| --target | your running dev server to test | http://localhost:3000 |
| --port | the local dashboard port | 3000 |
Requirements
- Docker running (Docker Desktop or an engine).
- Node 18+ (for
npx). - A Gemini key for mapping + test generation — supply it any of three ways:
--google-key AIza…, theGOOGLE_GENERATIVE_AI_API_KEYenv var, or a.env/.env.localfile in the folder you run it from. Only that one key is read from.env— your other variables are ignored, never logged, and never passed to the containers or the model. - Your app running on the
--targetport.
Ctrl+C stops the whole stack.
Contributors working inside a Cairn checkout can instead use
pnpm cairn dev(runs from source, no images). This package is the no-clone path for everyone else.
