1
0
mirror of https://github.com/go-task/task.git synced 2024-12-12 10:45:49 +02:00
task/docs/README.md
Aseem Bajaj 8004e9c943
Fix broken URL to installation doc
The links to installation doc were broken, perhaps it was a typo or maybe installation document was relocated from "installation" directory to "installation.md". In either case, making this change fixes the problem.
2018-10-26 16:06:33 -07:00

1.7 KiB

Task

Task is a task runner / build tool that aims to be simpler and easier to use than, for example, GNU Make.

Since it's written in Go, Task is just a single binary and has no other dependencies, which means you don't need to mess with any complicated install setups just to use a build tool.

Once installed, you just need to describe your build tasks using a simple YAML schema in a file called Taskfile.yml:

version: '2'

tasks:
  hello:
    cmds:
      - echo 'Hello World from Task!'
    silent: true

And call it by running task hello from you terminal.

The above example is just the start, you can take a look at the usage guide to check the full schema documentation and Task features.

Features

  • Easy installation: just download a single binary, add to $PATH and you're done! Or you can also install using Homebrew or Snapcraft if you want;
  • Available on CIs: by adding this simple command to install on your CI script and you're done to use Task as part of your CI pipeline;
  • Truly cross-platform: while most build tools only work well on Linux or macOS, Task also supports Windows thanks to this awesome shell interpreter for Go;
  • Great for code generation: you can easily prevent a task from running if a given set of files haven't changed since last run (based either on its timestamp or content).