Get started
Getting started

Set it up

Add Cue to a project in about five minutes.

Before you start

You need Node.js version 22 or newer. To check:

node --version

That’s it. Cue works with npm, pnpm, yarn and bun, and figures out which one you use on its own.

Run it

From the folder your tests live in — or will live in:

npx @wiluszdamian/cue init

It will:

  1. Look for AI assistants you already use, like Claude Code or Cursor.
  2. Show you a list of every file it wants to create, and why.
  3. Wait. Nothing is written until you say yes.

If a file already exists and you’ve changed it, Cue leaves it alone and tells you. It never overwrites your work.

What you get

File or folderWhat it’s for
AGENTS.mdThe house rules, in a file every AI assistant reads automatically
eslint.config.mjsTurns the rules into checks that actually run
playwright.config.tsSensible settings for running tests
tests/, pages/, fixtures/Where things go, with a working example of each
.agent-kb/Where knowledge about your app will be stored

Already have a test suite and just want the rules? Use --bare and Cue will skip the folder layout.

npx @wiluszdamian/cue init --bare

Finish the setup

init prints the remaining steps, written for whichever package manager you use. Usually:

npm install --save-dev @wiluszdamian/cue-eslint-plugin @wiluszdamian/cue
npx playwright install

Then check everything landed:

npx @wiluszdamian/cue doctor

Reading the doctor report

doctor lists everything it checked, one line each:

What you seeWhat it means
okWorking.
warnWorth knowing, not urgent. Some warnings are permanent and fine.
errorSomething isn’t working. Fix these.
?Couldn’t check — usually you’re offline. Not a pass and not a fail.

Every problem comes with the exact command that fixes it. If a line doesn’t tell you what to run, that’s a bug in Cue — please report it.

Next