navi/docs/installation.md

Installation

• Installing the main binary
  • Using Homebrew or Linuxbrew
  • Using Gentoo
  • Using nix
  • Using cargo
  • Using install script
  • Downloading pre-compiled binaries
  • Building from source
  • Other package managers
• Installing the shell widget

Installing the main binary

Using Homebrew or Linuxbrew

brew install navi

Using Gentoo

Be sure to enable the GURU overlay.

emerge -a app-misc/navi

Using nix

nix-env -iA nixpkgs.navi

Using cargo

cargo install navi

Using install script

bash <(curl -sL https://raw.githubusercontent.com/denisidoro/navi/master/scripts/install)

# (optional) to set directories:
# SOURCE_DIR=/opt/navi BIN_DIR=/usr/local/bin bash <(curl -sL https://raw.githubusercontent.com/denisidoro/navi/master/scripts/install)

Downloading pre-compiled binaries

• download the correct binary here
• extract the content to your $PATH

Building from source

git clone https://github.com/denisidoro/navi ~/.navi
cd ~/.navi
make install 

# (optional) to set the install directory:
# make BIN_DIR=/usr/local/bin install

Other package managers

You can find navi for more package managers by clicking on the image below:

Feel free to be the maintainer of navi for any package manager you'd like!

Installing the shell widget

If you want to use the shell widget, add this line to your .bashrc-like file:

# bash
source <(echo "$(navi widget bash)")

# zsh
source <(echo "$(navi widget zsh)")

# fish
navi widget fish | source

By default, Ctrl+G is assigned to launching navi.