Skip to content

Command line

rungar is the daemon and its command line in one binary. rungar serve runs the daemon; rungar validate and rungar config read a configuration file and need nothing else. Every other command asks the running daemon, through its socket, which root and the rungar group alone may use: run them with sudo -u rungar, or as root.

Commands

Running the daemon

CommandDescription
rungar serveRun the daemon.

Checking a configuration

CommandDescription
rungar validateCheck a configuration file, without contacting GitHub or any provider.
rungar configPrint a configuration file as the daemon would run it, in YAML.
rungar config migrateRewrite a configuration file for this version of Rungar.

Seeing what the daemon does

CommandDescription
rungar statusShow what the daemon is doing: its scale sets, providers and runners.
rungar eventsShow what the daemon has done to runners, providers and scale sets, and why.

Changing what the daemon does

CommandDescription
rungar scale-setsList, inspect, pause, resume and remove scale sets.
rungar scale-sets inspectShow one scale set: in the configuration, in the daemon, on GitHub, and its runners.
rungar scale-sets lsList the configured scale sets, and those found only by their runners.
rungar scale-sets pauseStop a scale set taking jobs, leaving its busy runners to finish.
rungar scale-sets resumeHave a paused scale set take jobs again.
rungar scale-sets rmRemove a scale set that is no longer configured: its runners, then the scale set on GitHub.
rungar providersList, inspect, disable, drain and enable providers.
rungar providers disableTake a provider out of placement, leaving its runners to finish.
rungar providers drainDisable a provider, and wait until its runners are gone.
rungar providers enablePut a provider back into placement.
rungar providers inspectShow one provider: its status, the scale sets on it, and its runners.
rungar providers lsList providers: their status, runners, weight and scale sets.
rungar runnersList and remove runners.
rungar runners lsList runners: their machines, what the daemon knows of them, what GitHub says, and their jobs.
rungar runners rmRemove runners, the safe way round.
rungar reconcileHave the daemon compare scale sets with the fleet now.

Global flags

FlagDescription
--socket stringThe daemon’s socket (default $RUNGAR_SOCKET, or /run/rungar/rungar.sock).

The commands that ask the daemon take --socket; every command takes -h, --help.

rungar --version prints the version.