@thepixelhouse/cli 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,249 @@
+# @thepixelhouse/cli
+
+Visual regression testing from the command line. Capture screenshots, diff them against baselines, run regression suites, and manage monitors — all from your terminal or CI pipeline.
+
+## Install
+
+```bash
+npm install -g @thepixelhouse/cli
+```
+
+Or run without installing:
+
+```bash
+npx @thepixelhouse/cli screenshot https://example.com
+```
+
+## Quick start
+
+```bash
+# 1. Create a config file
+pixelhouse init
+
+# 2. Set your API key
+export PIXELHOUSE_API_KEY=ph_live_your_key_here
+
+# 3. Capture your first screenshot
+pixelhouse screenshot https://your-site.com --project prj_xxx
+
+# 4. Promote it to a baseline
+pixelhouse baseline create ss_abc123 --project prj_xxx --url https://your-site.com
+
+# 5. Run a regression test
+pixelhouse regression run --url https://your-site.com --baseline bl_xyz789
+```
+
+## Authentication
+
+The CLI needs an API key. Provide it in any of these ways (highest priority first):
+
+1. **CLI flag:** `--api-key ph_live_xxx`
+2. **Environment variable:** `PIXELHOUSE_API_KEY=ph_live_xxx`
+3. **Config file:** `apiKey` field in `.pixelhouserc.json`
+
+Get your API key from the [dashboard](https://thepixelhouse.co.uk/settings/api-keys).
+
+## Commands
+
+### `pixelhouse screenshot <url>`
+
+Capture a screenshot of a URL.
+
+```bash
+pixelhouse screenshot https://example.com
+pixelhouse screenshot https://example.com --viewport mobile
+pixelhouse screenshot https://example.com --viewport 1440x900 --full-page
+pixelhouse screenshot https://example.com --output ./screenshot.png
+```
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--viewport <preset\|WxH>` | Viewport size (desktop, tablet, mobile, or custom) | `desktop` |
+| `--full-page` | Capture the full scrollable page | `false` |
+| `--project <id>` | Project ID | from config |
+| `--output <path>` | Save PNG to a local file | - |
+| `--wait-for <strategy>` | Load strategy (networkIdle, domContentLoaded, load) | `networkIdle` |
+
+### `pixelhouse compare <screenshot-a> <screenshot-b>`
+
+Compare two screenshots for visual differences.
+
+```bash
+pixelhouse compare ss_abc123 ss_def456
+pixelhouse compare ss_abc123 ss_def456 --threshold 0.5 --output ./diff.png
+```
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--threshold <number>` | Diff threshold percentage (0-100) | `1.0` |
+| `--output <path>` | Save diff image to a local file | - |
+
+### `pixelhouse regression run`
+
+Run visual regression tests against baselines.
+
+**Single URL mode:**
+
+```bash
+pixelhouse regression run --url https://example.com --baseline bl_xyz789
+```
+
+**Config-driven mode** (reads pages from `.pixelhouserc.json`):
+
+```bash
+pixelhouse regression run
+pixelhouse regression run --ci
+pixelhouse regression run --fail-on-diff
+```
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--url <url>` | Single URL to test | - |
+| `--baseline <id>` | Baseline ID to compare against | - |
+| `--threshold <number>` | Diff threshold percentage | `1.0` |
+| `--viewport <preset\|WxH>` | Viewport size | `desktop` |
+| `--ci` | CI mode with exit codes | `false` |
+| `--fail-on-diff` | Non-zero exit on any diff exceeding threshold | `false` |
+
+**Exit codes (CI mode):**
+- `0` — all tests passed
+- `1` — visual regression detected
+- `2` — error (capture failed, network error, etc.)
+
+### `pixelhouse baseline <subcommand>`
+
+Manage screenshot baselines.
+
+```bash
+# List baselines
+pixelhouse baseline list --project prj_xxx
+pixelhouse baseline list --project prj_xxx --branch staging
+
+# Promote a screenshot to baseline
+pixelhouse baseline create ss_abc123 --project prj_xxx --url https://example.com
+pixelhouse baseline create ss_abc123 --project prj_xxx --url https://example.com --branch staging
+
+# Delete a baseline
+pixelhouse baseline delete bl_xyz789
+```
+
+### `pixelhouse monitor <subcommand>`
+
+Manage scheduled visual monitors.
+
+```bash
+# List monitors
+pixelhouse monitor list --project prj_xxx
+
+# Add a monitor (checks every hour)
+pixelhouse monitor add https://example.com --project prj_xxx --every 1h
+
+# Add with custom interval and threshold
+pixelhouse monitor add https://example.com --project prj_xxx --every 30m --threshold 0.5
+
+# Pause / resume / delete
+pixelhouse monitor pause mon_abc123
+pixelhouse monitor resume mon_abc123
+pixelhouse monitor delete mon_abc123
+```
+
+| Interval | Cron equivalent |
+|----------|-----------------|
+| `30m` | `*/30 * * * *` |
+| `1h` | `0 */1 * * *` |
+| `6h` | `0 */6 * * *` |
+| `1d` | `0 0 */1 * *` |
+
+You can also pass a raw cron expression: `--every "0 9 * * 1-5"`.
+
+### `pixelhouse init`
+
+Create a `.pixelhouserc.json` configuration file.
+
+```bash
+pixelhouse init
+pixelhouse init --force  # overwrite existing
+```
+
+## Configuration
+
+Create a `.pixelhouserc.json` in your project root (or run `pixelhouse init`):
+
+```json
+{
+  "apiKey": "ph_live_your_key_here",
+  "apiUrl": "https://api.thepixelhouse.co.uk",
+  "projectId": "prj_xxx",
+  "viewport": "desktop",
+  "threshold": 1.0,
+  "branch": "main",
+  "pages": [
+    {
+      "url": "https://your-site.com",
+      "baselineId": "bl_abc123",
+      "viewport": "desktop",
+      "threshold": 1.0
+    },
+    {
+      "url": "https://your-site.com/pricing",
+      "baselineId": "bl_def456",
+      "viewport": "mobile"
+    }
+  ]
+}
+```
+
+The CLI searches for this file starting from your current directory, walking up to the filesystem root.
+
+## CI/CD integration
+
+### GitHub Actions
+
+```yaml
+- name: Run visual regression tests
+  env:
+    PIXELHOUSE_API_KEY: ${{ secrets.PIXELHOUSE_API_KEY }}
+  run: npx @thepixelhouse/cli regression run --ci
+```
+
+### GitLab CI
+
+```yaml
+visual-regression:
+  script:
+    - npx @thepixelhouse/cli regression run --ci
+  variables:
+    PIXELHOUSE_API_KEY: $PIXELHOUSE_API_KEY
+```
+
+## Global options
+
+These options apply to all commands:
+
+| Option | Description |
+|--------|-------------|
+| `--api-key <key>` | API key (overrides env var and config) |
+| `--api-url <url>` | API base URL |
+| `--json` | Output results as JSON |
+| `--no-color` | Disable coloured output |
+| `-v, --version` | Print version |
+| `-h, --help` | Print help |
+
+## JSON output
+
+Pass `--json` to any command for machine-readable output:
+
+```bash
+pixelhouse screenshot https://example.com --json | jq '.id'
+pixelhouse regression run --json | jq '.summary'
+```
+
+## Links
+
+- [Documentation](https://thepixelhouse.co.uk/docs)
+- [Dashboard](https://thepixelhouse.co.uk)
+- [API reference](https://api.thepixelhouse.co.uk/docs)
+
+## Licence
+
+MIT - ToggleKit Ltd

package/dist/cli.js

@@ -2,13 +2,14 @@
 
 // src/cli.ts
 import { Command as Command7 } from "commander";
-import chalk7 from "chalk";
+import chalk8 from "chalk";
 
 // src/commands/screenshot.ts
 import { Command } from "commander";
-import * as fs2 from "fs";
-import * as path2 from "path";
+import * as fs3 from "fs";
+import * as path3 from "path";
 import ora from "ora";
+import chalk2 from "chalk";
 
 // src/api/client.ts
 var ApiClient = class {
@@ -73,17 +74,17 @@ var ApiClient = class {
     return this.delete(`/v1/monitors/${id}`);
   }
   // ─── Internal helpers ─────────────────────────────
-  async request(path5, init) {
-    const url = `${this.baseUrl}${path5}`;
+  async request(path6, init) {
+    const url = `${this.baseUrl}${path6}`;
     const headers = new Headers(init.headers);
     headers.set("Authorization", `Bearer ${this.apiKey}`);
     headers.set("Accept", "application/json");
     headers.set("User-Agent", "@pixelhouse/cli");
     return fetch(url, { ...init, headers });
   }
-  async get(path5) {
+  async get(path6) {
     try {
-      const res = await this.request(path5, { method: "GET" });
+      const res = await this.request(path6, { method: "GET" });
       const body = await res.json();
       if (!res.ok || "error" in body) {
         const errBody = body;
@@ -94,9 +95,9 @@ var ApiClient = class {
       return { success: false, error: err instanceof Error ? err.message : "Unknown error" };
     }
   }
-  async getPaginated(path5) {
+  async getPaginated(path6) {
     try {
-      const res = await this.request(path5, { method: "GET" });
+      const res = await this.request(path6, { method: "GET" });
       const body = await res.json();
       if (!res.ok || "error" in body) {
         const errBody = body;
@@ -107,9 +108,9 @@ var ApiClient = class {
       return { success: false, error: err instanceof Error ? err.message : "Unknown error" };
     }
   }
-  async post(path5, body) {
+  async post(path6, body) {
     try {
-      const res = await this.request(path5, {
+      const res = await this.request(path6, {
         method: "POST",
         headers: { "Content-Type": "application/json" },
         body: JSON.stringify(body)
@@ -124,9 +125,9 @@ var ApiClient = class {
       return { success: false, error: err instanceof Error ? err.message : "Unknown error" };
     }
   }
-  async patch(path5, body) {
+  async patch(path6, body) {
     try {
-      const res = await this.request(path5, {
+      const res = await this.request(path6, {
         method: "PATCH",
         headers: { "Content-Type": "application/json" },
         body: JSON.stringify(body)
@@ -141,9 +142,9 @@ var ApiClient = class {
       return { success: false, error: err instanceof Error ? err.message : "Unknown error" };
     }
   }
-  async delete(path5) {
+  async delete(path6) {
     try {
-      const res = await this.request(path5, { method: "DELETE" });
+      const res = await this.request(path6, { method: "DELETE" });
       const json = await res.json();
       if (!res.ok || "error" in json) {
         const errBody = json;
@@ -154,9 +155,9 @@ var ApiClient = class {
       return { success: false, error: err instanceof Error ? err.message : "Unknown error" };
     }
   }
-  async getBlob(path5) {
+  async getBlob(path6) {
     try {
-      const res = await this.request(path5, { method: "GET" });
+      const res = await this.request(path6, { method: "GET" });
       if (!res.ok) {
         let message = `API returned ${res.status}`;
         try {
@@ -174,6 +175,34 @@ var ApiClient = class {
   }
 };
 
+// src/api/free-client.ts
+var FreeClient = class {
+  baseUrl;
+  constructor(baseUrl) {
+    this.baseUrl = baseUrl.replace(/\/+$/, "");
+  }
+  async captureScreenshot(params) {
+    try {
+      const res = await fetch(`${this.baseUrl}/v1/free/screenshot`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          "User-Agent": "@thepixelhouse/cli"
+        },
+        body: JSON.stringify(params)
+      });
+      const body = await res.json();
+      if (!res.ok || "error" in body) {
+        const errBody = body;
+        return { success: false, error: errBody.error.message };
+      }
+      return { success: true, data: body.data };
+    } catch (err) {
+      return { success: false, error: err instanceof Error ? err.message : "Unknown error" };
+    }
+  }
+};
+
 // src/config/loader.ts
 import * as fs from "fs";
 import * as path from "path";
@@ -300,6 +329,58 @@ function output(text, jsonData, jsonMode) {
   }
 }
 
+// src/lib/trial.ts
+import * as fs2 from "fs";
+import * as path2 from "path";
+import * as os from "os";
+var TRIAL_LIMIT = 10;
+var TRIAL_FILE = "trial.json";
+function defaultConfigDir() {
+  return path2.join(os.homedir(), ".config", "thepixelhouse");
+}
+function trialPath(configDir) {
+  return path2.join(configDir, TRIAL_FILE);
+}
+function readTrial(configDir) {
+  const filePath = trialPath(configDir);
+  try {
+    const raw = fs2.readFileSync(filePath, "utf-8");
+    return JSON.parse(raw);
+  } catch {
+    return { count: 0, firstUsed: (/* @__PURE__ */ new Date()).toISOString() };
+  }
+}
+function writeTrial(configDir, data) {
+  fs2.mkdirSync(configDir, { recursive: true });
+  fs2.writeFileSync(trialPath(configDir), JSON.stringify(data, null, 2) + "\n", "utf-8");
+}
+function getTrialUsage(configDir) {
+  const dir = configDir ?? defaultConfigDir();
+  const data = readTrial(dir);
+  return {
+    count: data.count,
+    remaining: Math.max(0, TRIAL_LIMIT - data.count)
+  };
+}
+function incrementTrialUsage(configDir) {
+  const dir = configDir ?? defaultConfigDir();
+  const data = readTrial(dir);
+  data.count += 1;
+  if (data.count === 1) {
+    data.firstUsed = (/* @__PURE__ */ new Date()).toISOString();
+  }
+  writeTrial(dir, data);
+  return {
+    count: data.count,
+    remaining: Math.max(0, TRIAL_LIMIT - data.count)
+  };
+}
+function isTrialExpired(configDir) {
+  const dir = configDir ?? defaultConfigDir();
+  const data = readTrial(dir);
+  return data.count >= TRIAL_LIMIT;
+}
+
 // src/commands/screenshot.ts
 function createScreenshotCommand() {
   const cmd = new Command("screenshot").description("Capture a screenshot of a URL").argument("<url>", "URL to capture").option("--viewport <viewport>", "viewport preset or WxH (e.g. desktop, 1440x900)", "desktop").option("--full-page", "capture the full scrollable page", false).option("--project <id>", "project ID to associate the screenshot with").option("--output <path>", "save the screenshot PNG to a local file").option("--wait-for <strategy>", "page load strategy: networkIdle, domContentLoaded, load", "networkIdle").action(async (url, opts) => {
@@ -309,8 +390,12 @@ function createScreenshotCommand() {
       apiUrl: parentOpts?.apiUrl
     });
     const jsonMode = parentOpts?.json ?? false;
-    const apiKey = requireApiKey(config);
-    const client = new ApiClient(config.apiUrl ?? "https://api.thepixelhouse.co.uk", apiKey);
+    const apiUrl = config.apiUrl ?? "https://api.thepixelhouse.co.uk";
+    if (!config.apiKey) {
+      await handleTrialCapture(url, opts, apiUrl, jsonMode);
+      return;
+    }
+    const client = new ApiClient(apiUrl, config.apiKey);
     const spinner = jsonMode ? null : ora("Capturing screenshot...").start();
     const result = await client.captureScreenshot({
       url,
@@ -330,8 +415,8 @@ function createScreenshotCommand() {
         spinner?.warn("Screenshot captured but download failed");
         throw new CliError(`Failed to download image: ${downloadResult.error}`, EXIT_CODES.ERROR);
       }
-      const outputPath = path2.resolve(opts.output);
-      fs2.writeFileSync(outputPath, Buffer.from(downloadResult.data));
+      const outputPath = path3.resolve(opts.output);
+      fs3.writeFileSync(outputPath, Buffer.from(downloadResult.data));
       spinner?.succeed("Screenshot captured and saved");
       const text2 = [
         formatSuccess("Screenshot captured and saved"),
@@ -358,13 +443,75 @@ function createScreenshotCommand() {
   });
   return cmd;
 }
+async function handleTrialCapture(url, opts, apiUrl, jsonMode) {
+  if (isTrialExpired()) {
+    const msg = [
+      chalk2.yellow(`You have used all ${String(TRIAL_LIMIT)} free trial screenshots.`),
+      "",
+      "Sign up for a free account to continue:",
+      chalk2.cyan("  https://thepixelhouse.co.uk/register"),
+      "",
+      "Then set your API key:",
+      chalk2.dim("  export PIXELHOUSE_API_KEY=ph_live_your_key")
+    ].join("\n");
+    throw new CliError(msg, EXIT_CODES.ERROR);
+  }
+  const viewport = opts.viewport;
+  if (!["desktop", "tablet", "mobile"].includes(viewport)) {
+    throw new CliError(
+      "Trial mode only supports viewport presets: desktop, tablet, mobile. Sign up for custom viewports.",
+      EXIT_CODES.ERROR
+    );
+  }
+  const { remaining } = getTrialUsage();
+  const spinner = jsonMode ? null : ora(`Capturing screenshot (trial: ${String(remaining)} of ${String(TRIAL_LIMIT)} remaining)...`).start();
+  const client = new FreeClient(apiUrl);
+  const result = await client.captureScreenshot({ url, viewport });
+  if (!result.success) {
+    spinner?.fail("Screenshot capture failed");
+    throw new CliError(result.error, EXIT_CODES.ERROR);
+  }
+  const usage = incrementTrialUsage();
+  if (opts.output) {
+    const outputPath = path3.resolve(opts.output);
+    const imageBuffer = Buffer.from(result.data.image, "base64");
+    fs3.writeFileSync(outputPath, imageBuffer);
+    spinner?.succeed("Screenshot captured and saved");
+    const text2 = [
+      formatSuccess("Screenshot captured and saved (trial)"),
+      formatInfo("URL", url),
+      formatInfo("Viewport", `${result.data.viewport} (${String(result.data.viewportWidth)}x${String(result.data.viewportHeight)})`),
+      formatInfo("Saved to", outputPath),
+      "",
+      chalk2.dim(`Trial: ${String(usage.remaining)} of ${String(TRIAL_LIMIT)} free screenshots remaining`)
+    ].join("\n");
+    output(text2, { ...result.data, trial: true, remaining: usage.remaining }, jsonMode);
+    return;
+  }
+  spinner?.succeed("Screenshot captured (trial)");
+  const text = [
+    formatSuccess("Screenshot captured (trial)"),
+    formatInfo("URL", url),
+    formatInfo("Viewport", `${result.data.viewport} (${String(result.data.viewportWidth)}x${String(result.data.viewportHeight)})`),
+    "",
+    chalk2.dim(`Trial: ${String(usage.remaining)} of ${String(TRIAL_LIMIT)} free screenshots remaining`),
+    chalk2.dim("Use --output <file.png> to save the image locally")
+  ].join("\n");
+  output(text, { ...result.data, trial: true, remaining: usage.remaining }, jsonMode);
+  if (usage.remaining <= 3 && usage.remaining > 0) {
+    console.error(
+      chalk2.yellow(`
+Sign up for a free account to keep capturing: https://thepixelhouse.co.uk/register`)
+    );
+  }
+}
 
 // src/commands/compare.ts
 import { Command as Command2 } from "commander";
-import * as fs3 from "fs";
-import * as path3 from "path";
+import * as fs4 from "fs";
+import * as path4 from "path";
 import ora2 from "ora";
-import chalk2 from "chalk";
+import chalk3 from "chalk";
 function createCompareCommand() {
   const cmd = new Command2("compare").description("Compare two screenshots for visual differences").argument("<screenshot-a>", "ID of the first screenshot (before)").argument("<screenshot-b>", "ID of the second screenshot (after)").option("--threshold <number>", "diff threshold percentage (0-100)", "1.0").option("--output <path>", "save the diff image to a local file").action(async (screenshotA, screenshotB, opts) => {
     const parentOpts = cmd.parent?.opts();
@@ -393,14 +540,14 @@ function createCompareCommand() {
     if (opts.output && comparison.diffImageUrl) {
       const downloadResult = await client.downloadDiffImage(comparison.id);
       if (downloadResult.success) {
-        const outputPath = path3.resolve(opts.output);
-        fs3.writeFileSync(outputPath, Buffer.from(downloadResult.data));
+        const outputPath = path4.resolve(opts.output);
+        fs4.writeFileSync(outputPath, Buffer.from(downloadResult.data));
       }
     }
     spinner?.succeed("Comparison complete");
-    const statusLabel = comparison.status === "pass" ? chalk2.green("PASS") : comparison.status === "fail" ? chalk2.red("FAIL") : chalk2.yellow(comparison.status.toUpperCase());
+    const statusLabel = comparison.status === "pass" ? chalk3.green("PASS") : comparison.status === "fail" ? chalk3.red("FAIL") : chalk3.yellow(comparison.status.toUpperCase());
     const lines = [
-      `${chalk2.bold("Result:")} ${statusLabel}`,
+      `${chalk3.bold("Result:")} ${statusLabel}`,
       formatInfo("Comparison ID", comparison.id),
       formatInfo("Diff percentage", comparison.diffPercentage !== null ? `${String(comparison.diffPercentage)}%` : "N/A"),
       formatInfo("SSIM score", comparison.ssimScore !== null ? String(comparison.ssimScore) : "N/A"),
@@ -410,7 +557,7 @@ function createCompareCommand() {
       lines.push(formatInfo("Diff image", comparison.diffImageUrl));
     }
     if (opts.output && comparison.diffImageUrl) {
-      lines.push(formatInfo("Saved to", path3.resolve(opts.output)));
+      lines.push(formatInfo("Saved to", path4.resolve(opts.output)));
     }
     output(lines.join("\n"), comparison, jsonMode);
   });
@@ -420,7 +567,7 @@ function createCompareCommand() {
 // src/commands/regression.ts
 import { Command as Command3 } from "commander";
 import ora3 from "ora";
-import chalk3 from "chalk";
+import chalk4 from "chalk";
 function toTableRow(url, result) {
   return {
     url,
@@ -497,10 +644,10 @@ function createRegressionCommand() {
     }
     const colouredRows = rows.map((row) => ({
       ...row,
-      status: row.status === "pass" ? chalk3.green("pass") : row.status === "fail" ? chalk3.red("fail") : chalk3.yellow(row.status)
+      status: row.status === "pass" ? chalk4.green("pass") : row.status === "fail" ? chalk4.red("fail") : chalk4.yellow(row.status)
     }));
     spinner?.stop();
-    const summary = hasFailure ? formatError(`${String(rows.filter((r) => r.status === "fail" || r.status === chalk3.red("fail")).length)} test(s) failed`) : hasError ? formatError(`${String(rows.filter((r) => r.status === "error" || r.status === chalk3.yellow("error")).length)} test(s) errored`) : formatSuccess(`All ${String(rows.length)} test(s) passed`);
+    const summary = hasFailure ? formatError(`${String(rows.filter((r) => r.status === "fail" || r.status === chalk4.red("fail")).length)} test(s) failed`) : hasError ? formatError(`${String(rows.filter((r) => r.status === "error" || r.status === chalk4.yellow("error")).length)} test(s) errored`) : formatSuccess(`All ${String(rows.length)} test(s) passed`);
     const tableOutput = formatTable(colouredRows, ["url", "status", "diff", "ssim", "threshold"]);
     const text = `${tableOutput}
 
@@ -543,7 +690,7 @@ function buildPageList(opts, config) {
 // src/commands/baseline.ts
 import { Command as Command4 } from "commander";
 import ora4 from "ora";
-import chalk4 from "chalk";
+import chalk5 from "chalk";
 function createBaselineCommand() {
   const baseline = new Command4("baseline").description("Manage screenshot baselines");
   baseline.command("list").description("List baselines for a project").requiredOption("--project <id>", "project ID").option("--branch <name>", "filter by branch name").option("--limit <number>", "max results to return", "25").action(async (opts) => {
@@ -571,7 +718,7 @@ function createBaselineCommand() {
       url: b.url,
       viewport: b.viewport,
       branch: b.branch,
-      active: b.isActive ? chalk4.green("yes") : chalk4.dim("no"),
+      active: b.isActive ? chalk5.green("yes") : chalk5.dim("no"),
       created: b.createdAt
     }));
     const tableText = formatTable(rows, ["id", "url", "viewport", "branch", "active", "created"]);
@@ -633,7 +780,7 @@ function createBaselineCommand() {
 // src/commands/monitor.ts
 import { Command as Command5 } from "commander";
 import ora5 from "ora";
-import chalk5 from "chalk";
+import chalk6 from "chalk";
 function intervalToCron(interval) {
   if (interval.includes(" ")) {
     return interval;
@@ -682,7 +829,7 @@ function createMonitorCommand() {
       viewport: m.viewport,
       schedule: m.cronExpression,
       threshold: `${String(m.threshold)}%`,
-      active: m.isActive ? chalk5.green("yes") : chalk5.dim("no"),
+      active: m.isActive ? chalk6.green("yes") : chalk6.dim("no"),
       lastRun: m.lastRunAt ?? "never",
       lastStatus: m.lastStatus ?? "-"
     }));
@@ -788,9 +935,9 @@ function createMonitorCommand() {
 
 // src/commands/init.ts
 import { Command as Command6 } from "commander";
-import * as fs4 from "fs";
-import * as path4 from "path";
-import chalk6 from "chalk";
+import * as fs5 from "fs";
+import * as path5 from "path";
+import chalk7 from "chalk";
 var DEFAULT_CONFIG = {
   apiUrl: "https://api.thepixelhouse.co.uk",
   viewport: "desktop",
@@ -802,8 +949,8 @@ function createInitCommand() {
   const cmd = new Command6("init").description("Create a .pixelhouserc.json configuration file").option("--force", "overwrite existing configuration file", false).action(async (opts) => {
     const parentOpts = cmd.parent?.opts();
     const jsonMode = parentOpts?.json ?? false;
-    const configPath = path4.join(process.cwd(), CONFIG_FILE_NAME);
-    if (fs4.existsSync(configPath) && !opts.force) {
+    const configPath = path5.join(process.cwd(), CONFIG_FILE_NAME);
+    if (fs5.existsSync(configPath) && !opts.force) {
       throw new CliError(
         `${CONFIG_FILE_NAME} already exists. Use --force to overwrite.`,
         EXIT_CODES.ERROR
@@ -814,15 +961,15 @@ function createInitCommand() {
     if (apiKey) {
       config.apiKey = apiKey;
     }
-    fs4.writeFileSync(configPath, JSON.stringify(config, null, 2) + "\n", "utf-8");
+    fs5.writeFileSync(configPath, JSON.stringify(config, null, 2) + "\n", "utf-8");
     const text = [
       formatSuccess("Configuration file created"),
       formatInfo("Path", configPath),
       "",
-      chalk6.dim("Next steps:"),
-      chalk6.dim(`  1. Add your API key to ${CONFIG_FILE_NAME} or set PIXELHOUSE_API_KEY`),
-      chalk6.dim('  2. Add pages to the "pages" array for regression testing'),
-      chalk6.dim('  3. Run "pixelhouse screenshot <url>" to capture your first screenshot')
+      chalk7.dim("Next steps:"),
+      chalk7.dim(`  1. Add your API key to ${CONFIG_FILE_NAME} or set PIXELHOUSE_API_KEY`),
+      chalk7.dim('  2. Add pages to the "pages" array for regression testing'),
+      chalk7.dim('  3. Run "pixelhouse screenshot <url>" to capture your first screenshot')
     ].join("\n");
     output(text, { path: configPath, config }, jsonMode);
   });
@@ -836,7 +983,7 @@ function createProgram() {
   program2.name("pixelhouse").description("Visual regression testing CLI for The Pixel House").version(VERSION, "-v, --version").option("--api-key <key>", "API key (overrides PIXELHOUSE_API_KEY env var)").option("--api-url <url>", "API base URL (default: https://api.thepixelhouse.co.uk)").option("--json", "output results as JSON", false).option("--no-color", "disable coloured output").hook("preAction", (_thisCommand, actionCommand) => {
     const rootOpts = actionCommand.optsWithGlobals();
     if (rootOpts.color === false) {
-      chalk7.level = 0;
+      chalk8.level = 0;
     }
   });
   program2.addCommand(createScreenshotCommand());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thepixelhouse/cli",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Visual regression testing CLI for The Pixel House. Capture screenshots, diff them, manage baselines, and run monitors from your terminal.",
   "license": "MIT",
   "author": "ToggleKit Ltd <hello@thepixelhouse.co.uk>",
@@ -29,7 +29,8 @@
   },
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "engines": {
     "node": ">=18.0.0"
@@ -53,6 +54,7 @@
     "@pixelhouse/shared": "workspace:*",
     "@types/node": "^25.5.0",
     "tsup": "^8.0.0",
-    "typescript": "^5.7.0"
+    "typescript": "^5.7.0",
+    "vitest": "^2.1.0"
   }
 }