@opendatalabs/connect 0.8.1-canary.46dcdd4 → 0.8.1-canary.4ee166c

package/README.md

@@ -30,19 +30,35 @@ curl -fsSL https://raw.githubusercontent.com/vana-com/vana-connect/feat/connect-
 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
@@ -186,6 +202,10 @@ npx -y @opendatalabs/connect status
 ### Commands
 
 ```bash
+vana --version
+vana version
+vana doctor
+vana logs
 vana connect
 vana sources
 vana connect github
@@ -202,8 +222,78 @@ vana data show github --json | jq '.summary.lines'
 - `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
@@ -224,10 +314,18 @@ Branch prerelease preview media:
 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:

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

@@ -1 +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"}
+{"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"}