Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aui.io/llms.txt

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

​
System Requirements

  • Node.js 18 or later
  • npm (included with Node.js)
  • Git (used for change detection in aui push and aui diff)

​
Install

npm install -g aui-agent-builder
Verify the installation: 
aui --version

​
Authentication

AUI supports three authentication methods:
Opens the AUI playground login page. Your token is received automatically via a local callback.
aui login
The CLI will open your browser. Sign in, and you’ll be redirected back automatically.
After authenticating, the CLI walks you through selecting your Organization, Account, and Agent.
Session credentials are stored in ~/.aui/session.json. They persist across terminal sessions.

​
Post-Login Setup

1

Verify your session

aui status
You should see your account info, active agent, and current environment.
2

Set your environment

aui env staging      # Development and testing
aui env production   # Live environment
aui env custom       # Custom environment
The active environment is stored in ~/.aui/environment.
3

Import or create an agent

# Import an existing agent
aui import-agent

# Or scaffold a new one
aui create-agent ./my-agent

​
Uninstall

npm uninstall -g aui-agent-builder
To remove stored credentials and session data: 
rm -rf ~/.aui
This removes all stored sessions, API keys, and cached schemas. You’ll need to run aui login again.

​
Next Steps

Command Reference

Full reference for all CLI commands.

Configuration

Project structure, config files, and environment variables.