Command Line Reference

Common options

Option	Description
`-c`, `--config`	Path to the configuration file.	Defaults to: `./Sheepfile`
`-v`, `--verbose`	Set the log level to debug.

decrypt INPUT OUTPUT

Decrypt an encrypted backup file using the provided GPG private key. See our Introduction to encryption and Encrypt your backup files for more.

Option
`-k`, `--key`	The private key to use.	Required: yes

encrypt SECRET

Encrypt the provided secret using the provided GPG public key. See our Introduction to encryption and Encrypt your credentials for more.

Option	Description
`-k`, `--key`	The public key (at runtime, ESIO decrypts the secret will use the job's private key).	Required: yes
`-a`, `--standard-armor`	Do not strip PGP headers and carriage returns.	Defaults to: `false`

help [COMMAND]

Show general help message or help for a specific command.

restart

Stop the master process, if any, then start a new one and place it in the background. See the start command for a list of available options.

start

Start a master process and activate scheduling of the backup jobs. Whenever a schedule expires the master forks a worker to process the corresponding backup job.

Option	Description
`-f`, `--pidfile`	The path to the PID file of the master process	Defaults to: `./electric_sheep.pid`
`-l`, `--logfile`	The path to the log file	Defaults to: `./electric_sheep.log`
`-w`, `--workers`	The maximum number of workers to launch in parallel	Defaults to: `1`
`-d`, `--daemon`	Place the process in the background and return control to the terminal	Defaults to: `false`

The master process usually consumes less than 100 MB RAM, where workers may temporarily eat up to 500 MB when processing large files. You may increase the allowed number of parallel workers according to the resources available on the machine in which ESIO is run.

stop

Get the PID of an existing master process from the pidfile and sends it the TERM signal so that it stops gracefully.

Option	Description
`-f`, `--pidfile`	The path to the PID file of the master process	Defaults to: `./electric_sheep.pid`

version

Show the version number and the SHA-1 hash of the Git revision.

work

Run projects in the Sheepfile in sequence.

Option	Description
`-j`, `--job`	Name of a single job to execute	Defaults to: all jobs.