@opendatalabs/connect 0.8.0 → 0.8.1-canary.0afda69

package/README.md

@@ -2,6 +2,49 @@
 
 Let your users bring their own data to your app.
 
+## CLI preview
+
+This branch also carries the new `vana` collection CLI preview.
+
+- install the current canary on macOS with Homebrew:
+
+```bash
+brew tap vana-com/vana
+brew install vana
+vana status
+```
+
+- or use the hosted prerelease installer on macOS/Linux:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/vana-com/vana-connect/feat/connect-cli-v1/install/install.sh | sh -s -- --version canary-feat-connect-cli-v1
+```
+
+- branch release page:
+  `https://github.com/vana-com/vana-connect/releases/tag/canary-feat-connect-cli-v1`
+- demo media:
+  [`status-and-sources.gif`](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/status-and-sources.gif),
+  [`data-inspection.gif`](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/data-inspection.gif),
+  [`connect-success.gif`](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/connect-success.gif)
+
+Once installed, the best way to evaluate the CLI quickly is:
+
+```bash
+vana status
+vana sources
+vana connect github
+vana data show github
+```
+
+Current reviewable transcripts:
+
+- [`status`](./docs/transcripts/status.txt)
+- [`sources`](./docs/transcripts/sources.txt)
+- [`data list`](./docs/transcripts/data-list.txt)
+- [`data show github`](./docs/transcripts/data-show-github.txt)
+- [`connect github`](./docs/transcripts/connect-github-success.txt)
+- [`connect steam --no-input`](./docs/transcripts/connect-steam-no-input.txt)
+
 ## What problem this solves
 
 Your users already have rich personal data — ChatGPT conversations, Instagram activity, Gmail, purchase history — but it's locked inside the platforms that collected it. As a builder, you can't easily use that data to personalize onboarding, tailor recommendations, or skip lengthy signup forms.
@@ -72,6 +115,185 @@ Then, in your dev version of DataConnect (likely built from the `main` branch) y
 
 If you prefer to integrate the SDK into an existing project, follow the steps below.
 
+## Headless CLI
+
+`vana-connect` now also ships a local collection CLI for connector setup and data export flows.
+
+### Install
+
+If you are evaluating this branch before it lands on `main`, use the prerelease path in the next section. The stable install commands below are the intended post-merge install path.
+
+macOS with Homebrew:
+
+```bash
+brew tap vana-com/vana
+brew install vana
+```
+
+macOS and Linux:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/vana-com/vana-connect/main/install/install.sh | sh
+```
+
+Windows PowerShell:
+
+```powershell
+iwr https://raw.githubusercontent.com/vana-com/vana-connect/main/install/install.ps1 -useb | iex
+```
+
+Both installers fetch the latest GitHub release asset for your platform, verify its checksum, and install `vana` without requiring Node or npm.
+
+### Canary / prerelease testing
+
+If you are testing an unreleased branch build, install from the branch installer and pass the prerelease tag explicitly.
+
+macOS with Homebrew:
+
+```bash
+brew tap vana-com/vana
+brew install vana
+```
+
+The current Homebrew tap is following the latest `vana-connect` canary while this CLI is still rolling out.
+
+macOS and Linux:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/vana-com/vana-connect/feat/connect-cli-v1/install/install.sh | sh -s -- --version canary-feat-connect-cli-v1
+```
+
+Windows PowerShell:
+
+```powershell
+& ([scriptblock]::Create((iwr https://raw.githubusercontent.com/vana-com/vana-connect/feat/connect-cli-v1/install/install.ps1 -useb).Content)) --version canary-feat-connect-cli-v1
+```
+
+The current hosted prerelease is:
+
+`canary-feat-connect-cli-v1`
+
+Release page:
+
+`https://github.com/vana-com/vana-connect/releases/tag/canary-feat-connect-cli-v1`
+
+If you want the npm package path as a fallback:
+
+```bash
+npx -y @opendatalabs/connect status
+```
+
+### Commands
+
+```bash
+vana connect
+vana sources
+vana connect github
+vana connect github --json --no-input
+vana status
+vana setup
+vana data list
+vana data path github --json
+vana data show github --json | jq '.summary.lines'
+```
+
+- `vana connect` opens a guided source picker in human mode.
+- `vana connect <source>` runs the end-to-end collection flow.
+- `vana connect <source> --json --no-input` is the strict machine-safe path for agents and shell automation.
+- `vana sources` groups sources into ready-now vs manual-step flows.
+- `vana status` prioritizes sources that need attention before already-connected sources.
+- `vana data ...` lets you inspect collected local datasets without opening the raw JSON file yourself.
+
+### CLI demos
+
+The branch also includes deterministic VHS demo scaffolding under
+[`docs/vhs/`](./docs/vhs/README.md).
+
+Branch prerelease preview media:
+
+- [`status-and-sources.gif`](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/status-and-sources.gif)
+- [`data-inspection.gif`](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/data-inspection.gif)
+- [`connect-success.gif`](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/connect-success.gif)
+
+![Vana status and sources demo](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/status-and-sources.gif)
+
+![Vana data inspection demo](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/data-inspection.gif)
+
+![Vana successful connect demo](https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/connect-success.gif)
+
+Current reviewable transcripts:
+
+- [`status`](./docs/transcripts/status.txt)
+- [`sources`](./docs/transcripts/sources.txt)
+- [`data list`](./docs/transcripts/data-list.txt)
+- [`data show github`](./docs/transcripts/data-show-github.txt)
+- [`connect github`](./docs/transcripts/connect-github-success.txt)
+- [`connect steam --no-input`](./docs/transcripts/connect-steam-no-input.txt)
+
+To seed the fixture home used by the first tapes:
+
+```bash
+pnpm demo:vhs:fixtures
+```
+
+To render the checked-in tapes once `vhs` or Docker is available:
+
+```bash
+pnpm demo:vhs
+```
+
+To capture deterministic human-mode transcripts for review:
+
+```bash
+pnpm demo:transcripts
+```
+
+To watch the branch release lane, trigger Homebrew sync, and verify the
+published installer automatically:
+
+```bash
+pnpm release:watch
+```
+
+### Local development
+
+From this repo:
+
+```bash
+pnpm install
+pnpm build
+node dist/cli/bin.js status
+```
+
+The CLI installs its local browser runtime under `~/.dataconnect/`.
+That runtime is bundled from `vana-connect` itself, so `vana setup` does not require a separate `data-connect` checkout.
+
+To build a standalone launcher plus app payload locally:
+
+```bash
+pnpm build
+pnpm build:sea
+./artifacts/sea/vana-linux-x64/vana status --json
+```
+
+`pnpm build:sea` uses Node 25's `--build-sea` flow to create a small `vana` launcher and packages the real app payload next to it under `app/`.
+It produces a platform-specific release directory plus a release archive and matching checksum file under `artifacts/sea/`.
+
+### Programmatic runtime access
+
+If you are building an app surface like DataConnect Desktop or a hosted orchestration layer, use the SDK modules instead of shelling out to the CLI where possible.
+
+```ts
+import { ManagedPlaywrightRuntime } from "@opendatalabs/connect/runtime";
+import { listAvailableSources } from "@opendatalabs/connect/connectors";
+```
+
+Intended split:
+
+- app surfaces consume SDK/runtime APIs
+- agent skills consume the CLI
+- `data-connectors` remains the connector and schema source of truth
+
 ### Installation
 
 ```bash

package/dist/cli/bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=bin.d.ts.map

package/dist/cli/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":""}

package/dist/cli/bin.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { runCli } from "./index.js";
+for (const stream of [process.stdout, process.stderr]) {
+    stream.on("error", (error) => {
+        if (error.code === "EPIPE") {
+            process.exit(0);
+        }
+        throw error;
+    });
+}
+const exitCode = await runCli(process.argv);
+if (typeof exitCode === "number") {
+    process.exitCode = exitCode;
+}
+//# sourceMappingURL=bin.js.map

package/dist/cli/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,KAAK,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IACtD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAA4B,EAAE,EAAE;QAClD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5C,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;IACjC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,CAAC"}

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+export declare function runCli(argv?: string[]): Promise<number>;
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AA0EA,wBAAsB,MAAM,CAAC,IAAI,WAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAuEjE"}