Usage: task [flags...] [task...]
Runs the specified task(s). Falls back to the "default" task if no task name
was specified, or lists all tasks if an unknown task name was specified.
Example: 'task hello' with the following 'Taskfile.yml' file will generate an
'output.txt' file with the content "hello".
'''
version: '3'
tasks:
hello:
cmds:
- echo "I am going to write a file named 'output.txt' now."
- echo "hello" > output.txt
generates:
- output.txt
'''
Options:
-c, --color Colored output. Enabled by default. Set flag to false or use NO_COLOR=1 to disable. (default true)
--completion string Generates shell completion script.
-C, --concurrency int Limit number of tasks to run concurrently.
-d, --dir string Sets the directory in which Task will execute and look for a Taskfile.
--disable-fuzzy Disables fuzzy matching for task names.
-n, --dry Compiles and prints tasks in the order that they would be run, without executing them.
-x, --exit-code Pass-through the exit code of the task command.
--experiments Lists all the available experiments and whether or not they are enabled.
-F, --failfast When running tasks in parallel, stop all tasks if one fails.
-f, --force Forces execution even when the task is up-to-date.
-g, --global Runs global Taskfile, from $HOME/{T,t}askfile.{yml,yaml}.
-h, --help Shows Task usage.
-i, --init Creates a new Taskfile.yml in the current folder.
--insecure Forces Task to download Taskfiles over insecure connections.
--interactive Prompt for missing required variables.
-I, --interval duration Interval to watch for changes.
-j, --json Formats task list as JSON.
-l, --list Lists tasks with description of current Taskfile.
-a, --list-all Lists tasks with or without a description.
--nested Nest namespaces when listing tasks as JSON
--no-status Ignore status when listing tasks as JSON
-o, --output string Sets output style: [interleaved|group|prefixed].
--output-group-begin string Message template to print before a task's grouped output.
--output-group-end string Message template to print after a task's grouped output.
--output-group-error-only Swallow output from successful tasks.
-p, --parallel Executes tasks provided on command line in parallel.
-s, --silent Disables echoing.
--sort string Changes the order of the tasks when listed. [default|alphanumeric|none].
--status Exits with non-zero exit code if any of the given tasks is not up-to-date.
--summary Show summary about a task.
-t, --taskfile string Choose which Taskfile to run. Defaults to "Taskfile.yml".
-v, --verbose Enables verbose mode.
--version Show Task version.
-w, --watch Enables watch of the given task.
-y, --yes Assume "yes" as answer to all prompts.
Options (35)
| Option | Description | Source |
|---|
-c, --color | Colored output. | help |
--completion string | Generates shell completion script. | help |
-C, --concurrency int | Limit number of tasks to run concurrently. | help |
-d, --dir string | Sets the directory in which Task will execute and look for a Taskfile. | help |
--disable-fuzzy | Disables fuzzy matching for task names. | help |
-n, --dry | Compiles and prints tasks in the order that they would be run, without executing them. | help |
-x, --exit-code | Pass-through the exit code of the task command. | help |
--experiments | Lists all the available experiments and whether or not they are enabled. | help |
-F, --failfast | When running tasks in parallel, stop all tasks if one fails. | help |
-f, --force | Forces execution even when the task is up-to-date. | help |
-g, --global | Runs global Taskfile, from $HOME/{T,t}askfile.{yml,yaml}. | help |
-h, --help | Shows Task usage. | help |
-i, --init | Creates a new Taskfile.yml in the current folder. | help |
--insecure | Forces Task to download Taskfiles over insecure connections. | help |
--interactive | Prompt for missing required variables. | help |
-I, --interval duration | Interval to watch for changes. | help |
-j, --json | Formats task list as JSON. | help |
-l, --list | Lists tasks with description of current Taskfile. | help |
-a, --list-all | Lists tasks with or without a description. | help |
--nested | Nest namespaces when listing tasks as JSON | help |
--no-status | Ignore status when listing tasks as JSON | help |
-o, --output string | Sets output style: [interleaved|group|prefixed]. | help |
--output-group-begin string | Message template to print before a task's grouped output. | help |
--output-group-end string | Message template to print after a task's grouped output. | help |
--output-group-error-only | Swallow output from successful tasks. | help |
-p, --parallel | Executes tasks provided on command line in parallel. | help |
-s, --silent | Disables echoing. | help |
--sort string | Changes the order of the tasks when listed. | help |
--status | Exits with non-zero exit code if any of the given tasks is not up-to-date. | help |
--summary | Show summary about a task. | help |
-t, --taskfile string | Choose which Taskfile to run. | help |
-v, --verbose | Enables verbose mode. | help |
--version | Show Task version. | help |
-w, --watch | Enables watch of the given task. | help |
-y, --yes | Assume "yes" as answer to all prompts. | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.