The command line interface (CLI) is used to manage aiWARE services and systems.
aiware-agent is the application that starts, stops, and monitors services running on a host. All other subsystems are launched by aiware-agent as Docker containers. aiware-agent is responsible for the installation and management of all aiWARE subsystems, and provides environment and installation parameters when a subsystem is launched.
ai leverages a configuration file, ~/.config/aiware-cli.yaml, for the connection profiles including the default.
Example config:
profiles:
default:
url: https://localhost:9000/edge/v1
token: 12345678-1234-1234-1234-123456789497
core-url: https://api.veritone.com/v3/graphql
core-token: sso-token:12345678
clusterid: rt-1cdc1d6d-a500-467a-1234-d3c5bf3d6999
hub-url: https://hub.aiware.com/hub/v1
host-type-id: 791790c9-bfea-4bc3-bd1f-6232b0f55dbc
format: text
ai [flags]
Options
-c, --config string CLI Config file to use. By default it will be /home/ubuntu/.config/aiware-cli.yaml
--controller-token string Bearer token to use for authenticating operations.
--controller-url string Controller URL to use for the CLI. If specified, this will be used instead of what is in the configuration. (default "http://localhost:9000/edge/v1")
-d, --debug Enables debug output
-f, --format string The output format. The values are text, log or json.
-h, --help help for ai
--host-type-id string Host type ID of the host
--hub-url string aiWARE Hub URL
-p, --profile string The profile to use. If not specified, the profile named 'default' will be used. The profiles are set in ~/.config/aiware-cli.yaml (default "default")
-q, --quiet Disables output extra output except the main output
--sample-app Indicates whether it should install the sample app
CLI docs
- ai admin - Contains administrative subcommands.
- ai agent - Initializes edge services, monitors host stats, launches, terminates and monitors docker containers
- ai aiware-core - Contains subcommands to perform operations on core
- ai build - Contains subcommands for engine builds.
- ai check - Check the system for initial problems running aiWARE
- ai cloud - Cloud and scaling operations
- ai cluster - Contains commands to interact with cluster.
- ai completion - Generate the autocompletion script for the specified shell
- ai config - Contains commands to list, get and set configuration values for the edge cluster.
- ai core - Contains sub-commands to manage the aiWARE Core service
- ai dag - Contains subcommands to perform dag operations such as create, start, stop, update, pause, and unpause a DAG
- ai diagnostics - Troubleshooting and diagnotics commands.
- ai endpoint - Contains commands supporting endpoints
- ai engine - Contains subcommands get and alter engine information.
- ai engine-category - Contains subcommands to list, delete and load engine categories.
- ai engine-instance - Contains subcommands for engine instances.
- ai engine-template - Contains subcommands to list, delete and load engine templates.
- ai host - Contains subcommands to assign, terminate, reboot, drain and show statistics of a host
- ai hub - Contains subcommands to manipulate hub.
- ai install - Installs the specified aiWARE services and resources.
- ai job - Contains subcommands to create, update, get, cancel and delete jobs
- ai license - Contains subcommands to manipulate licenses.
- ai org - Contains subcommands to create, delete and update organizations.
- ai profile - CRUD actions on aiware-cli.yaml file
- ai schedule - Contains subcommands to perform schedule operations
- ai scheduled-job - Contains subcommands to list and delete scheduled jobs.
- ai services - Contains subcommands to update, list and delete services.
- ai setup - Contains subcommands to perform setup operations
- ai stats - Returns stats of the host and the docker containers it is running.
- ai task - Contains subcommands to perform task operations
- ai template - Contains subcommands to perform template operations
- ai test - CLI Test Framework
- ai tools - Admin tools
- ai users - aiWARE users
