backy/docs/content/cli/_index.md
Andrew Woodlee 4b382bddd9 v0.3.0
* Getting environment variables and passwords from Vault (not tested
yet)
* Vault configuration to config (not tested yet)
* Ability to run scripts from file on local machine on the remote host
* Ability to get ouput in the notification of a list for individual
commands or all commands
* Make SSH connections close after all commands have been run; reuse
previous connections if needed
2023-07-01 21:46:54 -05:00

2.2 KiB

title weight
CLI 4

This page lists documentation for the CLI.

Backy

Backy is a command-line application useful for configuring backups, or any commands run in sequence.

Usage:
  backy [command]

Available Commands:
  backup      Runs commands defined in config file.
  completion  Generate the autocompletion script for the specified shell
  cron        Starts a scheduler that runs lists defined in config file.
  exec        Runs commands defined in config file in order given.
  help        Help about any command
  version     Prints the version and exits

Flags:
  -f, --config string   config file to read from
  -h, --help            help for backy
  -v, --verbose         Sets verbose level

Use "backy [command] --help" for more information about a command.

Subcommands

backup

Backup executes commands defined in config file.
Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.

Usage:
  backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags]

Flags:
  -h, --help            help for backup
  -l, --lists strings   Accepts comma-separated names of command lists to execute.

Global Flags:
  -f, --config string   config file to read from
  -v, --verbose         Sets verbose level

cron

Cron starts a scheduler that executes command lists at the time defined in config file.

Usage:
  backy cron [flags]

Flags:
  -h, --help   help for cron

Global Flags:
  -f, --config string   config file to read from
  -v, --verbose         Sets verbose level

exec

Exec executes commands defined in config file in order given.

Usage:
  backy exec command ... [flags]

Flags:
  -h, --help   help for exec

Global Flags:
  -f, --config string   config file to read from
  -v, --verbose         Sets verbose level

version

Prints the version and exits. No arguments just prints the version number only.

Usage:
  backy version [flags]

Flags:
  -h, --help   help for version
  -n, --num    Output the version number only. (default true)
  -V, --vpre   Output the version with v prefixed.

Global Flags:
  -f, --config string   config file to read from
  -v, --verbose         Sets verbose level