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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

馃摑 added install instruction for windows #748

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

馃摑 added install instruction for windows #748

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 9 additions & 2 deletions INSTALLING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,13 @@ You may need to need to change the version number (`4.4.2`) and the archive
See the [releases page][releases] for a list of supported platforms.

#### Windows
TODO: community support is requested here. Please open a PR if you'd like to
contribute installation instructions for Windows.
### Install via chocolatey

from an elevated powershell with chocolatey package manager installed

```powershell
choco install cheat
```

### Install via `go install`
If you have `go` version `>=1.17` available on your `PATH`, you can install
Expand All @@ -42,6 +47,7 @@ brew | [cheat][pkg-brew]
docker | [docker-cheat][pkg-docker]
nix | [nixos.cheat][pkg-nix]
snap | [cheat][pkg-snap]
chocolatey | [cheat][pkg-choco]

<!--[pacman][] |-->

Expand Down Expand Up @@ -76,4 +82,5 @@ export CHEAT_CONFIG_PATH="~/.dotfiles/cheat/conf.yml"
[pkg-docker]: https://github.com/bannmann/docker-cheat
[pkg-nix]: https://search.nixos.org/packages?channel=unstable&show=cheat&from=0&size=50&sort=relevance&type=packages&query=cheat
[pkg-snap]: https://snapcraft.io/cheat
[pkg-choco]: https://community.chocolatey.org/packages/cheat
[releases]: https://github.com/cheat/cheat/releases