Skip to content

CLI#

The Engine AI CLI provides a comprehensive command-line interface for managing your dashboards, applications, workspaces, and groups. The CLI is designed to streamline development workflows and enable programmatic access to the Engine AI platform.

Authentication#

The Engine AI CLI handles authentication automatically. When you run any command that requires authentication, the CLI will:

  1. Check for existing credentials in the ~/.engineai folder
  2. Automatically trigger browser authentication if no valid token is found
  3. Store the authentication token locally for future use

You can also manually authenticate at any time:

engineai login

This automatic authentication workflow means you don't need to worry about logging in before running commands - the CLI will handle it seamlessly when needed.

Command Structure#

The Engine AI CLI follows a hierarchical command structure:

engineai [COMMAND] [SUBCOMMAND] [OPTIONS] [ARGS]

Getting Help#

Each command and subcommand provides detailed help information:

# Get general help
engineai --help

# Get help for a specific command
engineai dashboard --help

# Get help for a specific subcommand
engineai dashboard create --help

Command Reference#

For detailed information about each command and its available options, see the individual command documentation:

  • login - Authentication and login management
  • workspace - Workspace administration
  • app - Application management
  • dashboard - Dashboard creation and deployment
  • group - Group and member management

Error Handling#

The CLI provides detailed error messages to help troubleshoot issues. Common error scenarios include:

  • Authentication errors: The CLI will automatically trigger browser authentication if needed, but you can also manually run engineai login
  • Permission errors: Verify you have the necessary permissions for the workspace/app
  • Network errors: Check your internet connection and platform availability

For persistent issues, check the SDK troubleshooting guide.