@canaryai/cli 0.1.1-alpha.0

package/README.md

@@ -0,0 +1,82 @@
+# Canary CLI
+
+Run local test runs, expose your local app via a tunnel, and stream results into Canary.
+
+## Install
+
+```bash
+npm install -g @canaryai/cli
+# or
+bun add -g @canaryai/cli
+```
+
+## Login
+
+```bash
+canary login
+```
+
+## Quickstart (local testing)
+
+1) Start your app locally.
+2) Start a run (auto-tunnel + run):
+
+```bash
+canary run --port 5173 --title "Login smoke"
+```
+
+3) Open the watch URL printed in the terminal.
+
+## Tunnel only
+
+```bash
+canary tunnel --port 5173
+```
+
+## MCP server
+
+```bash
+canary mcp
+```
+
+Tools:
+- `local_run_tests` (port, instructions, title)
+- `local_wait_for_results` (runId)
+
+## Environment variables
+
+- `CANARY_API_URL` (default `https://api.trycanary.ai`)
+- `CANARY_APP_URL` (default `https://app.trycanary.ai`)
+- `CANARY_API_TOKEN` (optional; `canary login` stores a token automatically)
+- `CANARY_LOCAL_PORT` (optional default port for `canary run` / `canary tunnel`)
+
+## Programmatic usage
+
+You can trigger a suite programmatically without shelling out to the CLI:
+
+```ts
+import { canary } from "@canaryai/cli";
+
+const result = await canary.run({
+  projectRoot: "/path/to/repo",
+  testDir: ["tests/smoke"],
+  cliArgs: ["--grep", "login"],
+  healing: {
+    apiKey: process.env.AI_API_KEY,
+    provider: "openai",
+    model: "gpt-4o-mini",
+    timeoutMs: 120_000,
+    maxActions: 50,
+    warnOnly: true,
+  },
+  stdio: "pipe",
+});
+
+if (!result.ok) {
+  console.error("suite failed", result.summary);
+}
+```
+
+Notes:
+- Defaults mirror the CLI: healing on, Playwright config respected.
+- `result.summary` is derived from Playwright’s JSON reporter plus healed counts from the AI event log.

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+type HealingOptions = {
+    apiKey?: string;
+    provider?: string;
+    model?: string;
+    timeoutMs?: number;
+    maxActions?: number;
+    vision?: boolean;
+    dryRun?: boolean;
+    warnOnly?: boolean;
+    debug?: boolean;
+    readOnly?: boolean;
+    allowEvaluate?: boolean;
+    allowRunCode?: boolean;
+    maxPayloadBytes?: number;
+};
+type RunRequest = {
+    projectRoot?: string;
+    testDir?: string | string[];
+    configFile?: string;
+    cliArgs?: string[];
+    env?: Record<string, string>;
+    healing?: HealingOptions;
+    reporter?: "default" | "json" | string;
+    timeoutMs?: number;
+    nodeBin?: string;
+    stdio?: "inherit" | "pipe";
+};
+type RunResult = {
+    ok: boolean;
+    exitCode: number;
+    summary: {
+        total: number;
+        passed: number;
+        failed: number;
+        flaky: number;
+        skipped: number;
+        healed?: number;
+        warned?: number;
+        durationMs: number;
+    };
+    artifactsDir?: string;
+    rawOutput?: string;
+    error?: Error;
+};
+declare function run(request?: RunRequest): Promise<RunResult>;
+
+declare const canary: {
+    run: typeof run;
+};
+
+declare function main(argv: string[]): Promise<void>;
+
+export { canary, main, run };