sake is a task runner for local and remote hosts
sake is a task runner for local and remote hosts.
You define servers and tasks in a sake.yaml config file and then run the tasks on the servers.
-c, --config string specify config
-u, --user-config string specify user config
--ssh-config string specify ssh config
--no-color disable color
-h, --help help for sake
Validate config
Validate config.
check [flags]
# Validate config
sake check
-h, --help help for check
Run tasks
Run tasks specified in a sake.yaml file.
run <task> [flags]
# Run task <task> for all servers
sake run <task> --all
# Run task <task> for servers <server>
sake run <task> --servers <server>
# Run task <task> for all servers that have tags <tag>
sake run <task> --tags <tag>
--dry-run print the task to see what will be executed
--describe print task information
--list-hosts print hosts that will be targetted
-V, --verbose enable all diagnostics
-S, --strategy string set execution strategy [linear|host_pinned|free]
-f, --forks uint32 max number of concurrent processes (default 10000)
-b, --batch uint32 set number of hosts to run in parallel
-B, --batch-p uint8 set percentage of hosts to run in parallel [0-100]
-a, --all target all hosts
-v, --invert invert matching on hosts
-r, --regex string target hosts on host regex
-s, --servers strings target servers by names
-t, --tags strings target hosts by tags
-T, --target string target hosts by target name
--order string order hosts
-l, --limit uint32 set limit of servers to target
-L, --limit-p uint8 set percentage of servers to target [0-100]
--ignore-unreachable ignore unreachable hosts
-M, --max-fail-percentage uint8 stop task execution on all servers when threshold reached
--any-errors-fatal stop task execution on all servers on error
--ignore-errors continue task execution on errors
-J, --spec string set spec
-o, --output string set task output [text|table|table-2|table-3|table-4|html|markdown|json|csv|none]
-p, --print string set print [all|stdout|stderr]
--omit-empty-rows omit empty row for table output
--omit-empty-columns omit empty column for table output
-q, --silent omit showing loader when running tasks
--confirm confirm root task before running
--step confirm each task before running
--tty replace the current process
--attach ssh to server after command
--local run task on localhost
--theme string set theme (default "default")
-e, --edit edit task
-R, --report strings reports to show (default [recap])
-i, --identity-file string set identity file
-U, --user string set ssh user
--password string set ssh password
--known-hosts-file string set known hosts file
-h, --help help for run
Execute arbitrary commands
Execute arbitrary commands.
Single quote your command if you don't want the file globbing and environments variables expansion to take place before the command gets executed in each directory.
exec <command> [flags]
# List files in all servers
sake exec --all ls
# List git files that have markdown suffix for all servers
sake exec --all 'git ls-files | grep -e ".md"'
--dry-run prints the command to see what will be executed
--describe print task information
--list-hosts print hosts that will be targetted
-V, --verbose enable all diagnostics
-S, --strategy string set execution strategy [linear|host_pinned|free]
-f, --forks uint32 max number of concurrent processes (default 10000)
-b, --batch uint32 set number of hosts to run in parallel
-B, --batch-p uint8 set percentage of servers to run in parallel [0-100]
-a, --all target all servers
-v, --invert invert matching on servers
-r, --regex string filter servers on host regex
-s, --servers strings target servers by names
-t, --tags strings target servers by tags
-T, --target string target servers by target name
--order string order hosts
-l, --limit uint32 set limit of servers to target
-L, --limit-p uint8 set percentage of servers to target
--ignore-unreachable ignore unreachable hosts
-M, --max-fail-percentage uint8 stop task execution on all servers when threshold reached
--any-errors-fatal stop task execution on all servers on error
--ignore-errors continue task execution on errors
-J, --spec string set spec
-o, --output string set task output [text|table|table-2|table-3|table-4|html|markdown|json|csv|none]
-p, --print string set print [all|stdout|stderr]
--omit-empty-rows omit empty row for table output
--omit-empty-columns omit empty column for table output
-q, --silent omit showing loader when running tasks
--confirm confirm root task before running
--step confirm each task before running
--tty replace the current process
--attach ssh to server after command
--local run command on localhost
--theme string set theme (default "default")
-R, --report strings reports to show (default [recap])
-i, --identity-file string set identity file for all servers
-U, --user string set ssh user
--password string set ssh password for all servers
--known-hosts-file string set known hosts file
-h, --help help for exec
Initialize sake in the current directory
Initialize sake in the current directory.
init [flags]
# Basic example
sake init
-h, --help help for init
Open up sake config file in $EDITOR
Open up sake config file in $EDITOR.
edit [flags]
# Edit current context
sake edit
-h, --help help for edit
Edit server
Open up sake config file in $EDITOR and go to servers section.
edit server [server] [flags]
# Edit servers
sake edit server
# Edit server <server>
sake edit server <server>
-h, --help help for server
Edit spec
Open up sake config file in $EDITOR and go to specs section.
edit spec [spec] [flags]
# Edit specs
sake edit spec
# Edit spec <spec>
sake edit spec <spec>
-h, --help help for spec
Edit target
Open up sake config file in $EDITOR and go to targets section.
edit target [target] [flags]
# Edit targets
sake edit target
# Edit target <target>
sake edit target <target>
-h, --help help for target
Edit task
Open up sake config file in $EDITOR and go to tasks section.
edit task [task] [flags]
# Edit tasks
sake edit task
# Edit task <task>
sake edit task <task>
-h, --help help for task
List servers
List servers.
list servers [servers] [flags]
# List all servers
sake list servers
# List servers <server>
sake list servers <server>
# List servers that have tag <tag>
sake list servers --tags <tag>
-v, --invert invert matching on servers
-r, --regex string filter servers on host regex
-t, --tags strings filter servers by tags
-H, --all-headers select all server headers
--headers strings set headers (default [server,host,tags,desc])
-h, --help help for servers
-o, --output string set table output [table|table-2|table-3|table-4|html|markdown|json|csv] (default "table")
--theme string set theme (default "default")
List tasks
List tasks.
list tasks [tasks] [flags]
# List all tasks
sake list tasks
# List task <task>
sake list task <task>
-H, --all-headers select all task headers
--headers strings set headers (default [task,desc])
-h, --help help for tasks
-o, --output string set table output [table|table-2|table-3|table-4|html|markdown|json|csv] (default "table")
--theme string set theme (default "default")
List tags
List tags.
list tags [tags] [flags]
# List all tags
sake list tags
--headers strings set headers (default [tag,server])
-h, --help help for tags
-o, --output string set table output [table|table-2|table-3|table-4|html|markdown|json|csv] (default "table")
--theme string set theme (default "default")
List targets
List targets.
list targets [targets] [flags]
# List all targets
sake list targets
--headers strings set headers. Available headers: name, regex (default [target,desc,all,servers,tags,regex,invert,limit,limit_p])
-h, --help help for targets
-o, --output string set table output [table|table-2|table-3|table-4|html|markdown|json|csv] (default "table")
--theme string set theme (default "default")
List specs
List specs.
list specs [specs] [flags]
# List all specs
sake list specs
--headers strings set headers (default [spec,desc,describe,list_hosts,order,silent,hidden,strategy,batch,batch_p,forks,output,print,any_errors_fatal,max_fail_percentage,ignore_errors,ignore_unreachable,omit_empty,report,verbose,confirm,step])
-h, --help help for specs
-o, --output string set table output [table|table-2|table-3|table-4|html|markdown|json|csv] (default "table")
--theme string set theme (default "default")
Describe servers
Describe servers.
describe servers [servers] [flags]
# Describe all servers
sake describe servers
# Describe servers that have tag <tag>
sake describe servers --tags <tag>
-t, --tags strings filter servers by their tag
-r, --regex string filter servers on host regex
-v, --invert invert matching on servers
-e, --edit edit server
-h, --help help for servers
Describe tasks
Describe tasks.
describe tasks [tasks] [flags]
# Describe all tasks
sake describe tasks
# Describe task <task>
sake describe task <task>
-e, --edit edit task
-h, --help help for tasks
Describe targets
Describe targets.
describe targets [targets] [flags]
# Describe all targets
sake describe targets
-e, --edit edit target
-h, --help help for targets
Describe specs
Describe specs.
describe specs [specs] [flags]
# Describe all specs
sake describe specs
-e, --edit edit spec
-h, --help help for specs
ssh to server
ssh to server.
ssh <server> [flags]
# ssh to server
sake ssh <server>
-i, --identity-file string set identity file for all servers
--password string set ssh password for all servers
-h, --help help for ssh
Generate man page
Generate man page
gen [flags]
-d, --dir string directory to save manpage to (default "./")
-h, --help help for gen