Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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 (synapses alias), 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

​
Compatibility

receptors is the canonical command group. synapses still works as a compatibility alias while the CLI migrates to clearer naming.

​
Next Steps

  • Authentication - saved config, env fallback, and precedence
  • Commands - command-by-command reference generated from the registry
  • Examples - practical human, script, and LLM workflows