@opendatalabs/connect 0.8.1-canary.320bfb5 → 0.8.1-canary.32efd1c

package/README.md

@@ -2,6 +2,54 @@
 
 Let your users bring their own data to your app.
 
+## CLI preview
+
+This branch also carries the new `vana` collection CLI preview.
+
+Start with the dedicated CLI README:
+
+- [CLI README](./docs/CLI-README.md)
+- [CLI review surface](./docs/CLI-REVIEW-SURFACE.md)
+
+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 prerelease:
+
+- `https://github.com/vana-com/vana-connect/releases/tag/canary-feat-connect-cli-v1`
+
+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
+```
+
+Key demo media:
+
+<img src="https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/status.gif" width="800" alt="vana status" />
+
+<img src="https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/connect-github-success.gif" width="800" alt="vana connect github" />
+
+<img src="https://github.com/vana-com/vana-connect/releases/download/canary-feat-connect-cli-v1/data-show-github.gif" width="600" alt="vana data show github" />
+
 ## 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.
@@ -76,106 +124,13 @@ If you prefer to integrate the SDK into an existing project, follow the steps be
 
 `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 only care about the CLI, start with [docs/CLI-README.md](./docs/CLI-README.md).
 
-If you want the npm package path as a fallback:
+For the full CLI review surface, use:
 
-```bash
-npx -y @opendatalabs/connect status
-```
-
-### Commands
-
-```bash
-vana connect
-vana sources
-vana connect github
-vana status
-vana setup
-vana data list
-vana data show github --json | jq
-```
-
-- `vana connect` opens a guided source picker in human mode.
-- `vana connect <source>` runs the end-to-end collection flow.
-- `vana data ...` lets you inspect collected local datasets without opening the raw JSON file yourself.
-
-### 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
-```
+- [CLI review surface](./docs/CLI-REVIEW-SURFACE.md)
+- [CLI transcripts](./docs/transcripts/README.md)
+- [CLI demos](./docs/vhs/README.md)
 
 `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/`.

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

@@ -1,2 +1,89 @@
+import { readCliState } from "../core/index.js";
+import type { CliChannel, CliInstallMethod, CliStatus, SourceStatus } from "../core/cli-types.js";
+import type { AvailableSource } from "../connectors/registry.js";
+interface SourceLabelMap {
+    [source: string]: string;
+}
+interface SourceMetadataMap {
+    [source: string]: {
+        name: string;
+        company?: string;
+        description?: string;
+        authMode?: "automated" | "interactive" | "legacy";
+    };
+}
+type RenderTone = "accent" | "success" | "warning" | "error" | "muted" | "info";
 export declare function runCli(argv?: string[]): Promise<number>;
+export declare function formatUptime(seconds: number): string;
+export declare function displaySource(source: string, labels?: SourceLabelMap): string;
+export declare function humanizeIssue(message: string): string;
+export declare function gatherSourceStatuses(storedSources: Record<string, Awaited<ReturnType<typeof readCliState>>["sources"][string]>, metadata?: SourceMetadataMap): Promise<SourceStatus[]>;
+export declare function listInstalledConnectorFiles(): Promise<Array<{
+    source: string;
+    path: string;
+}>>;
+export declare function buildStatusNextSteps(sources: SourceStatus[], sourceLabels?: SourceLabelMap, runtime?: CliStatus["runtime"], availableSources?: Array<{
+    id: string;
+    name: string;
+    authMode?: string;
+}>): string[];
+export declare function buildSourcesNextSteps(recommendedSource: {
+    id: string;
+    name: string;
+    authMode?: "automated" | "interactive" | "legacy";
+} | null | undefined, connectedCount: number): string[];
+export declare function buildDataListNextSteps(datasetRecords: Array<{
+    source: string;
+    name?: string | null;
+}>, registrySources: Array<{
+    id: string;
+    authMode?: "automated" | "interactive" | "legacy";
+}>): string[];
+export declare function buildDataShowNextSteps(source: string, datasetCount: number, sourceLabels?: SourceLabelMap): string[];
+export declare function getCliVersion(): string;
+export declare function getCliChannel(version?: string): "stable" | "canary";
+export declare function getCliInstallMethod(execPath?: string): CliInstallMethod;
+export declare function getDoctorAppRootPath(installMethod: CliInstallMethod, execPath?: string): string | null;
+export declare function formatInstallMethodLabel(method: CliInstallMethod): string;
+export declare function getLifecycleCommands(installMethod: CliInstallMethod, channel: CliChannel): {
+    upgrade: string;
+    uninstall: string;
+};
+export declare function createSourceLabelMap(sources: Array<{
+    id: string;
+    name: string;
+}>): SourceLabelMap;
+export declare function createSourceMetadataMap(sources: Array<{
+    id: string;
+    name: string;
+    company?: string;
+    description?: string;
+    authMode?: "automated" | "interactive" | "legacy";
+}>): SourceMetadataMap;
+export declare function getSourceStatusPresentation(source: SourceStatus): {
+    label: string;
+    tone: RenderTone;
+};
+export declare function toneForRuntime(runtime: CliStatus["runtime"]): RenderTone;
+export declare function loadRegistrySources(): Promise<AvailableSource[]>;
+export declare function compareSourceStatusOrder(left: SourceStatus, right: SourceStatus): number;
+export declare function rankSourceStatus(source: SourceStatus): number;
+export declare function readResultSummary(resultPath: string): Promise<{
+    lines: string[];
+} | null>;
+export declare function summarizeResultData(data: Record<string, unknown>): {
+    lines: string[];
+} | null;
+export declare function formatTimestamp(value: string): string;
+export declare function compareDatasetOrder(left: {
+    lastRunAt: string | null;
+    name: string | undefined;
+    source: string;
+}, right: {
+    lastRunAt: string | null;
+    name: string | undefined;
+    source: string;
+}): number;
+export declare function hasCollectedData(dataState: SourceStatus["dataState"] | null | undefined): boolean;
+export {};
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAuEA,wBAAsB,MAAM,CAAC,IAAI,WAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAsEjE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAmCA,OAAO,EAKL,YAAY,EAIb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,UAAU,EAEV,gBAAgB,EAEhB,SAAS,EACT,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAkCjE,UAAU,cAAc;IACtB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B;AAED,UAAU,iBAAiB;IACzB,CAAC,MAAM,EAAE,MAAM,GAAG;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,QAAQ,CAAC;KACnD,CAAC;CACH;AA2BD,KAAK,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;AAehF,wBAAsB,MAAM,CAAC,IAAI,WAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CA4XjE;AA2lCD,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAWpD;AA+/BD,wBAAgB,aAAa,CAC3B,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,cAAmB,GAC1B,MAAM,CAER;AAkBD,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAKrD;AAkCD,wBAAsB,oBAAoB,CACxC,aAAa,EAAE,MAAM,CACnB,MAAM,EACN,OAAO,CAAC,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAC5D,EACD,QAAQ,GAAE,iBAAsB,GAC/B,OAAO,CAAC,YAAY,EAAE,CAAC,CAiDzB;AAED,wBAAsB,2BAA2B,IAAI,OAAO,CAC1D,KAAK,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CACxC,CAyBA;AA6KD,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,YAAY,EAAE,EACvB,YAAY,GAAE,cAAmB,EACjC,OAAO,GAAE,SAAS,CAAC,SAAS,CAAe,EAC3C,gBAAgB,GAAE,KAAK,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAM,GAC5E,MAAM,EAAE,CAsGV;AAED,wBAAgB,qBAAqB,CACnC,iBAAiB,EACb;IACE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,QAAQ,CAAC;CACnD,GACD,IAAI,GACJ,SAAS,EACb,cAAc,EAAE,MAAM,GACrB,MAAM,EAAE,CAgBV;AAED,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,KAAK,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC,EACF,eAAe,EAAE,KAAK,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,QAAQ,CAAC;CACnD,CAAC,GACD,MAAM,EAAE,CAmBV;AAED,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,YAAY,GAAE,cAAmB,GAChC,MAAM,EAAE,CAQV;AA4ED,wBAAgB,aAAa,IAAI,MAAM,CA2BtC;AAED,wBAAgB,aAAa,CAAC,OAAO,SAAkB,GAAG,QAAQ,GAAG,QAAQ,CAc5E;AAED,wBAAgB,mBAAmB,CACjC,QAAQ,SAAmB,GAC1B,gBAAgB,CA+BlB;AAMD,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,gBAAgB,EAC/B,QAAQ,SAAmB,GAC1B,MAAM,GAAG,IAAI,CAQf;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAWzE;AAED,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,gBAAgB,EAC/B,OAAO,EAAE,UAAU,GAClB;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CA6BxC;AAWD,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,KAAK,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GAC3C,cAAc,CAEhB;AAED,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,KAAK,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,QAAQ,CAAC;CACnD,CAAC,GACD,iBAAiB,CAYnB;AAID,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,YAAY,GAAG;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,UAAU,CAAC;CAClB,CAqDA;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,UAAU,CAQxE;AAqED,wBAAsB,mBAAmB,+BAQxC;AAYD,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,YAAY,GAClB,MAAM,CAgBR;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CA0B7D;AAeD,wBAAsB,iBAAiB,CACrC,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,IAAI,CAAC,CAOrC;AAED,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B;IAAE,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,IAAI,CAoD5B;AA6BD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAUrD;AAED,wBAAgB,mBAAmB,CACjC,IAAI,EAAE;IACJ,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;CAChB,EACD,KAAK,EAAE;IACL,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;CAChB,GACA,MAAM,CAaR;AAsBD,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,SAAS,GACtD,OAAO,CAMT"}