1
0
mirror of https://github.com/go-task/task.git synced 2025-03-19 21:17:46 +02:00
task/index.html

34 lines
32 KiB
HTML
Raw Normal View History

2022-05-29 13:46:51 -03:00
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-intro">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.2.0">
<title data-rh="true">Home | Task</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://taskfile.dev/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="og:image" content="https://taskfile.dev/img/og-image.png"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Home | Task"><meta data-rh="true" name="description" content="Task is a task runner / build tool that aims to be simpler and easier to use"><meta data-rh="true" property="og:description" content="Task is a task runner / build tool that aims to be simpler and easier to use"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://taskfile.dev/"><link data-rh="true" rel="alternate" href="https://taskfile.dev/" hreflang="en"><link data-rh="true" rel="alternate" href="https://taskfile.dev/" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://7IZIJ13AI7-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true">function maybeInsertBanner(){window.__DOCUSAURUS_INSERT_BASEURL_BANNER&&insertBanner()}function insertBanner(){var n=document.getElementById("docusaurus-base-url-issue-banner-container");if(n){n.innerHTML='\n<div id="docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n';var e=document.getElementById("docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,r="/"===s.substr(-1)?s:s+"/";e.innerHTML=r}}window.__DOCUSAURUS_INSERT_BASEURL_BANNER=!0,document.addEventListener("DOMContentLoaded",maybeInsertBanner)</script><link rel="preconnect" href="https://www.google-analytics.com">
2022-05-29 13:46:51 -03:00
<link rel="preconnect" href="https://www.googletagmanager.com">
<script async src="https://www.googletagmanager.com/gtag/js?id=G-4RT25NXQ7N"></script>
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-4RT25NXQ7N",{anonymize_ip:!0})</script>
<link rel="search" type="application/opensearchdescription+xml" title="Task" href="/opensearch.xml">
<script src="/js/carbon.js" async></script><link rel="stylesheet" href="/assets/css/styles.d5e5d7d5.css">
<link rel="preload" href="/assets/js/runtime~main.1ac36594.js" as="script">
<link rel="preload" href="/assets/js/main.4b54c987.js" as="script">
2022-05-29 13:46:51 -03:00
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div id="docusaurus-base-url-issue-banner-container"></div><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Task Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="Task Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Task</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/installation/">Installation</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/usage/">Usage</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/api/">API</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/donate/">Donate</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/go-task/task" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><a href="https://twitter.com/taskfiledev" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><a href="https://discord.gg/6TY36E39UK" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,
2022-05-29 13:46:51 -03:00
than, for example, <a href="https://www.gnu.org/software/make/" target="_blank" rel="noopener noreferrer">GNU Make</a>.</p><p>Since it&#x27;s written in <a href="https://go.dev/" target="_blank" rel="noopener noreferrer">Go</a>, Task is just a single binary and has no other
dependencies, which means you don&#x27;t need to mess with any complicated install
setups just to use a build tool.</p><p>Once <a href="/installation/">installed</a>, you just need to describe your build tasks
using a simple <a href="http://yaml.org/" target="_blank" rel="noopener noreferrer">YAML</a> schema in a file called <code>Taskfile.yml</code>:</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_Ktv7">Taskfile.yml</div><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token key atrule" style="color:#22863A">version</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#C6105F">&#x27;3&#x27;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#22863A">tasks</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#22863A">hello</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#22863A">cmds</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> echo &#x27;Hello World from Task</span><span class="token tag" style="color:#22863A">!&#x27;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#22863A">silent</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#005CC5">true</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>And call it by running <code>task hello</code> from your terminal.</p><p>The above example is just the start, you can take a look at the <a href="/usage">usage</a>
guide to check the full schema documentation and Task features.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="features">Features<a class="hash-link" href="#features" title="Direct link to heading"></a></h2><ul><li><a href="/installation/">Easy installation</a>: just download a single binary, add to
<code>$PATH</code> and you&#x27;re done! Or you can also install using <a href="https://brew.sh/" target="_blank" rel="noopener noreferrer">Homebrew</a>,
<a href="https://snapcraft.io/" target="_blank" rel="noopener noreferrer">Snapcraft</a>, or <a href="https://scoop.sh/" target="_blank" rel="noopener noreferrer">Scoop</a> if you want.</li><li>Available on CIs: by adding <a href="/installation/#install-script">this simple command</a>
to install on your CI script and you&#x27;re ready to use Task as part of your CI pipeline;</li><li>Truly cross-platform: while most build tools only work well on Linux or macOS,
Task also supports Windows thanks to <a href="https://github.com/mvdan/sh" target="_blank" rel="noopener noreferrer">this shell interpreter for Go</a>.</li><li>Great for code generation: you can easily <a href="/usage#prevent-unnecessary-work">prevent a task from running</a>
2022-05-29 13:46:51 -03:00
if a given set of files haven&#x27;t changed since last run (based either on its
timestamp or content).</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="gold-sponsors">Gold Sponsors<a class="hash-link" href="#gold-sponsors" title="Direct link to heading"></a></h2><div class="gold-sponsors"><table><thead><tr><th><a href="https://appwrite.io/?utm_source=taskfile.dev&amp;utm_medium=website&amp;utm_campaign=task_oss_fund" target="_blank" rel="noopener noreferrer">Appwrite</a></th></tr></thead><tbody><tr><td><a href="https://appwrite.io/?utm_source=taskfile.dev&amp;utm_medium=website&amp;utm_campaign=task_oss_fund" target="_blank" rel="noopener noreferrer"><img loading="lazy" alt="Appwrite" src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iMTczIiBoZWlnaHQ9IjMwIiB2aWV3Qm94PSIwIDAgMTczIDMwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJNMzUgMTQuOTk5OUMzNSAyMS42MjczIDI5LjkwMjEgMjcgMjMuNjEzMSAyN0MyMC42OTIxIDI3IDE4LjAyODEgMjUuODQwNiAxNi4wMTIzIDIzLjkzNTNDMTkuMjQxNSAyMi40MDMyIDIxLjQ4OTUgMTguOTgyNiAyMS40ODk1IDE1LjAwODZDMjEuNDg5NSAxMS4wMjk1IDE5LjIzNTkgNy42MDUzNSAxNiA2LjA3NjE0QzE4LjAxNzUgNC4xNjM4NyAyMC42ODYyIDMgMjMuNjEzMSAzQzI5LjkwMjEgMyAzNSA4LjM3MjU1IDM1IDE0Ljk5OTlaIiBmaWxsPSIjRjAyRTY1Ii8+CjxwYXRoIGQ9Ik0xOS4yMjk0IDUuNDM2OTlDMTEuODYxOSAtMC4xMjQ4NDMgMS4yMjk2IDQuMzY1OCAwLjA5MTYxMSAxMy41MjA1Qy0wLjQzNzIwOCAxNy43NzUyIDEuMzQ5NDUgMjEuOTg3OCA0Ljc3NjkgMjQuNTY4QzEyLjE0ODYgMzAuMTI0OSAyMi43Nzc3IDI1LjYyNjQgMjMuOTA5NCAxNi40NzA5QzI0LjQzNDUgMTIuMjIxNiAyMi42NTA1IDguMDE1NjkgMTkuMjI5NCA1LjQzNjg3VjUuNDM2OTlaTTE3Ljg5NTEgNy4yMDI4NUMyMy45MDU5IDExLjczMzcgMjIuNzUyNCAyMS4wNjUgMTUuODE4OSAyMy45OTk0QzEyLjYwMTQgMjUuMzYxMyA4LjkwMDYxIDI0LjkwNDkgNi4xMTExMSAyMi44MDJDMC4xMDA2NDYgMTguMjcxIDEuMjUzOTMgOC45Mzk3MSA4LjE4NzM2IDYuMDA1NDNDMTEuNDA1IDQuNjQzNzcgMTUuMTA1NyA1LjEwMDA2IDE3Ljg5NTEgNy4yMDI4NVoiIGZpbGw9IiNGMDJFNjUiLz4KPHBhdGggZD0iTTQ4LjUxMzIgNi43ODUzNEM1MC4xMzcxIDYuNzg1MzQgNTEuNTIxMyA3LjE5NTI5IDUyLjY2NTkgOC4wMTU2NkM1My44MTA0IDguODM2MTQgNTQuNTk3NCA5LjkyMzU0IDU1LjAyNyAxMS4yNzc5VjYuOTgzODhINTcuMDUzMlYyMi42MTQ0SDU1LjAyN1YxOC4zMjA2QzU0LjU5NzQgMTkuNjc2MiA1My44MTA0IDIwLjc2NDEgNTIuNjY1OSAyMS41ODQ1QzUxLjUyMTMgMjIuNDA1IDUwLjEzNzEgMjIuODE1MSA0OC41MTMyIDIyLjgxNTFDNDcuMDY1NCAyMi44MTUxIDQ1Ljc2OTIgMjIuNDkwNiA0NC42MjQ2IDIxLjg0MTlDNDMuNDgwMSAyMS4xOTMzIDQyLjU5IDIwLjI2MjggNDEuOTU0IDE5LjA1MDVDNDEuMzE4MiAxNy44MzgyIDQxIDE2LjQyMTEgNDEgMTQuNzk5MUM0MSAxMy4xNTg0IDQxLjMxODIgMTEuNzMyIDQxLjk1NCAxMC41MTk2QzQyLjU5IDkuMzA4NTYgNDMuNDc1MiA4LjM4MzUzIDQ0LjYxMDEgNy43NDM5OEM0NS43NDQ4IDcuMTA0NjUgNDcuMDQ1OCA2Ljc4NTM0IDQ4LjUxMzIgNi43ODUzNFpNNDkuMDQxMiA4LjU1OTEzQzQ3LjI0MTMgOC41NTkxMyA0NS43OTgzIDkuMTE3MiA0NC43MTE5IDEwLjIzMzhDNDMuNjI2OSAxMS4zNTAzIDQzLjA4NDQgMTIuODcyMSA0My4wODQ0IDE0Ljc5OTFDNDMuMDg0NCAxNi43MjY1IDQzLjYyNjkgMTguMjQ4NCA0NC43MTE5IDE5LjM2NDlDNDUuNzk4MyAyMC40ODEyIDQ3LjI0MTMgMjEuMDM5MyA0OS4wNDEyIDIxLjAzOTNDNTAuMTc1OSAyMS4wMzkzIDUxLjE5ODEgMjAuNzgyIDUyLjEwNzEgMjAuMjY2OEM1My4wMTcxIDE5Ljc1MiA1My43MzE0IDE5LjAyMiA1NC4yNDk4IDE4LjA3NzJDNTQuNzY4IDE3LjEzMjUgNTUuMDI3IDE2LjA0IDU1LjAyNyAxNC43OTkxQzU1LjAyNyAxMy41NTg1IDU0Ljc2OCAxMi40NjY2IDU0LjI0OTggMTEuNTIyOEM1My43MzE0IDEwLjU3ODQgNTMuMDE3MSA5Ljg0NzYyIDUyLjEwNzEgOS4zMzE4NUM1MS4xOTgxIDguODE2NjYgNTAuMTc1OSA4LjU1OTEzIDQ5LjA0MTIgOC41NTkxM1pNNzAuMDgyMiA2Ljc4NTM0QzcxLjU0OTYgNi43ODUzNCA3Mi44NDU4IDcuMTA0NjUgNzMuOTcwNyA3Ljc0Mzk4Qzc1LjA5NTggOC4zODM1MyA3NS45NzY0IDkuMzA4NTYgNzYuNjEyNCAxMC41MTk2Qzc3LjI0ODIgMTEuNzMyIDc3LjU2NjIgMTMuMTU4NCA3Ny41NjYyIDE0Ljc5OTFDNzcuNTY2MiAxNi40MjExIDc3LjI0ODIgMTcuODM4MiA3Ni42MTI0IDE5LjA1MDVDNzUuOTc2NCAyMC4yNjI4IDc1LjA5MDYgMjEuMTkzMyA3My45NTYzIDIxLjg0MTlDNzIuODIxNiAyMi40OTA2IDcxLjUzMDEgMjIuODE1MSA3MC4wODIyIDIyLjgxNTFDNjguNDM4NyAyMi44MTUxIDY3LjA0OTggMjIuNDA1IDY1LjkxNSAyMS41ODQ1QzY0Ljc4MDIgMjAuNzY0MSA2My45OTc5IDE5LjY3NjIgNjMuNTY4MSAxOC4zMjA2VjMwSDYxLjUxMjlWNi45ODM4OEg2My41NjgxVjExLjI3NzlDNjMuOTk3OSA5LjkyMzU0IDY0Ljc4MDIgOC44MzYxNCA2NS45MTUgOC4wMTU2NkM2Ny4wNDk4IDcuMTk1MjkgNjguNDM4NyA2Ljc4NTM0IDcwLjA4MjIgNi43ODUzNFpNNjkuNTI1IDguNTU5MTNDNjguMzkwMiA4LjU1OTEzIDY3LjM2NzcgOC44MTY2NiA2Ni40NTc0IDkuMzMxODVDNjUuNTQ4NCA5Ljg0NzYyIDY0LjgzOTUgMTAuNTc4NCA2NC4zMzExIDExLjUyMjhDNjMuODIyNyAxMi40NjY2IDYzLjU2ODEgMTMuNTU4NSA2My41NjgxIDE0Ljc5OTFDNjMuNTY4MSAxNi4wNCA2My44
<script src="/assets/js/runtime~main.1ac36594.js"></script>
<script src="/assets/js/main.4b54c987.js"></script>
2022-05-29 13:46:51 -03:00
</body>
</html>