rovercli

A command line interface and Textual TUI for UBC Rover operations.

Installation

From the repository root, install the package:

python -m pip install -e . --break-system-packages

This installs Textual and creates the rovercli terminal command. Running rovercli without arguments opens the TUI.

If rovercli is not already on your PATH, run the setup script after installation. It detects whether zsh or bash is being used and updates the corresponding shell configuration file:

bash ./add-rovercli-to-path.sh

To update the current shell immediately, source the script instead:

source ./add-rovercli-to-path.sh

Commands

setup

This command sets up the RoverFlake2 repo.

rovercli setup --distro jazzy

tui

rovercli
rovercli tui

sync

Sync files between devices on the UBC Rover network, without unecessary copying of files that haven't changed.

rovercli sync --src-root RoverFlake2 --dst-root RoverFlake2 --remote-host rv@192.168.1.4

Other commands are rovercli print-ip-table and rovercli time-sync.

docker

Start the Docker Compose rover service using the configuration selected for the host OS, then open a shell in the container:

rovercli docker

By default, an existing image is reused and Compose builds it if it is missing. Pass --rebuild to rebuild the image, or --roverflake-path <path-to-RoverFlake2> to build from and mount a local checkout. Containers persist after you exit, so later launches reuse the same container. Use --container-name <name> to maintain multiple independent containers. If multiple named RoverCLI containers exist and no name is provided, the CLI prompts you to choose one. Pass --kill-all to kill every running container on the active Docker daemon; this also affects containers unrelated to Rover. See DockerInstallation.md for host-specific GUI setup.