mirror of
				https://github.com/cheat/cheat.git
				synced 2025-11-04 07:45:28 +01:00 
			
		
		
		
	update due to new Go version
@@ -1,64 +1,5 @@
 | 
			
		||||
There are several methods for installing `cheat` on your system.
 | 
			
		||||
 | 
			
		||||
### pip ###
 | 
			
		||||
`pip` is the recommended installation method for most users. Simply run:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
[sudo] pip install cheat
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
it is also possible to install cheat as user only by running
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
pip install --user cheat
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
then you have extend your `PATH` to include $HOME/.local/bin:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
export PATH="$HOME/.local/bin:$PATH"
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
This line can be added to your bashrc/zshrc.
 | 
			
		||||
 | 
			
		||||
### homebrew ###
 | 
			
		||||
To install `cheat` using homebrew, run:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
brew install cheat
 | 
			
		||||
```
 | 
			
		||||
### Fedora ###
 | 
			
		||||
To install 'cheat' in Fedora, install through official repositories
 | 
			
		||||
```sh
 | 
			
		||||
sudo dnf install cheat
 | 
			
		||||
```
 | 
			
		||||
or through copr
 | 
			
		||||
```sh
 | 
			
		||||
sudo dnf copr enable tkorbar/cheat
 | 
			
		||||
sudo dnf install cheat
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Nix/NixOS ###
 | 
			
		||||
To install `cheat` using Nix, run:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
nix-env -i cheat
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### manually ###
 | 
			
		||||
First, install the dependencies:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
[sudo] pip install docopt pygments appdirs
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Then clone this repository:
 | 
			
		||||
```sh
 | 
			
		||||
git clone git@github.com:chrisallenlane/cheat.git
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Lastly, `cd` into the cloned directory, then run:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
[sudo] python setup.py install
 | 
			
		||||
```
 | 
			
		||||
- by downloading the precompiled binary from the [releases page](https://github.com/cheat/cheat/releases)
 | 
			
		||||
- by using the `go get` command to download and build from GitHub
 | 
			
		||||
- via the package manager of your Linux distribution
 | 
			
		||||
		Reference in New Issue
	
	Block a user