How does it work?

Taskfiles are simple bash scripts, but an easy-to-read function format. There are some things that we need to explain for our Taskfile setup. It all starts with a Taskfile. Download your Taskfile from taskfile.sh and save it. Make sure the Taskfile is executable: chmod +x ./Taskfile. You can now run ./Taskfile in your terminal.

Tasks

A task is defined by creating a function that starts with task:. This defines a task that can be triggered by running the ./Taskfile. Right next to the task, you should add a task definition with two hashes. This will let the task:help function know that you're writing the task function definition. So an example task will look like the following:

function task:example { ## Show some example text
    title "Example"
    echo "This is an example task."
}

In a task you can call other functions, and run all tooling you desire. Now running ./Taskfile example will execute the new task.

Sections

To group multiple tasks, sections can be created in your Taskfile. A section is created by creating a comment line with a double hashtag like so:

## Project section

Lines with only a single # will not appear as section in task:help and can be seen as plain comments.

Help command

Running ./Taskfile help, the task:help function is triggered. This task will list all available sections and tasks using the double ## comments you've learned about above. Now it's clear how you can run any other task!