@opendatalabs/connect 0.8.0 → 0.8.1-canary.18332a5

package/README.md

@@ -72,6 +72,129 @@ 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 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
+```
+
+`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,7 @@
+#!/usr/bin/env node
+import { runCli } from "./index.js";
+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,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":"AAuEA,wBAAsB,MAAM,CAAC,IAAI,WAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAsEjE"}