zerocheck 0.2.0 → 0.2.2

package/README.md

@@ -1,57 +1,58 @@
 # Zerocheck
 
-**Repeatable browser tests from your release checklist**
+Zerocheck is an AI QA engineer that tests your app end to end. Verify critical flows and find bugs with a prompt.
 
-Zerocheck turns your team's manual release checklist into saved end-to-end browser tests. Start with the important user journeys, review the test definitions and browser results, and rerun the checks as your app changes.
+This is the Zerocheck CLI.
 
-This is the Zerocheck CLI. Use it to run your repository tests in a browser on your laptop or in CI.
-
-**New to Zerocheck? [Request pilot access](https://tryzerocheck.com/demo/).** We provision a customer instance and help you configure your first handful of tests during hands-on onboarding.
-
-**Already onboarded?** [Run your saved tests](#run-your-saved-tests), or open the instance URL supplied during onboarding to use the web app.
-
-## How it works
-
-Your Zerocheck instance makes every decision: it reads each test, chooses each browser action, checks each expected outcome and keeps the results. This CLI drives a Chromium browser on your machine for the instance and keeps your test secrets on your machine.
-
-## Before you start
-
-Test execution requires a Zerocheck account, a provisioned customer instance and a project in that instance. **There is no default public service.**
-
-Have these ready:
+```yaml
+# zerocheck/tests/discount-code.yaml
+version: zerocheck/v1
+name: Discount code reaches confirmation
+blocks_merge: true
+steps:
+  - Navigate to /cart
+  - Enter "SPRING20" into "Discount code"
+  - Click "Apply"
+  - Verify text "Discount applied" is visible
+  - Enter "4242424242424242" into "Card number"
+  - Click "Place order"
+  - Verify text "Order confirmed" is visible
+```
 
-- **Node.js 20.19 or newer.**
-- **Your instance URL** and account access, supplied during onboarding.
-- **Your project files:** `zerocheck.yaml` with the correct project, environment and app URL, plus at least one saved YAML test in its configured test directory. We set up these files with you during onboarding.
-- **A running app** reachable from your machine, with the test accounts and credential variables your tests need.
+The CLI runs YAML tests like this one in a Chromium browser on your machine or a CI runner. Your dedicated Zerocheck instance reads each test, makes the model calls and keeps the results. The CLI drives the browser for it and keeps your test secret values on your machine.
 
-## Run your saved tests
+## Quick start
 
-Run from the app repository containing the project files above. Replace the instance URL with the one you received during onboarding.
+Zerocheck needs a dedicated instance, which we set up with you during [hands-on onboarding](https://tryzerocheck.com/onboarding/). There is no default public service. You'll also need Node.js 20.19 or newer, `zerocheck.yaml` and at least one saved test. We set those up with you too.
 
 ```bash
-npm install --save-dev --save-exact zerocheck@0.2.0
+npm install --save-dev --save-exact zerocheck
 npx playwright install chromium
 export ZEROCHECK_API="https://your-instance.example.com"
 npx zerocheck login
-npx zerocheck run --json .zerocheck/latest-run.json
+npx zerocheck run
 ```
 
-`playwright install chromium` downloads the browser that the CLI drives. `login` prints a URL and a code for you to approve in your browser; `whoami` shows the instance and project you are signed in to, and `logout` signs this machine out. In CI, set `ZEROCHECK_API` and a project token from Settings as `ZEROCHECK_TOKEN` instead of signing in.
+`login` prints a URL and a code for you to approve in your browser. `run` executes the tests in your configured test directory and prints each result with a link to the run. Open it to see the steps and screenshots, and the recording of each test that uses no configured secrets. To run one test, use its path: `npx zerocheck run zerocheck/tests/discount-code.yaml`.
 
-`run` executes the saved tests in the configured test directory, using `default_environment` from `zerocheck.yaml`. Confirm that environment points to the app you intend to test. It prints each test's result and a results link; open it to inspect the steps, screenshots and recordings after signing in. `--json` also writes the run record to a file.
+In CI, set `ZEROCHECK_API` and a project token from Settings as `ZEROCHECK_TOKEN` instead of signing in.
 
-To run just one test, use its actual repository path:
+## Commands
 
-```bash
-npx zerocheck run zerocheck/tests/your-test.yaml
-```
+| Command | What it does |
+| --- | --- |
+| `login` | Sign in and authorize this device for a project |
+| `logout` | Revoke this device login and clear its local token |
+| `whoami` | Show the instance and project you're signed in to |
+| `run [paths...]` | Run tests in your browser |
+
+`run` options: `--env <name>`, `--json <path>`, `--fail-on-flaky`, `--headed` and `--project-dir <dir>`.
 
-Options: `--env <name>` chooses another environment from `zerocheck.yaml`, `--headed` shows the browser, `--fail-on-flaky` fails a test that passed only after a retry, and `--project-dir <dir>` runs a project in another folder.
+Exit codes: **0** every blocking test passed. **1** a blocking test failed, or with `--fail-on-flaky` passed only after a retry. **2** the run gave no verdict.
 
-## Test secrets stay on your machine
+## Test secrets
 
-Reference each secret in `zerocheck.yaml` as an environment variable and set that variable where the CLI runs:
+Reference each secret in `zerocheck.yaml` as an environment variable, and set that variable where the CLI runs:
 
 ```yaml
 environments:
@@ -63,38 +64,12 @@ environments:
       - Enter "{{credential:PASSWORD}}" into "Password"
 ```
 
-The CLI sends the instance each secret's name, never its value, and types the value itself only where the test refers to it. A missing variable stops the run before it starts. A test or login step that writes out a configured secret value is refused before anything is sent: use a reference instead. Runs that use secrets are not recorded on video.
-
-The instance receives the selected test files, the environment's settings without secret values, and what the browser shows while the tests run: page snapshots, screenshots, recordings and console messages.
-
-## What a test looks like
-
-Each repository test is a readable YAML file. Adapt this example to a route and outcome that exist in your app:
-
-```yaml
-version: zerocheck/v1
-name: Release notes are available
-blocks_merge: true
-steps:
-  - Navigate to /releases
-  - Verify the Release notes heading is visible
-```
-
-To bring a test you made in the web app into your repository, use **Download YAML** and put that file in the configured test directory. This creates an independent copy.
-
-## When a run needs attention
+Your instance receives each secret's name, never its value. It does receive the selected test files and what the browser shows while tests run, so the CLI needs network access and doesn't run offline.
 
-| Situation | Next step |
-| --- | --- |
-| No instance configured | Set `ZEROCHECK_API` to your customer instance before signing in. |
-| No configuration or tests found | Add the project configuration and saved YAML tests. |
-| Missing test secrets | Set the environment variables your configured environment references. |
-| A test fails or cannot complete | Open the results link and inspect the failed step and its evidence. |
-| Your instance is running as many runs as it allows | Try again shortly. |
-| The run is not finished on your instance | Run `zerocheck run` again in the same folder: it finishes the earlier run first, then runs the tests you asked for. |
+## Web app or CLI
 
-Press Ctrl-C once to cancel a run: the browser closes and your instance is told. A cancelled run never resumes. If the instance could not be told, or you pressed Ctrl-C again to stop waiting, the next `run` in the same folder tells it first. The CLI keeps this state in a `.zerocheck` folder in your project, which it excludes from Git.
+Tests you create in the web app run there in a hosted browser, with nothing to install. To bring one into your repository, use **Download YAML** and put the file in your test directory. That is an independent copy: editing, renaming or deleting the file, or running it with the CLI, never changes the test in the web app. To update the web copy from a file, use **Upload YAML** in the web app; a file downloaded from there replaces its test only after you confirm.
 
-Exit codes: **0** means every blocking test passed; **1** means a blocking test failed, or with `--fail-on-flaky` passed only after a retry; **2** means the run could not give a verdict: a setup or secret problem, a refused start, a cancellation, or a run that could not finish.
+## Documentation
 
-[Request pilot access](https://tryzerocheck.com/demo/) · [Developer resources](https://tryzerocheck.com/developers/) · [CLI guide](https://tryzerocheck.com/cli/) · [Web app guide](https://tryzerocheck.com/docs/web-app/) · [Results](https://tryzerocheck.com/docs/results/)
+[CLI guide](https://tryzerocheck.com/docs/cli/) · [Web app](https://tryzerocheck.com/docs/web-app/) · [Run in CI](https://tryzerocheck.com/docs/github-actions/) · [Credentials and data](https://tryzerocheck.com/docs/security/) · [Pricing](https://tryzerocheck.com/pricing/)

package/dist/index.js

@@ -4862,12 +4862,49 @@ async function installNavigationGuard(page, options) {
 }
 
 // ../../src/agent/browser-session.ts
+var RECORDING_FRAME_INTERVAL_MS = 1e3;
+function keepRecordingCurrent(page, intervalMs = RECORDING_FRAME_INTERVAL_MS) {
+  let client, pending = false, stopped = false;
+  const capture = async () => {
+    if (!client) {
+      const created = await page.context().newCDPSession(page);
+      if (stopped) {
+        await created.detach().catch(() => {
+        });
+        return;
+      }
+      client = created;
+    }
+    await client.send("Page.captureScreenshot", { format: "jpeg", quality: 1 });
+  };
+  const timer = setInterval(() => {
+    if (pending || stopped) return;
+    pending = true;
+    void capture().catch(() => {
+    }).finally(() => {
+      pending = false;
+    });
+  }, intervalMs);
+  timer.unref?.();
+  const stop = () => {
+    if (stopped) return;
+    stopped = true;
+    clearInterval(timer);
+    page.off("close", stop);
+    void client?.detach().catch(() => {
+    });
+  };
+  page.once("close", stop);
+  return stop;
+}
 var BrowserSession = class {
   context;
   page;
   releaseGuard;
   console = new ConsoleRecorder();
   stage = "new";
+  recording = false;
+  stopRecordingFrames;
   /** The latest refusal and guard failure, kept so a lost message cannot hide them. */
   denied;
   failure;
@@ -4914,6 +4951,7 @@ var BrowserSession = class {
     const video = options.recordVideo && !env.secrets.length;
     await this.setup("new", "opening", "context", async () => {
       this.context = await env.browser.newContext({ viewport, ...video ? { recordVideo: { dir: env.videoDir, size: viewport } } : {}, ...env.allowRequest ? { serviceWorkers: "block" } : {} });
+      this.recording = video;
     });
   }
   async prepareContext(defaultTimeoutMs) {
@@ -4988,12 +5026,14 @@ var BrowserSession = class {
       });
     });
     this.console.attach(page);
+    if (this.recording) this.stopRecordingFrames = keepRecordingCurrent(page);
   }
   drainConsole() {
     return redactConsoleLogs(this.console.drain(), this.env.secrets);
   }
   async closeContext() {
     this.stage = "closed";
+    this.stopRecordingFrames?.();
     this.console.dispose();
     await this.context?.close();
   }
@@ -6413,7 +6453,7 @@ function unlinkQuietly(path) {
 }
 
 // package.json
-var version = "0.2.0";
+var version = "0.2.2";
 
 // src/index.ts
 var program = new Command().name("zerocheck").version(version).description("Run Zerocheck browser tests on your own machine.").exitOverride();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zerocheck",
-  "version": "0.2.0",
-  "description": "Turn release checklists into repeatable browser tests. Run with the Zerocheck CLI, CI or web app and inspect the evidence.",
+  "version": "0.2.2",
+  "description": "Zerocheck is an AI QA engineer that tests your app end to end. Run saved YAML tests with the CLI, on your machine or in CI.",
   "keywords": [
     "qa-agent",
     "ai-testing",