Skip to main content

​
Quick Reference

CommandAliasDescription
aui loginAuthenticate with the AUI platform
aui logoutClear session and credentials
aui envShow or switch environment
aui statusDisplay session and project info
aui agentsaui agentManage agents
aui list-agentsaui lsQuick table of all agents
aui accountaui accountsManage accounts
aui import-agentaui importDownload agent config locally
aui create-agentScaffold a new agent project
aui pushUpload local changes to backend
aui diffCompare agent configurations
aui dvalidateValidate .aui.json files
aui pull-schemaFetch latest domain schemas
aui chatInteractive terminal chat
aui serveWeb-based chat playground
aui ragManage knowledge bases
aui add-integrationAdd integration to agent

​
Authentication & Session

Authenticate with the AUI platform.
aui login
aui login --email user@example.com
aui login --token <jwt>
aui login --api-key <key> --account-id <id>
OptionDescription
--email <email>Authenticate with email + OTP
--token <jwt>Authenticate with an access token
--environment <env>Target environment (staging, custom, production)
--account-id <id>Pre-select account
--api-key <key>Use API key authentication
--url <url>Override API base URL
Clear the local session and stored credentials.
aui logout
Show or switch the active environment.
aui env              # Show current environment
aui env staging      # Switch to staging
aui env production   # Switch to production
aui env custom       # Switch to custom
The active environment is stored in ~/.aui/environment.
Display current session info, linked agent, and a summary of local project files.
aui status

​
Agent Management

Manage agents interactively. Alias: aui agent.
aui agents              # Interactive agent menu
aui agents --list       # List all agents in the account
aui agents --create     # Create a new agent
aui agents --switch     # Switch to a different agent
aui agents --import     # Import an agent locally
OptionDescription
--listList all agents
--createCreate a new agent interactively
--switchSwitch active agent
--importImport agent config files
Quick table view of all agents in the current account. Alias: aui ls.
aui ls
Manage accounts (projects). Alias: aui accounts.
aui account              # Interactive account menu
aui account --list       # List all accounts
aui account --create <name>   # Create a new account
aui account --switch     # Switch active account
OptionDescription
--listList all accounts
--create <name>Create a new account with the given name
--switchSwitch active account

​
Import & Create

Download an agent’s configuration as local .aui.json files. Alias: aui import.
aui import-agent                  # Import the currently selected agent
aui import-agent <agent-id>      # Import a specific agent by ID
aui import-agent --dir ./my-agent # Import into a specific directory
OptionDescription
--dir <path>Target directory for imported files
--api-key <key>Use API key instead of session token
Downloads from 6 backend endpoints: general settings, parameters, entities, integrations, tools, and rules. Also fetches JSON schemas for editor autocomplete and generates a GUIDE.md.
Scaffold a new blank agent project with example files.
aui create-agent              # Scaffold in current directory
aui create-agent ./my-agent   # Scaffold in a specific directory
aui create-agent --force      # Overwrite existing files
OptionDescription
--forceOverwrite existing project files

​
Push, Diff & Validate

Upload local changes to the AUI backend.
aui push
aui push --dry-run
aui push --force
OptionDescription
--dry-runShow what would be pushed without making changes
--forcePush all files, not just changed ones
--skip-validationSkip local validation before pushing
--api-key <key>Use API key instead of session token
Push uses smart patching: PATCH for modified fields, POST for new tools, PUT (upsert) for parameters, entities, and rules. Changes are detected via git diff against the last push baseline.
Compare two agent configurations, or show changes since the last import/push.
aui diff                 # Show local changes since import
aui diff a.json b.json   # Compare two files
Validate .aui.json files against domain schemas.
aui dvalidate                    # Validate all files in current directory
aui dvalidate ./agent.aui.json   # Validate a specific file
aui dvalidate --verbose          # Show detailed validation output
OptionDescription
--verboseShow detailed validation messages
Performs:
  • JSON syntax checking
  • Required fields validation
  • Cross-reference integrity (e.g., tools referencing valid integrations)
Fetch the latest domain schemas (.dschema.json) from the backend for local validation and editor autocomplete.
aui pull-schema
aui pull-schema --improved
OptionDescription
--api-key <key>Use API key instead of session token
--improvedFetch improved schemas optimized for coding agents

​
Development & Testing

Start an interactive conversation with an AUI agent in the terminal.
aui chat
aui chat --rest            # Use REST API instead of WebSocket
aui chat --user-id <id>    # Set a custom user ID
OptionDescription
--api-key <key>Use API key instead of session token
--env <env>Target environment
--user-id <id>Custom user identifier
--restUse REST fallback instead of WebSocket streaming
Features:
  • Real-time streaming via WebSocket
  • Inline product cards with images
  • AI-generated follow-up suggestions
See Chat Commands for in-session commands.
Launch a web-based chat playground on localhost.
aui serve
aui serve --port 4000
aui serve --no-open
OptionDescription
--port <number>Port to run the server on (default: 3000)
--no-openDon’t auto-open the browser

​
Agent Configuration

Manage RAG (Retrieval-Augmented Generation) knowledge bases.
aui rag                    # Interactive RAG management menu
aui rag --add-file         # Upload a file to a knowledge base
OptionDescription
--add-fileUpload a file or URL to a knowledge base
Capabilities:
  • List knowledge bases
  • Upload files and URLs
  • Export knowledge base content
  • Bulk-edit knowledge base entries
The RAG API key is stored securely at ~/.aui/kbm-key (file mode 600).
Add an integration (API, RAG, or MCP) to the current agent project interactively.
aui add-integration
Walks you through selecting the integration type and configuring it.