CLI

The AUVY SDK CLI (@auvy/cli) lives in auvy-sdk/auvy-cli. It mirrors MCP vault discovery contracts via @auvy-os/client — optimized for Codex terminal workflows and JSON automation.

Install

git clone https://github.com/AUVY-AI/auvy-sdk.git
cd auvy-sdk
bun run setup:local
bun run auvy vault session --json

Build a standalone binary:

bun run build
./dist/auvy help

@auvy/cli is not yet published to npm. Install from the auvy-sdk repo until a public release is available.

Auth

Product OAuth (interactive)

auvy login
auvy whoami
auvy logout

API key (CI / automation)

auvy auth login --api-key ak_live_...
auvy auth status
auvy auth mcp    # print MCP connection options
auvy auth logout

Or use environment variables:

export AUVY_API_KEY=ak_live_...
export AUVY_API_URL=https://api.auvy.ai
export AUVY_WORKSPACE_SLUG=my-workspace
export AUVY_BRAIN_ID=brain_...

Vault commands

Command	Purpose
`auvy vault session`	Resolved workspace and brain context
`auvy vault document-tree`	Browse vault folder tree
`auvy vault search`	Semantic search
`auvy vault grep`	Lexical search
`auvy vault read <resource_id>`	Read full document text
`auvy vault ingest`	Ingest text, JSON, file, or URL

auvy vault session --json
auvy vault document-tree --prefix /
auvy vault search "refund policy" --json
auvy vault grep "invoice" --json
auvy vault read <resource_id> --json
auvy vault ingest --file ./notes.md --name "Notes" --path /Research

See MCP vault discovery for the recommended ladder.

JSON output

Use --json for stable parsing by agents:

auvy vault search "customer onboarding" --json

All JSON responses use an envelope:

{
  "ok": true,
  "schema_version": "1",
  "command": "search",
  "data": {}
}

CLI

On this page