CLI Reference | PraisonAIUI Docs

CLI ReferenceComplete reference for the aiui command-line interface.Core Commands`aiui run`The primary command — run an AI server with your app.py or chat.yaml.| Option | Description | Default ||--------|-------------|---------|| FILE | Python file (app.py) or YAML config (chat.yaml) | required || --port, -p | Server port | 8000 || --host | Bind address | 127.0.0.1 || --reload | Auto-reload on file changes | false || --style, -s | UI style: chat, dashboard, agents, playground, docs, custom | chat || --backend | AI backend: praisonai, default | default || --workers | Number of workers | 1 || --ssl-certfile | SSL certificate for HTTPS | — || --ssl-keyfile | SSL private key for HTTPS | — |Examples:`aiui validate`Validate your configuration file.| Option | Description | Default ||--------|-------------|---------|| --config, -c | Path to config file | aiui.template.yaml || --strict | Enable strict validation | false |---`aiui build`Build manifests from configuration (for docs/static site mode).| Option | Description | Default ||--------|-------------|---------|| --config, -c | Path to config file | aiui.template.yaml || --output, -o | Output directory | aiui || --minify | Minify JSON output | false |---`aiui serve`Serve the built site locally with a production-ready HTTP server.| Option | Description | Default ||--------|-------------|---------|| --config, -c | Path to config file | aiui.template.yaml || --port, -p | Server port | 8000 || --host | Bind address | 127.0.0.1 || --reload | Watch for changes and rebuild | false || --style, -s | UI style override | auto-detected || --ssl-certfile | SSL certificate for HTTPS | — || --ssl-keyfile | SSL private key for HTTPS | — |---`aiui dev`Development dashboard — switch between examples live.| Option | Description | Default ||--------|-------------|---------|| --examples, -e | Directory containing example projects | examples || --port, -p | Port for dev server | 9000 |---`aiui doctor`Run structured diagnostics against a running AIUI server.| Option | Description | Default ||--------|-------------|---------|| --server, -s | Server URL to diagnose | http://127.0.0.1:8000 || --json | Output results as JSON | false |Checks: health, provider, gateway, features, config, datastore, channels.---`aiui test`Run integration tests against a running server.| Suite | Description ||-------|-------------|| chat | Chat WebSocket send/receive || memory | Memory CRUD operations || sessions | Session management || endpoints | API endpoint availability || all | Run all test suites |---Management CommandsAll management commands connect to a running server (default http://127.0.0.1:8000). Use --server URL to target a different server.`aiui sessions``aiui memory``aiui skills``aiui provider``aiui config``aiui schedule``aiui approval``aiui workflows``aiui hooks``aiui eval``aiui traces``aiui pages``aiui features``aiui health-check`Check server health. Can also be invoked as aiui health for convenience.`aiui session-ext`Extended session operations:---Exit Codes| Code | Meaning ||------|---------|| 0 | Success || 1 | Configuration error || 2 | File not found || 3 | Build error |Environment Variables| Variable | Description | Default ||----------|-------------|---------|| OPENAI_API_KEY | OpenAI API key | — || PRAISONAI_MODEL | Default model | gpt-4o-mini || AIUI_DATA_DIR | Data directory | ~/.praisonaiui || AIUI_CONFIG | Config file path | aiui.template.yaml || AIUI_OUTPUT | Build output dir | aiui |