Skip to content

README.md

Latest commit

 

History

History
203 lines (143 loc) · 7.06 KB

README.md

File metadata and controls

203 lines (143 loc) · 7.06 KB
Raw

vana

Portable personal data, from the terminal.

Release macOS · Linux · Windows License: MIT

vana collects your data from platforms you use. You log in through a browser on your machine, and the CLI saves it locally as JSON.

Highlights

  • Local-first: credentials stay on your machine; collected data stays local unless you sync it to your Personal Server
  • Any platform: connects through a browser session, not a restricted API
  • Inspectable: collected data is JSON you can summarize, query, or pipe
  • Agent-ready: --json and --no-input flags for scripts and AI agents
  • Session caching: log in once, reconnect faster next time
  • Extensible: connectors are standalone modules; add new platforms without touching the core

Install

macOS (Homebrew):

brew install vana-com/tap/vana

macOS and Linux:

curl -fsSL https://cli.vana.com/install.sh | sh

Windows (PowerShell):

irm https://cli.vana.com/install.ps1 | iex

Verify with vana --version.

Quick start

$ vana connect github

  Connect GitHub

  ✓ Signed in
  ✓ Profile
  ✓ Repositories — 8 found
  ✓ Starred

  ✓ Connected GitHub.
  Collected your GitHub data and synced it to your Personal Server.

  Next: vana data show github

Your data is on disk at ~/.vana/results/.

vana data show github --json | jq '.summary'

Explore further:

vana sources               # See all available platforms
vana connect               # Interactive source picker
vana status                # What's connected, what needs attention

How it works

  1. vana connect <source> launches a browser on your machine
  2. You log in (credentials stay on your machine)
  3. The CLI collects your data and saves it to ~/.vana/
  4. vana data show <source> summarizes what was collected

Sessions are cached, so reconnecting is faster next time. Your data is files on disk. Inspect, move, or delete them whenever you want.

Commands

Command What it does
vana connect [source] Connect a platform and collect your data
vana connect <src> --detach Connect in the background
vana sources List available platforms
vana data list Show all collected datasets
vana data show <source> Summarize a collected dataset
vana status Connection health and system overview
vana telemetry status Inspect or disable operational telemetry
vana collect [source] Re-collect data from a connected source
vana schedule add Schedule daily collection (launchd/cron)
vana skills Browse and install agent skills interactively
vana skills install <name> Install a skill for your AI agent
vana mcp Start MCP server (Claude Code, Cursor, etc.)
vana doctor Diagnose installation and runtime health
vana logs [source] View run logs
vana setup Install or repair the browser runtime

Run vana <command> --help for detailed usage.

For scripts and AI agents

Commands support structured output:

vana connect github --json --no-input    # Machine-safe — never prompts
vana data show github --json | jq        # Pipe collected data anywhere
vana sources --json                      # Discover platforms programmatically

--json writes structured output to stdout. --no-input guarantees no interactive prompts. The CLI exits 1 if input is needed. See the exit code reference for the full contract.

Sources

vana connects to any platform that has a web login. Connectors handle the automation for each source.

The CLI shares its connector format with DataConnect and the data-connectors repository.

Available: GitHub, ChatGPT, Instagram, LinkedIn, Spotify, YouTube, Shop, Oura Ring, Uber.

Run vana sources to see what's available on your install.

Missing a platform? Request one · Build a connector

Ecosystem

vana is the CLI for Vana's data portability network. It shares connectors and local storage with DataConnect, the desktop app. For building apps that request user data, see the Connect SDK.

Privacy

Credentials: You log in through a browser on your machine. Vana never sees your password, token, or session cookie.

Collected data: Saved to ~/.vana/ as local files. The CLI only uploads your collected data when you explicitly sync it to your Personal Server.

Browser sessions: Cached in ~/.vana/browser-profiles/ for faster reconnects. Delete them any time.

Telemetry: The CLI sends small anonymous operational telemetry by default to improve connector reliability. It does not send passwords, tokens, command arguments, file paths, Personal Server URLs, or collected dataset contents. Run vana telemetry status, vana telemetry disable, or set VANA_TELEMETRY_DISABLED=1. Use VANA_TELEMETRY_DEBUG=1 to print the exact payload locally instead of uploading it.

Troubleshooting

vana doctor              # Runtime, browser, and state health
vana logs <source>       # Latest run log for a source
Problem Fix
Browser runtime missing vana setup
Login expired vana connect <source> to re-authenticate
Connector fails vana logs <source> for details

Uninstall

Remove the CLI:

brew uninstall vana                  # Homebrew
rm -f ~/.local/bin/vana              # Script install (macOS / Linux)

Remove collected data and state:

rm -rf ~/.vana

Documentation

Community

License

MIT