Task

https://taskfile.dev/
Admin
Task is a fast, cross-platform build tool inspired by Make that enables modern workflows with smart...
Tokens:93,723
Snippets:1,153
Trust Score:9.1
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Install Task with both custom directory and version

Source: https://taskfile.dev/installation

Parameters are order-specific. This example sets the installation directory to `~/.local/bin` and installs version `v3.42.1`.

```shell
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin v3.42.1
```

--------------------------------

### Install Task with apt

Source: https://taskfile.dev/installation

Set up the Cloudsmith repository for apt, then install Task with apt.

```shell
curl -1sLf 'https://dl.cloudsmith.io/public/task/task/setup.deb.sh' | sudo -E bash
```

```shell
apt install task
```

--------------------------------

### Install latest Task globally with Go install

Source: https://taskfile.dev/installation

Builds and installs the latest Task binary globally using Go's `go install` command. Requires a supported Go version.

```shell
go install github.com/go-task/task/v3/cmd/task@latest
```

--------------------------------

### Install Task to a specific directory with Go install

Source: https://taskfile.dev/installation

Uses the `GOBIN` environment variable to install Task into a chosen directory instead of the default global path.

```shell
env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest
```

--------------------------------

### Install Task with Snap

Source: https://taskfile.dev/installation

Install Task via Snapcraft. Requires classic confinement support.

```shell
sudo snap install task --classic
```

--------------------------------

### Install Task with apk

Source: https://taskfile.dev/installation

Set up the Cloudsmith repository for apk, then install Task with apk.

```shell
curl -1sLf 'https://dl.cloudsmith.io/public/task/task/setup.alpine.sh' | sudo -E bash
```

```shell
apk add task
```

--------------------------------

### Install a specific Task version using the install script

Source: https://taskfile.dev/installation

Installs the specified version by passing the tag/release name as an argument to the script. The `-d` flag is for debugging.

```shell
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d v3.36.0
```

--------------------------------

### Shopt options example (YAML)

Source: https://taskfile.dev/docs/reference/schema

Shows how to configure Bash shopt options at global, task, and command levels. The example enables globstar globally, nullglob for the find-files task, and globstar again for the ls command.

```yaml
# Global level
shopt: [globstar]

tasks:
  find-files:
    # Task level
    shopt: [nullglob]
    cmds:
      - cmd: ls **/*.go
        # Command level
        shopt: [globstar]

```

--------------------------------

### Install Task with Mise (ubi backend)

Source: https://taskfile.dev/installation

Install Task using the ubi backend in Mise.

```shell
mise use -g ubi:go-task/task
mise install
```

--------------------------------

### Install Task from Homebrew repository

Source: https://taskfile.dev/installation

Install Task from the official Homebrew repository.

```shell
brew install go-task
```

--------------------------------

### Install Task with pkg (FreeBSD)

Source: https://taskfile.dev/installation

Install Task via pkg on FreeBSD.

```shell
pkg install task
```

--------------------------------

### Install Task with Nix

Source: https://taskfile.dev/installation

Install Task via Nix.

```shell
nix-env -iA nixpkgs.go-task
```

--------------------------------

### Install Task with pkgx

Source: https://taskfile.dev/installation

Install Task via pkgx.

```shell
pkgx task
```

--------------------------------

### Output of matrix loop example

Source: https://taskfile.dev/docs/guide

Expected output of the matrix loop example, listing all combinations of OS and ARCH in the order defined by the lists.

```txt
windows/amd64
windows/arm64
linux/amd64
linux/arm64
darwin/amd64
darwin/arm64

```

--------------------------------

### Install Task with pacstall

Source: https://taskfile.dev/installation

Install Task via pacstall.

```shell
pacstall -I go-task-deb
```

--------------------------------

### Set options example (YAML)

Source: https://taskfile.dev/docs/reference/schema

Shows how to configure POSIX shell set options at global, task, and command levels. The example enables errexit, nounset, and pipefail globally, xtrace for the debug task, and noexec for the echo command.

```yaml
# Global level
set: [errexit, nounset, pipefail]

tasks:
  debug:
    # Task level
    set: [xtrace]
    cmds:
      - cmd: echo "This will be traced"
        # Command level
        set: [noexec]

```

--------------------------------

### Install Task with a custom installation directory using `-b`

Source: https://taskfile.dev/installation

Overrides the installation directory with the `-b` parameter. On Linux, `~/.local/bin` and `~/bin` install for the current user, while `/usr/local/bin` installs for all users. Note that on macOS and Windows, `~/.local/bin` and `~/bin` are not added to `$PATH` by default.

```shell
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
```

--------------------------------

### Install Task with WinGet

Source: https://taskfile.dev/installation

Install Task via WinGet from the community repository.

```shell
winget install Task.Task
```

--------------------------------

### Example .env file

Source: https://taskfile.dev/docs/guide

Example content of a .env file used with the dotenv setting.

```shell
KEYNAME=VALUE
```

--------------------------------

### Example testing/.env file

Source: https://taskfile.dev/docs/guide

Example content of a testing/.env file used with the dotenv setting.

```shell
ENDPOINT=testing.com
```

--------------------------------

### Install Task using the official GitHub Action

Source: https://taskfile.dev/installation

Adds the `go-task/setup-task@v1` GitHub Action to a workflow to install Task automatically in GitHub Actions environments.

```yaml
- name: Install Task
  uses: go-task/setup-task@v1
```

--------------------------------

### Install Task with dnf

Source: https://taskfile.dev/installation

Set up the Cloudsmith repository for dnf, then install Task with dnf.

```shell
curl -1sLf 'https://dl.cloudsmith.io/public/task/task/setup.rpm.sh' | sudo -E bash
```

```shell
dnf install task
```

--------------------------------

### Install Task with Scoop

Source: https://taskfile.dev/installation

Install Task via Scoop.

```shell
scoop install task
```

--------------------------------

### Install Task with pacman

Source: https://taskfile.dev/installation

Install Task via pacman on Arch.

```shell
pacman -S go-task
```

--------------------------------

### Complete .taskrc.yml example

Source: https://taskfile.dev/docs/reference/config

A complete example of a .taskrc.yml file with all available options, including global settings, remote settings, and experimental features.

```yaml
# Global settings
verbose: true
silent: false
color: true
disable-fuzzy: false
concurrency: 2
temp-dir: .task
remote:
  insecure: false
  offline: false
  timeout: '30s'
  cache-expiry: '24h'
  cache-dir: ~/.task
  trusted-hosts:
    - github.com
    - gitlab.com
  cacert: ''
  cert: ''
  cert-key: ''

# Enable experimental features
experiments:
  GENTLE_FORCE: 1
```

--------------------------------

### Install Task from Homebrew tap

Source: https://taskfile.dev/installation

Install Task from the official Homebrew tap.

```shell
brew install go-task/tap/go-task
```

--------------------------------

### Set and shopt options example

Source: https://taskfile.dev/docs/guide

Specify options for the set and shopt builtins at the global level. The tasks section is incomplete in the source.

```yaml
version: '3'

set: [pipefail]
shopt: [globstar]

tasks:

```

--------------------------------

### Install development dependencies with mise

Source: https://taskfile.dev/docs/contributing

Run this command from the repository root to install the pinned versions of Go, Node.js, pnpm, and dev tools declared in the mise.toml file.

```shell
mise install
```

--------------------------------

### Install Task with dnf (Fedora)

Source: https://taskfile.dev/installation

Install Task via dnf on Fedora.

```shell
dnf install go-task
```

--------------------------------

### Install Task with npm

Source: https://taskfile.dev/installation

Install Task globally via npm.

```shell
npm install -g @go-task/cli
```

--------------------------------

### Install Task with Mise (aqua backend)

Source: https://taskfile.dev/installation

Install Task using the aqua backend in Mise.

```shell
mise use -g aqua:go-task/task@latest
mise install
```

--------------------------------

### Example remote Taskfile

Source: https://taskfile.dev/docs/remote-taskfiles.html

Example Taskfile used for testing and throughout the documentation. Defines a default task that calls the hello task, which echoes 'Hello Task!'.

```yaml
version: '3'

tasks:
  default:
    cmds:
      - task: hello

  hello:
    cmds:
      - echo "Hello Task!"
```

--------------------------------

### Install zsh completion via eval

Source: https://taskfile.dev/docs/installation

Add to ~/.zshrc to load completions automatically. Optionally set TASK_EXE to 'go-task' if needed.

```shell
# ~/.zshrc

# export TASK_EXE='go-task' if needed
eval "$(task --completion zsh)"

```

--------------------------------

### Install Task using the official install script (default location)

Source: https://taskfile.dev/installation

Installs the latest Task version to the `./bin` directory relative to the current working directory by default. The `-d` flag enables debugging.

```shell
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d
```

--------------------------------

### Dotenv files example

Source: https://taskfile.dev/docs/reference/schema

Loads environment variables from .env files. The first file in the list has the highest priority.

```yaml
dotenv:
  - .env.local # Highest priority
  - .env # Lowest priority
```

--------------------------------

### Bash shell options example

Source: https://taskfile.dev/docs/reference/schema

Sets Bash shell options for all commands. The example enables globstar.

```yaml
shopt: [globstar]
```

--------------------------------

### Test remote Taskfile with taskfile.dev example

Source: https://taskfile.dev/blog/remote-taskfiles

Test remote Taskfile support using the example hosted at taskfile.dev/Taskfile.yml. The short form -t is equivalent to --taskfile.

```shell
$ task --taskfile https://taskfile.dev/Taskfile.yml
# Or for short
$ task -t https://taskfile.dev

```

--------------------------------

### POSIX shell options example

Source: https://taskfile.dev/docs/reference/schema

Sets POSIX shell options for all commands. The example enables errexit, nounset, and pipefail.

```yaml
set: [errexit, nounset, pipefail]
```

--------------------------------

### Task definitions example

Source: https://taskfile.dev/docs/reference/schema

Shows the three formats for defining tasks: simple string, array of commands, and full object with description and commands.

```yaml
tasks:
  # Simple string format
  hello: echo "Hello World"

  # Array format
  build:
    - go mod tidy
    - go build ./...

  # Full object format
  deploy:
    desc: Deploy the application
    cmds:
      - ./scripts/deploy.sh
```

--------------------------------

### Install powershell completion via Invoke-Expression

Source: https://taskfile.dev/docs/installation

Add to $PROFILE\Microsoft.PowerShell_profile.ps1 to load completions automatically.

```powershell
# $PROFILE\Microsoft.PowerShell_profile.ps1
Invoke-Expression  (&task --completion powershell | Out-String)

```

--------------------------------

### experiments configuration example

Source: https://taskfile.dev/docs/reference/config

Enables experimental features by setting feature names to 1. Refer to experiments documentation for available options.

```yaml
experiments:
  feature_name: 1
  another_feature: 2

```

--------------------------------

### Call multi-wildcard task: `task start:foo:3`

Source: https://taskfile.dev/docs/guide

Invokes the `start:*:*` task with two arguments, `foo` and `3`, which are captured and echoed. If multiple matching tasks exist, the first listed in the Taskfile is used; parent files take precedence.

```shell
$ task start:foo:3
Starting foo with 3 replicas

```

--------------------------------

### Install completions for fish (source at startup)

Source: https://taskfile.dev/installation

Add these commands to ~/.config/fish/config.fish to load Task's fish completions. Optionally set TASK_EXE if the binary is renamed.

```fish
task --completion fish | source

```

--------------------------------

### Get length with len

Source: https://taskfile.dev/docs/reference/templating

Use the len function to get the length of arrays, maps, or strings. The example shows counting items and characters.

```yaml
tasks:
  length:
    vars:
      ITEMS: [a, b, c, d]
      TEXT: "Hello World"
    cmds:
      - echo "Found {{len .ITEMS}} items"
      - echo "Text has {{len .TEXT}} characters"
```

--------------------------------

### Forward CLI arguments with `.CLI_ARGS`

Source: https://taskfile.dev/docs/guide

Forward CLI arguments after `--` to a task using the special `.CLI_ARGS` variable. The example runs `yarn install` by passing `install` to the `yarn` task.

```shell
$ task yarn -- install

```

```yaml
version: '3'

tasks:
  yarn:
    cmds:
      - yarn {{.CLI_ARGS}}

```

--------------------------------

### Install completions for zsh (source at startup)

Source: https://taskfile.dev/installation

Add this to ~/.zshrc to load Task's zsh completions. Optionally set TASK_EXE if the binary is renamed.

```zsh
eval "$(task --completion zsh)"

```

--------------------------------

### Use TASK_VERSION to display Task version

Source: https://taskfile.dev/docs/reference/templating

Shows how to use the TASK_VERSION variable to get the current version of Task. The example echoes the version.

```yaml
tasks:
  version:
    cmds:
      - echo "Using Task {{.TASK_VERSION}}"

```

--------------------------------

### Install completions for bash (source at startup)

Source: https://taskfile.dev/installation

Add this line to ~/.bashrc to load Task's bash completions. Optionally set TASK_EXE if the binary is renamed.

```shell
eval "$(task --completion bash)"

```

--------------------------------

### Use TASK_EXE to display executable name

Source: https://taskfile.dev/docs/reference/templating

Shows how to use the TASK_EXE variable to get the Task executable name or path. The example echoes the executable name.

```yaml
tasks:
  self-update:
    cmds:
      - echo "Updating {{.TASK_EXE}}"

```

--------------------------------

### Set global environment variables for all tasks

Source: https://taskfile.dev/usage

Use the top-level 'env' key to set environment variables that are available to all tasks. The example shows a global GREETING variable used by a 'greet' task.

```yaml
version: '3'

env:
  GREETING: Hey, there!

tasks:
  greet:
    cmds:
      - echo $GREETING

```

--------------------------------

### Include .env files with dotenv setting

Source: https://taskfile.dev/usage

Use the 'dotenv' key to include .env files. The example shows a .env file, a testing/.env file, and a Taskfile that uses dotenv to load them. The first file in the list takes precedence.

```shell
KEYNAME=VALUE

```

```shell
ENDPOINT=testing.com

```

```yaml
version: '3'

env:
  ENV: testing

dotenv: ['.env', '{{.ENV}}/.env', '{{.HOME}}/.env']

tasks:
  greet:
    cmds:
      - echo "Using $KEYNAME and endpoint $ENDPOINT"

```

--------------------------------

### Use TASK to display current task name

Source: https://taskfile.dev/docs/reference/templating

Shows how to use the TASK variable to get the name of the current task. The example echoes the task name.

```yaml
tasks:
  build:
    cmds:
      - echo "Running task {{.TASK}}"

```

--------------------------------

### Install completions for powershell (source at startup)

Source: https://taskfile.dev/installation

Add this to your PowerShell profile to load Task's completions. Optionally set TASK_EXE if the binary is renamed.

```powershell
Invoke-Expression  (&task --completion powershell | Out-String)

```

--------------------------------

### Set custom environment variables for a specific task

Source: https://taskfile.dev/usage

Use the 'env' key inside a task to set environment variables that are only available to that task. The example shows a 'greet' task that echoes the GREETING variable.

```yaml
version: '3'

tasks:
  greet:
    cmds:
      - echo $GREETING
    env:
      GREETING: Hey, there!

```

--------------------------------

### Override dotenv files with priority order

Source: https://taskfile.dev/usage

When the same variable is defined in multiple dotenv files, the first file in the list takes precedence. This example shows a dotenv list with .env.local, .env.{{.ENV}}, and .env, where .env.local has the highest priority.

```yaml
version: '3'

dotenv:
  - .env.local # Highest priority - local developer overrides
  - .env.{{.ENV}} # Environment-specific settings
  - .env # Base defaults (lowest priority)

```

--------------------------------

### Use ITEM to iterate over a list

Source: https://taskfile.dev/docs/reference/templating

Shows how to use the ITEM variable to get the current iteration value when using the 'for' property. The example greets each name in a list.

```yaml
tasks:
  greet:
    cmds:
      - for: [alice, bob, charlie]
        cmd: echo "Hello {{.ITEM}}"

```

--------------------------------

### Install completions for fish (copy to completions dir)

Source: https://taskfile.dev/installation

Copies the completion script to the fish completions directory. Requires manual updates after Task upgrades but allows customization.

```shell
task --completion fish > ~/.config/fish/completions/task.fish

```

--------------------------------

### List access and basic operations: first, last, rest, initial, len

Source: https://taskfile.dev/docs/reference/templating

Use these functions to access and manipulate list elements. The example shows getting the first, last, rest, initial, and length of a list.

```yaml
tasks:
  list-basic:
    vars:
      ITEMS: ["apple", "banana", "cherry", "date"]
    cmds:
      - echo "First {{.ITEMS | first}}"          # "apple"
      - echo "Last {{.ITEMS | last}}"            # "date"
      - echo "Rest {{.ITEMS | rest}}"            # ["banana", "cherry", "date"]
      - echo "Initial {{.ITEMS | initial}}"      # ["apple", "banana", "cherry"]
      - echo "Length {{.ITEMS | len}}"           # 4
```

--------------------------------

### Global config file example ($XDG_CONFIG_HOME/task/.taskrc.yml)

Source: https://taskfile.dev/docs/reference/config

Shows the lowest priority global configuration file. Options set here are overridden by user and project config files.

```yaml
# lowest priority global config
option_1: foo
option_2: foo
option_3: foo

```

--------------------------------

### Install completions for nushell (autoload)

Source: https://taskfile.dev/installation

Create an autoload directory and save the completions script there so Nushell loads it at startup. The script becomes available in the next shell.

```nu
mkdir ($nu.data-dir | path join "vendor/autoload")
task --completion nu | save --force ($nu.data-dir | path join "vendor/autoload/task-completions.nu")

```

--------------------------------

### Call wildcard task: `task start:foo`

Source: https://taskfile.dev/docs/guide

Invokes the `start:*` task with the argument `foo`, which is captured by the wildcard and echoed as `Starting foo`.

```shell
$ task start:foo
Starting foo

```

--------------------------------

### Initialize a Taskfile in a subdirectory

Source: https://taskfile.dev/docs/getting-started

Pass a directory path to `task --init` to create the Taskfile in that directory.

```shell
task --init ./subdirectory
```

--------------------------------

### Project config file example ($HOME/path/to/project/.taskrc.yml)

Source: https://taskfile.dev/docs/reference/config

Shows the highest priority project configuration file. Overrides both global and user config files.

```yaml
# highest priority project config
option_1: baz

```

--------------------------------

### User config file example ($HOME/.taskrc.yml)

Source: https://taskfile.dev/docs/reference/config

Shows the user-level configuration file with medium priority. Overrides global config but is overridden by project config.

```yaml
option_1: bar
option_2: bar

```

--------------------------------

### Install Task with Chocolatey

Source: https://taskfile.dev/installation

Install Task via Chocolatey.

```shell
choco install go-task
```

--------------------------------

### Install completions for bash (copy to completions dir)

Source: https://taskfile.dev/installation

Copies the completion script to /etc/bash_completion.d/task. Requires manual updates after Task upgrades but allows customization.

```shell
task --completion bash > /etc/bash_completion.d/task

```

--------------------------------

### Install Task with pip

Source: https://taskfile.dev/installation

Install Task via pip.

```shell
pip install go-task-bin
```

--------------------------------

### Install Task with Macports

Source: https://taskfile.dev/installation

Install Task via Macports.

```shell
port install go-task
```
Tokens:
Raw