@opendatalabs/connect 0.8.1-canary.367ac08 → 0.8.1-canary.38ea4e7

package/README.md

@@ -2,6 +2,65 @@
 
 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 --version
+vana doctor
+vana status
+vana sources
+vana connect github
+vana data list
+vana data show github
+vana logs github
+```
+
+Current reviewable transcripts:
+
+- [`status`](./docs/transcripts/status.txt)
+- [`doctor`](./docs/transcripts/doctor.txt)
+- [`logs`](./docs/transcripts/logs.txt)
+- [`setup`](./docs/transcripts/setup.txt)
+- [`sources`](./docs/transcripts/sources.txt)
+- [`data list`](./docs/transcripts/data-list.txt)
+- [`data help`](./docs/transcripts/data-help.txt)
+- [`data list (empty)`](./docs/transcripts/data-list-empty.txt)
+- [`data show github`](./docs/transcripts/data-show-github.txt)
+- [`data show github (missing)`](./docs/transcripts/data-show-github-missing.txt)
+- [`data path github`](./docs/transcripts/data-path-github.txt)
+- [`connect github`](./docs/transcripts/connect-github-success.txt)
+- [`connect github --no-input`](./docs/transcripts/connect-github-no-input.txt)
+- [`connect github session reuse --no-input`](./docs/transcripts/connect-github-session-reuse-no-input.txt)
+- [`connect shop`](./docs/transcripts/connect-shop.txt)
+- [`connect shop --no-input`](./docs/transcripts/connect-shop-no-input.txt)
+- [`connect steam`](./docs/transcripts/connect-steam.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.
@@ -80,6 +139,13 @@ If you prefer to integrate the SDK into an existing project, follow the steps be
 
 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
@@ -98,6 +164,15 @@ Both installers fetch the latest GitHub release asset for your platform, verify
 
 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
@@ -127,10 +202,155 @@ npx -y @opendatalabs/connect status
 ### Commands
 
 ```bash
+vana --version
+vana version
+vana doctor
+vana logs
+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 doctor` checks the local install, browser runtime, and state directories.
+- `vana logs` lets you inspect the latest stored connector run logs without hunting through `~/.dataconnect/logs`.
+- `vana data ...` lets you inspect collected local datasets without opening the raw JSON file yourself.
+
+### Shell contract
+
+- `--json` mode writes machine-readable output to stdout without human narration.
+- Successful command completion returns exit code `0`.
+- Actionable failures like missing source selection, unavailable connectors, or disabled prompting return exit code `1`.
+- `vana --version`, `vana version`, and `vana --help` return exit code `0`.
+- `vana doctor --json` includes `installMethod`, `channel`, and upgrade/uninstall commands so scripts can surface the right lifecycle guidance.
+
+### Shell examples
+
+```bash
+vana status --json | jq '.channel, .installMethod, .summary | {connectedCount, localCount, syncedCount}'
+vana sources --json | jq '.summary, .recommendedSource'
+vana data list --json | jq '.summary, .datasets[] | {source, dataState, path}'
+vana logs --json | jq '.latestLog, .logs[] | {source, path}'
+vana doctor --json | jq '.paths.executable, .paths.dataHome, .lifecycle'
+```
+
+### Upgrade, channels, and uninstall
+
+Upgrade with the same channel you installed from:
+
+You can always confirm the current install method and exact lifecycle commands with:
+
+```bash
+vana doctor
+```
+
+- Homebrew:
+  ```bash
+  brew update
+  brew upgrade vana
+  ```
+- macOS/Linux installer:
+  ```bash
+  curl -fsSL https://raw.githubusercontent.com/vana-com/vana-connect/main/install/install.sh | sh
+  ```
+- Windows PowerShell installer:
+  ```powershell
+  iwr https://raw.githubusercontent.com/vana-com/vana-connect/main/install/install.ps1 -useb | iex
+  ```
+
+Current channels:
+
+- `stable`: install from `main` or the eventual stable Homebrew tap state
+- `canary`: install from the latest prerelease assets while this CLI is still rolling out
+
+To remove the installed CLI:
+
+- Homebrew:
+  ```bash
+  brew uninstall vana
+  ```
+- macOS/Linux installer:
+  ```bash
+  rm -f ~/.local/bin/vana
+  rm -rf ~/.local/share/vana
+  ```
+- Windows PowerShell installer:
+  - remove `%USERPROFILE%\AppData\Local\Microsoft\WinGet\Links\vana.cmd`
+  - remove `%USERPROFILE%\AppData\Local\Vana`
+
+To remove local runtime and collected state as well:
+
+```bash
+rm -rf ~/.dataconnect
+```
+
+### 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)
+- [`doctor`](./docs/transcripts/doctor.txt)
+- [`logs`](./docs/transcripts/logs.txt)
+- [`setup`](./docs/transcripts/setup.txt)
+- [`sources`](./docs/transcripts/sources.txt)
+- [`data list`](./docs/transcripts/data-list.txt)
+- [`data list (empty)`](./docs/transcripts/data-list-empty.txt)
+- [`data show github`](./docs/transcripts/data-show-github.txt)
+- [`data show github (missing)`](./docs/transcripts/data-show-github-missing.txt)
+- [`data path github`](./docs/transcripts/data-path-github.txt)
+- [`connect github`](./docs/transcripts/connect-github-success.txt)
+- [`connect github --no-input`](./docs/transcripts/connect-github-no-input.txt)
+- [`connect shop --no-input`](./docs/transcripts/connect-shop-no-input.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

package/dist/cli/bin.js

@@ -1,5 +1,13 @@
 #!/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;

package/dist/cli/bin.js.map

@@ -1 +1 @@
-{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,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"}
+{"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.map

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