1
0
mirror of https://github.com/go-task/task.git synced 2024-12-14 10:52:43 +02:00
task/docs
Andrey Nering 0c91011e88
Merge pull request #460 from patrick-mota/patch-1
Fix typo default installation
2021-03-28 11:10:38 -03:00
..
_sidebar.md Documentation updates 2020-09-06 14:33:28 -03:00
.nojekyll Documentation site using docsify 2018-09-22 18:44:24 -03:00
CNAME Update CNAME 2019-03-04 22:23:39 -03:00
donate.md Documentation updates 2020-09-06 14:33:28 -03:00
examples.md Documentation site using docsify 2018-09-22 18:44:24 -03:00
favicon.ico New logo and color 2020-12-27 19:07:38 -03:00
index.html New logo and color 2020-12-27 19:07:38 -03:00
install.sh Update install script 2021-01-12 10:43:45 -03:00
installation.md Merge pull request #460 from patrick-mota/patch-1 2021-03-28 11:10:38 -03:00
Logo.png New logo and color 2020-12-27 19:07:38 -03:00
README.md New logo and color 2020-12-27 19:07:38 -03:00
releasing_task.md Documentation: Update link 2021-03-20 13:30:38 -03:00
styleguide.md On documentation: version: '2' -> version: '3' 2020-08-16 21:34:33 -03:00
taskfile_versions.md Doc: Update "Taskfile versions" documentation 2020-08-16 21:56:21 -03:00
Taskfile.yml New logo and color 2020-12-27 19:07:38 -03:00
usage.md Add support for delegating CLI arguments with "--" and a special CLI_ARGS variable 2021-03-20 11:58:45 -03:00

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: '3'

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, Snapcraft, or Scoop 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).