Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updated installation guides #1989

Merged
merged 4 commits into from
Jan 2, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 68 additions & 75 deletions website/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,144 +10,120 @@ import TabItem from '@theme/TabItem';

Task offers many installation methods. Check out the available methods below.

:::info

Some of the methods below are marked as ![Community][community]. This means they
are not maintained by the Task team and may not be up-to-date.

:::

## Package Managers

### Homebrew
### [Homebrew][homebrew] ![macOS][macos] ![Linux][linux]

If you're on macOS or Linux and have [Homebrew][homebrew] installed, getting
Task is as simple as running:
Task is available via our official Homebrew tap [[source](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb)]:

```shell
brew install go-task/tap/go-task
```

The above Formula is
[maintained by ourselves](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb).

Recently, Task was also made available
[on the official Homebrew repository](https://formulae.brew.sh/formula/go-task),
so you also have that option if you prefer:
Alternatively it can be installed from the official Homebrew
repository [[package](https://formulae.brew.sh/formula/go-task)]
[[source](https://github.com/Homebrew/homebrew-core/blob/master/Formula/g/go-task.rb)] by running:

```shell
brew install go-task
```

### pkgx
### [Snap][snapcraft] ![MacOS][macos] ![Linux][linux]

If you're on macOS or Linux and have [pkgx][pkgx] installed, getting Task is as
simple as running:
Task is available on [Snapcraft][snapcraft] [[source](https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml)], but keep in mind that your Linux
distribution should allow classic confinement for Snaps to Task work correctly:

```shell
pkgx task
sudo snap install task --classic
```

or, if you have pkgx integration enabled:
### [npm][npm] ![MacOS][macos] ![Linux][linux] ![Windows][windows]

Npm can be used as cross-platform way to install Task globally or as a
dependency of your project
[[package](https://www.npmjs.com/package/@go-task/cli)] [[source](https://github.com/go-task/task/blob/main/package.json)].

```shell
task
npm install -g @go-task/cli
```

This installation method is community owned. After a new release of Task, they
are automatically released by pkgx in a minimum of time.
### [Winget][winget] ![Windows][windows]

### Snap

Task is available in [Snapcraft][snapcraft], but keep in mind that your Linux
distribution should allow classic confinement for Snaps to Task work right:
Task is available via the [community repository](https://github.com/microsoft/winget-pkgs) [[source](https://github.com/microsoft/winget-pkgs/tree/master/manifests/t/Task/Task)].

```shell
sudo snap install task --classic
winget install Task.Task
```

### Chocolatey
### [Chocolatey][choco] ![Windows][windows] ![Community][community]

If you're on Windows and have [Chocolatey][choco] installed, getting Task is as
simple as running:
[[package](https://community.chocolatey.org/packages/go-task)] [[source](https://github.com/Starz0r/ChocolateyPackagingScripts/blob/master/src/go-task_gh_build.py)]

```shell
choco install go-task
```

This installation method is community owned.

### Scoop
### [Scoop][scoop] ![Windows][windows] ![Community][community]

If you're on Windows and have [Scoop][scoop] installed, getting Task is as
simple as running:
[[source](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json)]

```shell
scoop install task
```

This installation method is community owned. After a new release of Task, it may
take some time until it's available on Scoop.

### Arch
### Arch ([pacman][pacman]) ![Arch][arch] ![Community][community]

If you're on Arch Linux you can install Task from the official
[Arch](https://archlinux.org/packages/extra/x86_64/go-task/) repository using `pacman`:
[[package](https://archlinux.org/packages/extra/x86_64/go-task/)] [[source](https://gitlab.archlinux.org/archlinux/packaging/packages/go-task)]

```shell
pacman -S go-task
```

This installation method is community owned.

### Fedora
### Fedora ([dnf][dnf]) ![Fedora][fedora] ![Community][community]

If you're on Fedora Linux you can install Task from the official
[Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/)
repository using `dnf`:
[[package](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/)] [[source](https://src.fedoraproject.org/rpms/golang-github-task)]

```shell
sudo dnf install go-task
dnf install go-task
```

This installation method is community owned. After a new release of Task, it may
take some time until it's available in
[Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/).

### Nix
### NixOS ([nix][nix]) ![NixOS][nixos] ![Linux][linux] ![Community][community]

If you're on NixOS or have Nix installed you can install Task from
[nixpkgs](https://github.com/NixOS/nixpkgs):
[[source](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/go/go-task/package.nix)]

```shell
nix-env -iA nixpkgs.go-task
```

This installation method is community owned. After a new release of Task, it may
take some time until it's available in
[nixpkgs](https://github.com/NixOS/nixpkgs).
### [Pacstall][pacstall] ![Debian][debian] ![Ubuntu][ubuntu] ![Community][community]

### npm

You can also use Node and npm to install Task by installing
[this package](https://www.npmjs.com/package/@go-task/cli).
[[package](https://pacstall.dev/packages/go-task-deb)] [[source](https://github.com/pacstall/pacstall-programs/blob/master/packages/go-task-deb/go-task-deb.pacscript)]

```shell
npm install -g @go-task/cli
pacstall -I go-task-deb
```

### Winget
### [pkgx][pkgx] ![MacOS][macos] ![Linux][linux] ![Community][community]

If you are using Windows and installed the
[winget](https://github.com/microsoft/winget-cli) package management tool, you
can install Task from [winget-pkgs](https://github.com/microsoft/winget-pkgs).
[[package](https://pkgx.dev/pkgs/taskfile.dev)] [[source](https://github.com/pkgxdev/pantry/blob/main/projects/taskfile.dev/package.yml)]

```shell
winget install Task.Task
pkgx task
```

### Pacstall
If you are using Debian or Ubuntu, and have [Pacstall](https://pacstall.dev/) installed, you can install Task by running:
or, if you have pkgx integration enabled:

```shell
pacstall -I go-task-deb
task
```

This installation method is community owned. After a new release of Task, it may take some time until it's available in [Pacstall](https://pacstall.dev/packages/go-task-deb).

## Get The Binary

### Binary
Expand Down Expand Up @@ -312,13 +288,30 @@ task --completion fish > ~/.config/fish/completions/task.fish
</TabItem></Tabs>

{/* prettier-ignore-start */}
[go]: https://golang.org/
[homebrew]: https://brew.sh
[snapcraft]: https://snapcraft.io/task
[homebrew]: https://brew.sh/
[installscript]: https://github.com/go-task/task/blob/main/install-task.sh
[releases]: https://github.com/go-task/task/releases
[winget]: https://github.com/microsoft/winget-cli
[choco]: https://chocolatey.org
[scoop]: https://scoop.sh
[pacman]: https://wiki.archlinux.org/title/Pacman
[dnf]: https://docs.fedoraproject.org/en-US/quick-docs/dnf
[nix]: https://nixos.org
[npm]: https://www.npmjs.com
[pacstall]: https://github.com/pacstall/pacstall
[pkgx]: https://pkgx.sh

[go]: https://golang.org
[godownloader]: https://github.com/goreleaser/godownloader
[choco]: https://chocolatey.org/
[scoop]: https://scoop.sh/
[pkgx]: https://pkgx.sh/
[releases]: https://github.com/go-task/task/releases
[installscript]: https://github.com/go-task/task/blob/main/install-task.sh

[community]: https://img.shields.io/badge/Community%20Owned-orange
[windows]: https://custom-icon-badges.demolab.com/badge/Windows-0078D6?logo=windows11&logoColor=white
[macos]: https://img.shields.io/badge/MacOS-000000?logo=apple&logoColor=F0F0F0
[linux]: https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black
[arch]: https://img.shields.io/badge/Arch%20Linux-1793D1?logo=arch-linux&logoColor=fff
[fedora]: https://img.shields.io/badge/Fedora-51A2DA?logo=fedora&logoColor=fff
[nixos]: https://img.shields.io/badge/NixOS-5277C3?logo=nixos&logoColor=fff
[debian]: https://img.shields.io/badge/Debian-A81D33?logo=debian&logoColor=fff
[ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?logo=ubuntu&logoColor=fff
{/* prettier-ignore-end */}
Loading