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:
Authentication
AUI supports three authentication methods:
Browser (Default)
Email + OTP
Access Token
API Key
Opens the AUI playground login page. Your token is received automatically via a local callback.The CLI will open your browser. Sign in, and you’ll be redirected back automatically. Enter your email, then paste the verification code sent to your inbox.aui login --email user@example.com
Paste a JWT directly — useful for CI/CD or when copying from browser DevTools. Authenticate with an API key and account ID.aui login --api-key <key> --account-id <id>
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
Verify your session
You should see your account info, active agent, and current environment. 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.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:
This removes all stored sessions, API keys, and cached schemas. You’ll need to run aui login again.
Next Steps