CyberShell/backy
1
1
Fork 0
Code Issues 8 Pull Requests Packages Projects 1 Releases 20 Wiki Activity

v0.7.0 update docs
All checks were successful
ci/woodpecker/push/publish-docs Pipeline was successful
Details

Browse Source
This commit is contained in:
Andrew Woodlee 2025-02-11 22:00:10 -06:00
parent 127d38c076
commit 6ee6e10621
1 changed files with 37 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/content/cli/_index.md
View File

@ -14,7 +14,7 @@ Usage:
backy [command] backy [command]
Available Commands: Available Commands:
backup Runs commands defined in config file. backup Runs commands defined in config file. Use -l flag multiple times to run multiple lists.
completion Generate the autocompletion script for the specified shell completion Generate the autocompletion script for the specified shell
cron Starts a scheduler that runs lists defined in config file. cron Starts a scheduler that runs lists defined in config file.
exec Runs commands defined in config file in order given. exec Runs commands defined in config file in order given.
@ -23,9 +23,11 @@ Available Commands:
version Prints the version and exits version Prints the version and exits
Flags: Flags:
-f, --config string config file to read from -f, --config string config file to read from
-h, --help help for backy -h, --help help for backy
-v, --verbose Sets verbose level --log-file string log file to write to
--s3-endpoint string Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
-v, --verbose Sets verbose level
Use "backy [command] --help" for more information about a command. Use "backy [command] --help" for more information about a command.
``` ```
@ -39,15 +41,17 @@ 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. Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.
Usage: Usage:
backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags] backy backup [--lists=list1 --lists list2 ... | -l list1 -l list2 ...] [flags]
Flags: Flags:
-h, --help help for backup -h, --help help for backup
-l, --lists strings Accepts comma-separated names of command lists to execute. -l, --lists stringArray Accepts comma-separated names of command lists to execute.
Global Flags: Global Flags:
-f, --config string config file to read from -f, --config string config file to read from
-v, --verbose Sets verbose level --log-file string log file to write to
--s3-endpoint string Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
-v, --verbose Sets verbose level
``` ```
## cron ## cron
@ -62,8 +66,10 @@ Flags:
-h, --help help for cron -h, --help help for cron
Global Flags: Global Flags:
-f, --config string config file to read from -f, --config string config file to read from
-v, --verbose Sets verbose level --log-file string log file to write to
--s3-endpoint string Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
-v, --verbose Sets verbose level
``` ```
## exec ## exec
@ -82,8 +88,10 @@ Flags:
-h, --help help for exec -h, --help help for exec
Global Flags: Global Flags:
-f, --config string config file to read from -f, --config string config file to read from
-v, --verbose Sets verbose level --log-file string log file to write to
--s3-endpoint string Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
-v, --verbose Sets verbose level
Use "backy exec [command] --help" for more information about a command. Use "backy exec [command] --help" for more information about a command.
``` ```
@ -95,16 +103,18 @@ Host executes specified commands on the hosts defined in config file.
Use the --commands or -c flag to choose the commands. Use the --commands or -c flag to choose the commands.
Usage: Usage:
backy exec host [--commands=command1,command2, ... | -c command1,command2, ...] [--hosts=host1,hosts2, ... | -m host1,host2, ...] [flags] backy exec host [--command=command1 --command=command2 ... | -c command1 -c command2 ...] [--hosts=host1 --hosts=hosts2 ... | -m host1 -m host2 ...] [flags]
Flags: Flags:
-c, --commands strings Accepts comma-separated names of commands. -c, --command stringArray Accepts space-separated names of commands. Specify multiple times for multiple commands.
-h, --help help for host -h, --help help for host
-m, --hosts strings Accepts comma-separated names of hosts. -m, --hosts stringArray Accepts space-separated names of hosts. Specify multiple times for multiple hosts.
Global Flags: Global Flags:
-f, --config string config file to read from -f, --config string config file to read from
-v, --verbose Sets verbose level --log-file string log file to write to
--s3-endpoint string Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
-v, --verbose Sets verbose level
``` ```
## version ## version
@ -121,8 +131,10 @@ Flags:
-V, --vpre Output the version with v prefixed. -V, --vpre Output the version with v prefixed.
Global Flags: Global Flags:
-f, --config string config file to read from -f, --config string config file to read from
-v, --verbose Sets verbose level --log-file string log file to write to
--s3-endpoint string Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
-v, --verbose Sets verbose level
``` ```
## list ## list
@ -140,6 +152,8 @@ Flags:
-l, --lists strings Accepts comma-separated names of command lists to list. -l, --lists strings Accepts comma-separated names of command lists to list.
Global Flags: Global Flags:
-f, --config string config file to read from -f, --config string config file to read from
-v, --verbose Sets verbose level --log-file string log file to write to
--s3-endpoint string Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
-v, --verbose Sets verbose level
``` ```