Skip to main content
Use the --summary flag to display a detailed overview of a task, including its name, description, dependencies, and commands.
If a summary is not defined, the task’s desc will be shown instead. If neither is available, a warning is printed.
Taskfile.yml
version: '3'
tasks:
  deploy:
    desc: Deploy the application
    deps: [build]
    summary: |
      This task deploys the application after building it.

      It ensures that all necessary components are in place before deployment.
    cmds:
      - echo "Deploying application..."

  build:
    desc: Build the application
    cmds:
      - echo "Building application..."

  test:
    cmds:
      - echo "Running tests..."
Demo and Output
# Summary for a task with a custom summary
ubuntu@touted-mite:~$ task --summary deploy
task: deploy

This task deploys the application after building it.

It ensures that all necessary components are in place before deployment.

dependencies:
 - build

commands:
 - echo "Deploying application..."

# Summary falls back to desc when no summary is set
ubuntu@touted-mite:~$ task --summary build
task: build

Build the application

commands:
 - echo "Building application..."

# Warning when neither summary nor desc is set
ubuntu@touted-mite:~$ task --summary test
task: test

(task does not have description or summary)

commands:
 - echo "Running tests..."

Build docs developers (and LLMs) love

Get started for freeTalk to us