shiplightai 0.1.101 → 0.1.103

package/CHANGELOG.md

@@ -2,6 +2,39 @@
 
 All notable changes to `shiplightai` are documented here. This file is generated automatically at release time from the commits that touch the published package and its bundled SDK.
 
+## 0.1.103 (2026-09-02)
+
+### Features
+
+- **telemetry:** add CLI command telemetry, share one client with the MCP server (bc3ba52)
+- **cli:** replace login/logout with setup-api-token, retire nova hosts (4460953)
+
+### Bug Fixes
+
+- **telemetry:** name both opt-out switches in the first-run notice (5344464)
+- **telemetry:** track setup-api-token, not the retired login/logout (df97829)
+- **cli:** unify URL self-healing policy (0f8333c)
+- **cli:** disable self-healing for URL navigation (86fe8d5)
+
+### Other Changes
+
+- **telemetry:** split the two opt-out switches, unexport the collector constants (a52c8cf)
+- rebuild workspace dependencies before package-level test and typecheck (9ada4a3)
+
+## 0.1.102 (2026-08-27)
+
+### Features
+
+- **reporter:** include cached action per step (20d9d59)
+
+### Bug Fixes
+
+- **reporter:** bound per-step variable snapshots and stream the report write (559d6e2)
+
+### Other Changes
+
+- **reporter:** cover per-attempt encoding; clean up a stranded temp file (28d28bb)
+
 ## 0.1.101 (2026-08-24)
 
 ### Features

package/README.md

@@ -11,8 +11,9 @@ Scaffold a new test project in under a minute:
 ```bash
 npx shiplightai@latest create ./my-tests
 cd my-tests
-cp .env.example .env            # then set one of GOOGLE_API_KEY, ANTHROPIC_API_KEY, OPENAI_API_KEY
+cp .env.example .env            # configure credentials after install
 npm install
+npx shiplight setup-api-token   # writes SHIPLIGHT_API_TOKEN; skip if using a provider key
 npx playwright install chromium
 npx shiplight test              # runs the scaffolded starter test
 ```
@@ -29,14 +30,15 @@ npm install shiplightai
 
 Every command is invoked via `npx shiplight <command>` from inside a project that has `shiplightai` installed.
 
-| Command | Purpose |
-|---|---|
-| `shiplight create <path>` | Scaffold a new test project |
-| `shiplight test [args]` | Run your YAML and Playwright test suite (forwards all Playwright flags) |
-| `shiplight debug <file>` | Launch the interactive visual debugger for a YAML test. The server picks a free port automatically; the chosen URL is printed on startup. Pass `--port N` for a stable URL (CI, bookmarks). Multiple concurrent `shiplight debug` invocations work without any port coordination. |
-| `shiplight report [folder]` | Regenerate or merge HTML reports |
-| `shiplight transpile [glob]` | Transpile YAML tests to `.yaml.spec.ts` (usually automatic). `--strict` fails while statements are still unenriched drafts (no captured `action`/`js`) |
-| `shiplight spec <topic>` | Print an authoring reference: `yaml` (the test language spec) or `actions` (every action and its parameters) |
+| Command                      | Purpose                                                                                                                                                                                                                                                                           |
+| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `shiplight setup-api-token`  | Authenticate with Shiplight and write `SHIPLIGHT_API_TOKEN` to the current project's `.env`                                                                                                                                                                                       |
+| `shiplight create <path>`    | Scaffold a new test project                                                                                                                                                                                                                                                       |
+| `shiplight test [args]`      | Run your YAML and Playwright test suite (forwards all Playwright flags)                                                                                                                                                                                                           |
+| `shiplight debug <file>`     | Launch the interactive visual debugger for a YAML test. The server picks a free port automatically; the chosen URL is printed on startup. Pass `--port N` for a stable URL (CI, bookmarks). Multiple concurrent `shiplight debug` invocations work without any port coordination. |
+| `shiplight report [folder]`  | Regenerate or merge HTML reports                                                                                                                                                                                                                                                  |
+| `shiplight transpile [glob]` | Transpile YAML tests to `.yaml.spec.ts` (usually automatic). `--strict` fails while statements are still unenriched drafts (no captured `action`/`js`)                                                                                                                            |
+| `shiplight spec <topic>`     | Print an authoring reference: `yaml` (the test language spec) or `actions` (every action and its parameters)                                                                                                                                                                      |
 
 Full reference with flags, options, and troubleshooting: **[docs.shiplight.ai/local/cli-reference](https://docs.shiplight.ai/local/cli-reference)**.
 
@@ -99,9 +101,12 @@ For the YAML statement language, authentication, variables, templates, and custo
 
 ## Environment variables
 
-Set at least one LLM provider API key in `.env` before running tests:
+Run `npx shiplight setup-api-token` to configure Shiplight's LLM proxy, or set
+at least one provider API key in `.env` before running tests:
 
 ```
+SHIPLIGHT_API_TOKEN=...
+# or
 GOOGLE_API_KEY=...
 # or ANTHROPIC_API_KEY=sk-ant-...
 # or OPENAI_API_KEY=sk-...
@@ -111,6 +116,23 @@ The AI model is auto-selected from the first key set. Override with `WEB_AGENT_M
 
 Shiplight uses an **explicit env var allowlist**: only the vars it forwards into its internal SDK config are accessible to the agent. Any env var not on the list is invisible to the SDK by design. Full list (`OPENAI_BASE_URL`, Vertex AI routing, Mailgun keys, etc.): **[docs.shiplight.ai/local/cli-reference#environment-variables](https://docs.shiplight.ai/local/cli-reference)**.
 
+## Telemetry
+
+The CLI sends one anonymous event per invocation: the subcommand name (`test`,
+`debug`, …), the CLI version, your OS, CPU architecture, Node version, and
+whether the run looks like CI. Nothing else — no arguments, file paths, URLs,
+test content, or account data. Commands we do not ship are reported as
+`unknown` rather than by name, so a mistyped path never leaves your machine.
+Runs are grouped by a one-way SHA-256 hash of host, user, platform and
+architecture; the inputs to that hash are never transmitted.
+
+Opt out with either:
+
+```
+SHIPLIGHT_TELEMETRY=0
+DO_NOT_TRACK=1
+```
+
 ## Requirements
 
 - **Node.js >= 22**