<scriptsrc="/js/carbon.js"async></script><titledata-rh="true">Installation | Task</title><metadata-rh="true"name="twitter:card"content="summary_large_image"><metadata-rh="true"property="og:url"content="https://taskfile.dev/installation/"><metadata-rh="true"name="docusaurus_locale"content="en"><metadata-rh="true"name="docsearch:language"content="en"><metadata-rh="true"name="og:image"content="https://taskfile.dev/img/og-image.png"><metadata-rh="true"name="docusaurus_version"content="current"><metadata-rh="true"name="docusaurus_tag"content="docs-default-current"><metadata-rh="true"name="docsearch:version"content="current"><metadata-rh="true"name="docsearch:docusaurus_tag"content="docs-default-current"><metadata-rh="true"property="og:title"content="Installation | Task"><metadata-rh="true"name="description"content="Task offers many installation methods. Check out the available methods below."><metadata-rh="true"property="og:description"content="Task offers many installation methods. Check out the available methods below."><linkdata-rh="true"rel="icon"href="/img/favicon.ico"><linkdata-rh="true"rel="canonical"href="https://taskfile.dev/installation/"><linkdata-rh="true"rel="alternate"href="https://taskfile.dev/installation/"hreflang="en"><linkdata-rh="true"rel="alternate"href="https://taskfile.dev/installation/"hreflang="x-default"><linkdata-rh="true"rel="preconnect"href="https://7IZIJ13AI7-dsn.algolia.net"crossorigin="anonymous"><linkrel="stylesheet"href="/assets/css/styles.dac10b37.css">
Task is as simple as running:</p><divclass="language-bash codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-bash codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token plain">brew </span><spanclass="token function"style="color:#8250DF">install</span><spanclass="token plain"> go-task/tap/go-task</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3class="anchor anchorWithStickyNavbar_mojV"id="snap">Snap<aclass="hash-link"href="#snap"title="Direct link to heading"></a></h3><p>Task is available in <ahref="https://snapcraft.io/task"target="_blank"rel="noopener noreferrer">Snapcraft</a>, but keep in mind that your
right:</p><divclass="language-bash codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-bash codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token function"style="color:#8250DF">sudo</span><spanclass="token plain"> snap </span><spanclass="token function"style="color:#8250DF">install</span><spanclass="token plain"> task --classic</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3class="anchor anchorWithStickyNavbar_mojV"id="chocolatey">Chocolatey<aclass="hash-link"href="#chocolatey"title="Direct link to heading"></a></h3><p>If you're on Windows and have <ahref="https://chocolatey.org/"target="_blank"rel="noopener noreferrer">Chocolatey</a> installed, getting
Task is as simple as running:</p><divclass="language-bash codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-bash codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token plain">choco </span><spanclass="token function"style="color:#8250DF">install</span><spanclass="token plain"> go-task</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>This installation method is community owned.</p><h3class="anchor anchorWithStickyNavbar_mojV"id="scoop">Scoop<aclass="hash-link"href="#scoop"title="Direct link to heading"></a></h3><p>If you're on Windows and have <ahref="https://scoop.sh/"target="_blank"rel="noopener noreferrer">Scoop</a> installed, getting
Task is as simple as running:</p><divclass="language-cmd codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-cmd codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token plain">scoop install task</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>This installation method is community owned. After a new release of Task, it
may take some time until it's available on Scoop.</p><h3class="anchor anchorWithStickyNavbar_mojV"id="aur">AUR<aclass="hash-link"href="#aur"title="Direct link to heading"></a></h3><p>If you're on Arch Linux you can install Task from
<ahref="https://github.com/go-task/task/releases"target="_blank"rel="noopener noreferrer">releases page</a>:</p><divclass="language-cmd codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-cmd codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token plain">yay -S go-task</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>This installation method is community owned.</p><h3class="anchor anchorWithStickyNavbar_mojV"id="fedora">Fedora<aclass="hash-link"href="#fedora"title="Direct link to heading"></a></h3><p>If you're on Fedora Linux you can install Task from the official
may take some time until it's available in <ahref="https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/"target="_blank"rel="noopener noreferrer">Fedora</a>.</p><h3class="anchor anchorWithStickyNavbar_mojV"id="nix">Nix<aclass="hash-link"href="#nix"title="Direct link to heading"></a></h3><p>If you're on NixOS or have Nix installed
you can install Task from <ahref="https://github.com/NixOS/nixpkgs"target="_blank"rel="noopener noreferrer">nixpkgs</a>:</p><divclass="language-cmd codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-cmd codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token plain">nix-env -iA nixpkgs.go-task</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>This installation method is community owned. After a new release of Task, it
may take some time until it's available in <ahref="https://github.com/NixOS/nixpkgs"target="_blank"rel="noopener noreferrer">nixpkgs</a>.</p><h3class="anchor anchorWithStickyNavbar_mojV"id="npm">npm<aclass="hash-link"href="#npm"title="Direct link to heading"></a></h3><p>You can also use Node and npm to install Task by installing
<ahref="https://www.npmjs.com/package/@go-task/cli"target="_blank"rel="noopener noreferrer">this package</a>.</p><divclass="language-bash codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-bash codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token function"style="color:#8250DF">npm</span><spanclass="token plain"></span><spanclass="token function"style="color:#8250DF">install</span><spanclass="token plain"> -g @go-task/cli</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2class="anchor anchorWithStickyNavbar_mojV"id="get-the-binary">Get The Binary<aclass="hash-link"href="#get-the-binary"title="Direct link to heading"></a></h2><h3class="anchor anchorWithStickyNavbar_mojV"id="binary">Binary<aclass="hash-link"href="#binary"title="Direct link to heading"></a></h3><p>You can download the binary from the <ahref="https://github.com/go-task/task/releases"target="_blank"rel="noopener noreferrer">releases page on GitHub</a> and
add to your <code>$PATH</code>.</p><p>DEB and RPM packages are also available.</p><p>The <code>task_checksums.txt</code> file contains the SHA-256 checksum for each file.</p><h3class="anchor anchorWithStickyNavbar_mojV"id="install-script">Install Script<aclass="hash-link"href="#install-script"title="Direct link to heading"></a></h3><p>We also have an <ahref="https://github.com/go-task/task/blob/master/install-task.sh"target="_blank"rel="noopener noreferrer">install script</a> which is very useful in
scenarios like CI. Many thanks to <ahref="https://github.com/goreleaser/godownloader"target="_blank"rel="noopener noreferrer">GoDownloader</a> for enabling the
default.</p></div></div><h3class="anchor anchorWithStickyNavbar_mojV"id="github-actions">GitHub Actions<aclass="hash-link"href="#github-actions"title="Direct link to heading"></a></h3><p>If you want to install Task in GitHub Actions you can try using
released binary.</p></div></div><h2class="anchor anchorWithStickyNavbar_mojV"id="setup-completions">Setup completions<aclass="hash-link"href="#setup-completions"title="Direct link to heading"></a></h2><p>Download the autocompletion file corresponding to your shell.</p><p><ahref="https://github.com/go-task/task/tree/master/completion"target="_blank"rel="noopener noreferrer">All completions are available on the Task repository</a>.</p><h3class="anchor anchorWithStickyNavbar_mojV"id="bash">Bash<aclass="hash-link"href="#bash"title="Direct link to heading"></a></h3><p>First, ensure that you installed bash-completion using your package manager.</p><p>Make the completion file executable:</p><divclass="codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-text codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token plain">chmod +x path/to/task.bash</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>After, add this to your <code>~/.bash_profile</code>:</p><divclass="language-shell codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-shell codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token builtin class-name"style="color:#116329">source</span><spanclass="token plain"> path/to/task.bash</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3class="anchor anchorWithStickyNavbar_mojV"id="zsh">ZSH<aclass="hash-link"href="#zsh"title="Direct link to heading"></a></h3><p>Put the <code>_task</code> file somewhere in your <code>$FPATH</code>:</p><divclass="language-shell codeBlockContainer_MPoW theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_B9tL"><pretabindex="0"class="prism-code language-shell codeBlock__0OG thin-scrollbar"><codeclass="codeBlockLines_gEuF"><spanclass="token-line"style="color:#393A34"><spanclass="token function"style="color:#8250DF">mv</span><spanclass="token plain"> path/to/_task /usr/local/share/zsh/site-functions/_task</span><br></span></code></pre><divclass="buttonGroup_hRr1"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_W9eQ"aria-hidden="true"><svgclass="copyButtonIcon_XEyF"viewBox="0 0 24 24"><pathd="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><svgclass="copyButtonSuccessIcon_i9w9"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Ensure that the following is present in your <code>~/.zshrc</code>:</p><divclass="language-sh
