Skip to main content

CLI Overview

The mac command-line tool is installed by the MAC Debian package at /usr/bin/mac. It is the supported way to start, stop, configure, and inspect MAC services on each host. The same binary is used on Master and Agent nodes — the role is selected at start time.

Tab completion is registered automatically; press <Tab> after mac to see all subcommands. Every command also accepts -h / --help for its own usage and flags (e.g. mac start --help).

Command Summary

CommandPurpose
mac pullPull container images from the configured registry
mac buildBuild MAC images locally from a source checkout
mac startStart MAC services in all, master, or agent mode
mac stopStop running MAC services
mac restartStop + start MAC services in one step
mac statusList all MAC containers (running and stopped)
mac logsTail logs for MAC containers
mac infoPrint version, host details, config dir, GPU profile
mac testRun operator tests (default: cluster-wide sanity check)
mac cleanRemove all MAC containers, networks, volumes, images
mac envShow or modify MAC environment variables
mac version (-v, --version)Print the CLI version and exit

mac pull, mac start, and mac restart accept --local / --registry flags to select between locally-built and published images — see Environment → MAC_IMAGE_SOURCE.

Where to Go