CLI Usage

smpsave-cli

Command line interface for smpsave. All subcommands use the configuration files in the present working directory.

smpsave-cli [OPTIONS] COMMAND [ARGS]...

Options

--save-logs

Write rotating log files under the ‘logs’ subdirectory.

discord

Starts the discord bot.

smpsave-cli discord [OPTIONS]

run

Re-run lifecycle hooks for a particular stage. For testing/development only.

smpsave-cli run [OPTIONS] LIFECYCLE

Arguments

LIFECYCLE

Required argument

start

Provision and start the gameserver.

smpsave-cli start [OPTIONS]

status

Check if the server is online, and if it is, print its IP address.

smpsave-cli status [OPTIONS]

stop

Stop and deprovision the gameserver. Pre-stop lifecycle hooks will back up the remote gameserver files to the local machine.

smpsave-cli stop [OPTIONS]

Options

-f, --force

Skip stop hooks and immediately deprovision the server. This destroys any data on the remote machine.