Install

What you need

• Node 20 or newer. Check with node -v. There is no build step and no bundler: the whole thing is CommonJS that Node runs directly.
• About 400 MB of disk, most of it the Chromium that Playwright downloads.
• A model API key, eventually. Not for the first run. Six of the eight checks never need one.

Install it, in order

1. Install the dependencies

   npm install

   Fetches the Playwright library. It does not fetch the browser that library drives. That is the next step, and it is the one people skip.

2. Install the browser

   npx playwright install chromium

   Separate on purpose, and the single most common thing to miss. Without it every check that touches a page fails at launch with a message about a missing executable.

3. Point it at your product

   node cli.cjs init

   A short wizard: the product’s name and URL, what it is and who it is for, its key pages, its competitors, where the code lives, an optional test account and an optional API key. It writes a product profile and, if you gave one, a key file with owner-only permissions.

   Both files stay on the machine. There is no account to create and nothing is uploaded. What the profile holds, and why each answer matters is its own page: the answers change what every later run pays attention to.

4. Check the setup before you spend anything

   node cli.cjs doctor

   One browser pass, no model calls. It loads every surface in the profile, checks each lands where it claims, tries the sign-in recipe if there is one, and resolves the file mappings. It exits non-zero when something is broken, so it is safe to put in front of anything else.

5. Open the console, or go straight to a free run

   node cli.cjs ui

   The dashboard, on localhost. Or skip it entirely and run one of the six checks that never need a key:

   node cli.cjs vitals