Avular CLI

The avular command-line interface is a tool to manage the onboard computing module. It can be used to manage the Docker containers, connectivity settings, and more.

To view the help page of the script, execute: avular -h.

Command	Description
ap	Manage the access point settings.
compose	Manage robot application containers.
config	Change or view system settings.
demo	Manage demo applications.
help	Show help for the Avular CLI.
mode	Manage the running mode of the containers.
status	Show the status of the robot.
teleport	Manage the Teleport service.
update	Update components of your robot.
wifi	Manage the WiFi client settings.

Access Point

The ap command can be used to manage the access point settings of the robot. To enable the access point, execute: avular ap enable. To disable the access point, execute: avular ap disable. The Vertex Gen 4 can have both the access point and the WiFi client enabled at the same time.

Wifi

The wifi command can be used to manage the WiFi client settings of the robot. To connect to a WiFi network, execute avular wifi connect <SSID> <password>. To disconnect from the WiFi network execute: avular wifi disconnect.

Compose

The compose command can be used to manage the robot application containers. To start the containers, execute: avular compose start. To stop the containers, execute: avular compose stop. To show the status of the containers, execute: avular compose show. To show the logs of the containers, execute: avular compose logs. To enter a running container, execute: avular compose enter <container_name>.

To view the compose configuration files, execute: avular compose config. This will open a shell session in the docker-compose files directory. Add your custom application containers to those files to make them part of the avular compose group.