intro.mdx 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. ---
  2. slug: /
  3. sidebar_position: 1
  4. title: Home
  5. hide_title: true
  6. ---
  7. <div align="center">
  8. <img id="logo" src="/img/logo.svg" height="250px" width="250px" />
  9. </div>
  10. <br />
  11. Task is a task runner / build tool that aims to be simpler and easier to use
  12. than, for example, [GNU Make][make].
  13. Since it's written in [Go][go], Task is just a single binary and has no other
  14. dependencies, which means you don't need to mess with any complicated install
  15. setups just to use a build tool.
  16. Once [installed](/installation), you just need to describe your build tasks
  17. using a simple [YAML][yaml] schema in a file called `Taskfile.yml`:
  18. ```yaml title="Taskfile.yml"
  19. version: '3'
  20. tasks:
  21. hello:
  22. cmds:
  23. - echo 'Hello World from Task!'
  24. silent: true
  25. ```
  26. And call it by running `task hello` from your terminal.
  27. The above example is just the start, you can take a look at the [usage](/usage)
  28. guide to check the full schema documentation and Task features.
  29. ## Features
  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],
  32. [Snapcraft][snapcraft], or [Scoop][scoop] if you want.
  33. - Available on CIs: by adding
  34. [this simple command](/installation#install-script) to install on your CI
  35. script and you're ready to use Task as part of your CI pipeline;
  36. - Truly cross-platform: while most build tools only work well on Linux or macOS,
  37. Task also supports Windows thanks to [this shell interpreter for Go][sh].
  38. - Great for code generation: you can easily
  39. [prevent a task from running](/usage#prevent-unnecessary-work) if a given set
  40. of files haven't changed since last run (based either on its timestamp or
  41. content).
  42. {/* prettier-ignore-start */}
  43. [make]: https://www.gnu.org/software/make/
  44. [go]: https://go.dev/
  45. [yaml]: http://yaml.org/
  46. [homebrew]: https://brew.sh/
  47. [snapcraft]: https://snapcraft.io/
  48. [scoop]: https://scoop.sh/
  49. [sh]: https://github.com/mvdan/sh
  50. {/* prettier-ignore-end */}