|
1 | 1 | # Task |
2 | 2 |
|
3 | | -A task runner / simpler Make alternative written in Go |
| 3 | +Task is a task runner / build tool that aims to be simpler and easier to use |
| 4 | +than, for example, [GNU Make][make]. |
4 | 5 |
|
5 | | -Task is a simple tool that allows you to easily run development and build |
6 | | -tasks. Task is written in Go, but can be used to develop any language. |
7 | | -It aims to be simpler and easier to use then [GNU Make][make]. |
| 6 | +Since it's written in [Go][go], Task is just a single binary and has no other |
| 7 | +dependencies, which means you don't need to mess with any complicated install |
| 8 | +setups just to use a build tool. |
| 9 | + |
| 10 | +Once [installed](installation), you just need to describe your build tasks |
| 11 | +using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: |
| 12 | + |
| 13 | +```yaml |
| 14 | +version: '2' |
| 15 | + |
| 16 | +tasks: |
| 17 | + hello: |
| 18 | + cmds: |
| 19 | + - echo 'Hello World from Task!' |
| 20 | + silent: true |
| 21 | +``` |
| 22 | +
|
| 23 | +And call it by running `task hello` from you terminal. |
| 24 | + |
| 25 | +The above example is just the start, you can take a look at the [usage](usage) |
| 26 | +guide to check the full schema documentation and Task features. |
| 27 | + |
| 28 | +## Features |
| 29 | + |
| 30 | +- [Easy installation](installation): just download a single binary, add to |
| 31 | + $PATH and you're done! Or you can also install using [Homebrew][homebrew] or |
| 32 | + [Snapcraft][snapcraft] if you want; |
| 33 | +- Available on CIs: by adding [this simple command](installation#install-script) |
| 34 | + to install on your CI script and you're done to use Task as part of your CI pipeline; |
| 35 | +- Truly cross-platform: while most build tools only work well on Linux or macOS, |
| 36 | + Task also supports Windows thanks to [this awesome shell interpreter for Go][sh]; |
| 37 | +- Great for code generation: you can easily [prevent a task from running](usage#prevent-unnecessary-work) |
| 38 | + if a given set of files haven't changed since last run (based either on its |
| 39 | + timestamp or content). |
8 | 40 |
|
9 | 41 | [make]: https://www.gnu.org/software/make/ |
| 42 | +[go]: https://golang.org/ |
| 43 | +[yaml]: http://yaml.org/ |
| 44 | +[homebrew]: https://brew.sh/ |
| 45 | +[snapcraft]: https://snapcraft.io/ |
| 46 | +[sh]: https://mvdan.cc/sh |
0 commit comments