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.

​
CLI Authentication

The CLI stores API-key credentials in ~/.auvy/config.encrypted and resolves workspace and brain defaults from saved config, flags, and environment variables.

​
API key source

Issue keys from the dashboard: Workspace Settings → API Keys at cortex.auvy.ai.

​
Login

auvy login --api-key ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
auvy login --api-key ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx --workspace-slug my-workspace --brain-id 00000000-0000-0000-0000-000000000000

​
Inspect and Update Config

auvy config show
auvy config set api-url https://api.auvy.ai
auvy config set workspace-slug my-workspace
auvy config set brain-id 00000000-0000-0000-0000-000000000000

​
Environment Fallback

If saved config is missing, the CLI reads:
  • AUVY_API_URL or NUXT_PUBLIC_AUVY_API_URL
  • AUVY_WORKSPACE_SLUG or NUXT_PUBLIC_AUVY_WORKSPACE_SLUG
  • AUVY_API_KEY, AUVY_PUBLISHABLE_KEY, or NUXT_PUBLIC_AUVY_PUBLISHABLE_KEY
  • AUVY_BRAIN_ID or NUXT_PUBLIC_AUVY_BRAIN_ID
Saved config wins over environment variables. Command flags win over saved defaults for the current invocation.

​
Validation Notes

  • API keys must start with ak_live_ when using auvy login.
  • Commands that need a workspace slug fail fast with a clear auth/config error if one cannot be resolved.