CLI Commands Reference

This page is generated from the CLI command registry.

Discovery

auvy help
auvy help receptors execute
auvy commands list --output json
auvy schema commands --output json
auvy schema output receptors execute --output json

Output Modes

--output human
--output json
--output jsonl
--json as a shortcut for --output json

activity

Inspect activity streams.

Command	Summary
`activity engrams`	List activity engrams.

activity engrams

auvy activity engrams

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--source-types - Comma-separated source types.
--target-types - Comma-separated target types.
--hours - Hours to look back.
--trace-id - Filter by trace ID.

api-config

Inspect remote API configuration.

Command	Summary
`api-config cost-estimates`	Get current cost estimates.
`api-config embedding-model`	Get the active embedding model.
`api-config models`	List available chat models.

api-config cost-estimates

auvy api-config cost-estimates

api-config embedding-model

auvy api-config embedding-model

api-config models

auvy api-config models

commands

Inspect the CLI command graph.

Command	Summary
`commands list`	List commands for humans or machines.

commands list

auvy commands list

config

Inspect or update CLI configuration.

Command	Summary
`config set`	Set a saved CLI configuration value.
`config show`	Show saved CLI configuration.

config set

auvy config set <key> <value>

Examples:

auvy config set api-url https://api.auvy.ai
auvy config set workspace-slug my-workspace

config show

auvy config show

docs

Show CLI help in text form. Aliases: help

auvy docs

health

Check API connectivity and auth.

auvy health

help

Show CLI help.

auvy help [<command...>]

Examples:

auvy help
auvy help receptors execute

jobs

Inspect and control background jobs.

Command	Summary
`jobs cancel`	Cancel a running job.
`jobs get`	Get current job status.
`jobs input`	Submit intervention_response for a waiting job.
`jobs list`	List jobs.
`jobs resume`	Resume a waiting job.
`jobs stream`	Consume the SSE stream for a job.
`jobs wait`	Wait for a job to complete.

jobs cancel

auvy jobs cancel <jobId>

jobs get

auvy jobs get <jobId>

jobs input

auvy jobs input <jobId>

Options:

--data - JSON for input (intervention_response: type, interventionId, action, …).

Examples:

auvy jobs input <jobId> --data '{"type":"intervention_response","interventionId":"<id>","action":"approve"}'

jobs list

auvy jobs list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--status - Filter by job status.
--receptor-id - Filter by receptor ID.
--pathway-id - Filter by pathway ID.

jobs resume

auvy jobs resume <jobId>

jobs stream

auvy jobs stream <jobId>

jobs wait

auvy jobs wait <jobId>

Options:

--timeout-ms - Wait timeout in milliseconds.

Save CLI credentials.

auvy login

Examples:

auvy login --api-key ak_live_xxx
auvy login --api-key ak_live_xxx --workspace-slug my-workspace

logout

Delete saved CLI credentials.

auvy logout

neurons

Manage neurons.

Command	Summary
`neurons create`	Create a neuron.
`neurons delete`	Delete a neuron.
`neurons get`	Get a neuron by ID.
`neurons list`	List neurons.
`neurons reflexes`	Manage reflexes attached to a neuron.
`neurons update`	Update a neuron.

neurons create

auvy neurons create

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

Examples:

auvy neurons create --data '{"name":"My Neuron"}'

neurons delete

auvy neurons delete <neuronId>

neurons get

auvy neurons get <neuronId>

Options:

--fields - Comma-separated list of fields to return.

neurons list

auvy neurons list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--brain-id - Brain scope override.

neurons reflexes

auvy neurons reflexes

neurons update

auvy neurons update <neuronId>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

pathways

Manage pathways.

Command	Summary
`pathways create`	Create a pathway.
`pathways delete`	Delete a pathway.
`pathways execute`	Execute a pathway.
`pathways get`	Get a pathway by ID.
`pathways list`	List pathways.
`pathways update`	Update a pathway.

pathways create

auvy pathways create

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

Examples:

auvy pathways create --data '{"name":"My Pathway"}'

pathways delete

auvy pathways delete <pathwayId>

pathways execute

auvy pathways execute <pathwayId>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.

Examples:

auvy pathways execute <pathwayId> --data '{"input":{"message":"Hello"}}'

pathways get

auvy pathways get <pathwayId>

Options:

--fields - Comma-separated list of fields to return.

pathways list

auvy pathways list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--brain-id - Brain scope override.

pathways update

auvy pathways update <pathwayId>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

read

Read one spine resource by id (native tool read).

auvy read <resource_id>

receptors

Manage and invoke receptors. Aliases: synapses

Command	Summary
`receptors delete`	Delete a receptor by slug.
`receptors execute`	Invoke a receptor by slug.
`receptors get`	Get a receptor by ID.
`receptors list`	List receptors.
`receptors patch`	Patch a receptor by slug.
`receptors resolve`	Resolve a receptor by slug.
`receptors share`	Manage receptor share settings.

receptors delete

auvy receptors delete <slug>

receptors execute

auvy receptors execute <slug>

Options:

--data - JSON payload.
--message - Single user message.
--messages - JSON array of messages.
--async - Queue the job and return immediately.
--stream - Consume the job stream instead of polling.
--timeout-ms - Wait timeout in milliseconds.

Examples:

auvy receptors execute support --message "Hello"
echo '{"message":"Hello"}' | auvy receptors execute support --stream --output jsonl

receptors get

auvy receptors get <receptorId>

Options:

--fields - Comma-separated list of fields to return.

receptors list

auvy receptors list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--target-type - Filter by receptor target type.
--type - Alias for —target-type.
--active - Filter active receptors.
--brain-id - Brain scope override.

Examples:

auvy receptors list --target-type neuron
auvy synapses list --type pathway --output json

receptors patch

auvy receptors patch <slug>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

Examples:

auvy receptors patch support --data '{"is_active":false}'

receptors resolve

auvy receptors resolve <slug>

Options:

--fields - Comma-separated list of fields to return.

auvy receptors share

recollections

Inspect recollections.

Command	Summary
`recollections by-owner`	Resolve the recollection for an owner.
`recollections create`	Create a recollection.
`recollections delete`	Delete a recollection.
`recollections get`	Get a recollection by ID.
`recollections link-memory`	Link a memory to a recollection.
`recollections list`	List recollections.
`recollections memory-counts`	Get recollection memory counts for owners.
`recollections search`	Search recollections.
`recollections stats`	Get recollection stats.
`recollections unlink-memory`	Unlink a memory from a recollection.

recollections by-owner

auvy recollections by-owner <ownerType>

Options:

--owner-id - Owner ID; use “null” for ownerless.
--fields - Comma-separated list of fields to return.

recollections create

auvy recollections create

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

Examples:

auvy recollections create --data '{"owner_type":"neuron","owner_id":"<id>"}'

recollections delete

auvy recollections delete <recollectionId>

recollections get

auvy recollections get <recollectionId>

Options:

--fields - Comma-separated list of fields to return.

recollections link-memory

auvy recollections link-memory <recollectionId> <memoryId>

Options:

--priority - Optional priority.

recollections list

auvy recollections list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--owner-type - Filter by owner type.
--owner-id - Filter by owner ID; use “null” for ownerless.

recollections memory-counts

auvy recollections memory-counts <ownerType>

Options:

--owner-ids - Comma-separated owner IDs.

recollections search

auvy recollections search

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

Examples:

auvy recollections search --data '{"query":"hello","owner_type":"trace","owner_ids":["<id>"]}'

recollections stats

auvy recollections stats <recollectionId>

Options:

--fields - Comma-separated list of fields to return.

recollections unlink-memory

auvy recollections unlink-memory <recollectionId> <memoryId>

reflexes

Manage reflexes.

Command	Summary
`reflexes connections`	Inspect reflex connection state.
`reflexes create`	Create a reflex.
`reflexes delete`	Delete a reflex.
`reflexes get`	Get a reflex by ID.
`reflexes list`	List reflexes.
`reflexes update`	Update a reflex.

reflexes connections

auvy reflexes connections

reflexes create

auvy reflexes create

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

Examples:

auvy reflexes create --data '{"name":"Email","type":"effector"}'

reflexes delete

auvy reflexes delete <reflexId>

reflexes get

auvy reflexes get <reflexId>

Options:

--fields - Comma-separated list of fields to return.

reflexes list

auvy reflexes list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.

reflexes update

auvy reflexes update <reflexId>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

schema

Inspect CLI schemas.

Command	Summary
`schema commands`	Emit the command schema catalog.
`schema output`	Emit output schema metadata for a command.

schema commands

auvy schema commands

schema output

auvy schema output <command...>

search

Unified resource search (POST /v1/search via native tool semantic_search).

auvy search <query>

store

Manage document-lane rows (assets & artifacts).

Command	Summary
`store bulk-delete`	Bulk delete document-lane rows.
`store chunk`	Get a single resource chunk.
`store chunks`	List chunks for a document-lane resource.
`store create`	Create a document-lane row (resource store).
`store delete`	Delete a document-lane row.
`store delete-chunks`	Delete chunk indices from a document-lane resource.
`store delete-chunks-by-source`	Delete chunks by source URL.
`store get`	Get a document-lane row by ID.
`store ingest`	Ingest content into the resource store.
`store list`	List document-lane rows.
`store update`	Update a document-lane row.

store bulk-delete

auvy store bulk-delete

Options:

--ids - Comma-separated resource IDs.

Examples:

auvy store bulk-delete --ids id-1,id-2

store chunk

auvy store chunk <chunkId>

Options:

--fields - Comma-separated list of fields to return.

store chunks

auvy store chunks <documentId>

Options:

--fields - Comma-separated list of fields to return.
--query - Optional raw query suffix, for example ?limit=50.

store create

auvy store create

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

Examples:

auvy store create --data '{"name":"Notes","source_type":"text"}'

store delete

auvy store delete <documentId>

store delete-chunks

auvy store delete-chunks <documentId>

Options:

--indices - Comma-separated chunk indices.

store delete-chunks-by-source

auvy store delete-chunks-by-source <documentId>

Options:

--source-urls - Comma-separated source URLs.

store get

auvy store get <documentId>

Options:

--fields - Comma-separated list of fields to return.

store ingest

auvy store ingest

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.
--file - Local file path to ingest.
--name - Display name for file ingestion.
--description - Optional description.
--owner-type - Owner type for ingestion.
--owner-id - Owner ID for ingestion.
--metadata - JSON metadata object.
--skip-title-description - Skip title/description extraction.
--skip-embedding - Skip embedding generation.
--source-type - Explicit source type override for file ingestion.

Examples:

auvy store ingest --file ./notes.txt --name "Notes"
auvy store ingest --data '{"source":{"type":"text","value":"hello"},"name":"Notes"}'

store list

auvy store list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--brain-id - Brain scope override.
--source-type - Filter by source type.
--owner-type - Filter by owner type.
--owner-id - Filter by owner ID.
--kind - Filter by entry kind.
--tags - Comma-separated tags filter.

store update

auvy store update <documentId>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.

tools

Inspect built-in native tools.

Command	Summary
`tools list`	List built-in native tools and schemas.

tools list

auvy tools list

traces

Manage traces.

Command	Summary
`traces add-message`	Add a message to a trace.
`traces audit`	Get trace audit details.
`traces get`	Get a trace by ID.
`traces list`	List traces.
`traces messages`	Get engrams for a trace.
`traces update`	Update a trace.

traces add-message

auvy traces add-message <traceId>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.
--content - Message content.
--metadata - JSON metadata object.

Examples:

auvy traces add-message <traceId> --content "Hello"

traces audit

auvy traces audit <traceId>

Options:

--fields - Comma-separated list of fields to return.

traces get

auvy traces get <traceId>

Options:

--fields - Comma-separated list of fields to return.

traces list

auvy traces list

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--search - Search trace titles and messages.
--receptor-id - Filter by receptor ID.

traces messages

auvy traces messages <traceId>

traces update

auvy traces update <traceId>

Options:

--data - JSON payload. If omitted, JSON may be read from stdin.
--fields - Comma-separated list of fields to return.
--title - Trace title override.

usage

Inspect usage and costs.

Command	Summary
`usage logs`	List workspace usage logs.
`usage ranking`	Rank receptors by workspace usage.
`usage user`	Get current user usage.
`usage workspace`	Get workspace usage.

usage logs

auvy usage logs <workspaceId>

Options:

--limit - Limit the number of results.
--offset - Skip the first N results.
--all - Fetch all results using pagination helpers when available.
--fields - Comma-separated list of fields to return.
--start-date - ISO start date.
--end-date - ISO end date.
--receptor-id - Filter by receptor ID.

usage ranking

auvy usage ranking <workspaceId>

Options:

--start-date - ISO start date.
--end-date - ISO end date.
--sort-by - Sort by tokens, cost, or invokeCount.
--fields - Comma-separated list of fields to return.

usage user

auvy usage user

Options:

--start-date - ISO start date.
--end-date - ISO end date.
--receptor-id - Filter by receptor ID.

usage workspace

auvy usage workspace <workspaceId>

Options:

--start-date - ISO start date.
--end-date - ISO end date.
--receptor-id - Filter by receptor ID.

CLI Reference

Documentation Index

​CLI Commands Reference

​Discovery

​Output Modes

​activity

​activity engrams

​api-config

​api-config cost-estimates

​api-config embedding-model

​api-config models

​commands

​commands list

​config

​config set

​config show

​docs

​health

​help

​jobs

​jobs cancel

​jobs get

​jobs input

​jobs list

​jobs resume

​jobs stream

​jobs wait

​login

​logout

​neurons

​neurons create

​neurons delete

​neurons get

​neurons list

​neurons reflexes

​neurons update

​pathways

​pathways create

​pathways delete

​pathways execute

​pathways get

​pathways list

​pathways update

​read

​receptors

​receptors delete

​receptors execute

​receptors get

​receptors list

​receptors patch

​receptors resolve

​receptors share

​recollections

​recollections by-owner

​recollections create

​recollections delete

​recollections get

​recollections link-memory

​recollections list

​recollections memory-counts

​recollections search

​recollections stats

​recollections unlink-memory

​reflexes

​reflexes connections

​reflexes create

​reflexes delete

​reflexes get

​reflexes list

​reflexes update

​schema

​schema commands

​schema output

​search

​store

​store bulk-delete

​store chunk

​store chunks

​store create

​store delete

CLI Commands Reference

Discovery

Output Modes

activity

activity engrams

api-config

api-config cost-estimates

api-config embedding-model

api-config models

commands

commands list

config

config set

config show

docs

health

help

jobs

jobs cancel

jobs get

jobs input

jobs list

jobs resume

jobs stream

jobs wait

login

logout

neurons

neurons create

neurons delete

neurons get

neurons list

neurons reflexes

neurons update

pathways

pathways create

pathways delete

pathways execute

pathways get

pathways list

pathways update

read

receptors

receptors delete

receptors execute

receptors get

receptors list

receptors patch

receptors resolve

receptors share

recollections

recollections by-owner

recollections create

recollections delete

recollections get

recollections link-memory

recollections list

recollections memory-counts

recollections search

recollections stats

recollections unlink-memory

reflexes

reflexes connections

reflexes create

reflexes delete

reflexes get

reflexes list

reflexes update

schema

schema commands

schema output

search

store

store bulk-delete

store chunk

store chunks

store create

store delete

store delete-chunks

store delete-chunks-by-source