Skip to main content

​
AUVY Synapse CLI

The CLI is the fastest way to explore AUVY from a terminal. It uses the same public client and API surface as the REST and SDK examples, but adds command discovery, human defaults, and stable machine-readable output.

​
What It Optimizes For

  • humans: readable defaults, built-in help, clean command groups
  • automation: stable json output envelopes and deterministic errors
  • LLMs: command discovery through auvy commands list and auvy schema commands

​
Command Surface

  • discovery: help, commands list, schema commands, schema output
  • auth and setup: login, logout, config show, config set, health
  • native tools: semantic_search (CLI search), grep, read, tools list
  • resources: receptors, pathways, neurons, reflexes, store, traces
  • execution and jobs: receptors execute, jobs list, jobs get, jobs wait, jobs stream, jobs cancel, jobs resume, jobs input
  • billing visibility: usage user, usage workspace

​
Quick Start

npm install -g @auvy-synapse/cli
auvy login --api-key ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
auvy health
auvy receptors list --output json
auvy receptors execute support-bot --message "Hello"

​
Output Modes

auvy commands list --output human
auvy commands list --output json
auvy jobs stream <jobId> --output jsonl
Use receptors for invoke gateways. Older scripts may still call synapses; prefer receptors in new work.

​
Authentication

auvy login --api-key ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
auvy config show
auvy config set workspace-slug my-workspace
Saved config lives in ~/.auvy/config.encrypted. Environment variables (AUVY_API_URL, AUVY_API_KEY, AUVY_WORKSPACE_SLUG, AUVY_BRAIN_ID) apply when saved config is missing. Full credential matrix: Authentication.

​
Examples

auvy health
auvy receptors list --output json
auvy receptors execute support-bot --message "Summarize incidents" --stream --output jsonl
auvy commands list --output json
auvy schema output receptors execute --output json
Full command reference: run auvy help or auvy commands list --output json. Generated encyclopedia at /cli-reference/commands (not in main nav).