navi/docs/installation.md

Installation

• Installing the main binary
  • Using Homebrew
  • 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

brew install navi

Using Gentoo

Be sure to enable the GURU overlay.

emerge -a app-misc/navi

Using pacman

pacman -S navi

Using nix

nix-env -iA nixpkgs.navi

Using cargo

cargo install --locked navi

Using choco

For Windows user, using powershell

1. Install package via choco

   choco install navi
   

2. Create $env:USERPROFILE\AppData\Roaming\navi\config.yaml and override shell.command as per config_file_example.yaml

   style:
     tag:
       color: cyan
     comment:
       color: grey
     snippet:
       color: white
   
   shell:
     command: powershell
   

   Remark: Above example also adds custom colors for better readability in case you use standard blue for your Powershell

Using install script

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

# (optional) to set directories:
# 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

Compile time environment variables

navi supports environment variables at compile time that modify the behavior of the binary at runtime:

• NAVI_PATH (directory path value): If the cheats directory in the user's directory does not exist, navi uses this path (if it exists), as a fallback location to look for cheat files. Use case: system-wide installed, shared used cheatsheets folder.
• NAVI_CONFIG (file path value): If the config.yaml file in the user's directory does not exist, navi uses this path (if it exists), as a fallback location to look for a configuration file. Use case: system-wide installed, shared used configuration file.

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 install it, add this line to your .bashrc-like file:

# bash
eval "$(navi widget bash)"

# zsh
eval "$(navi widget zsh)"

# fish
navi widget fish | source

# elvish
eval (navi widget elvish | slurp)

# xonsh
# xpip install xontrib-navi # ← run in your xonsh session to install xontrib
xontrib load navi # ← add to your xonsh run control file

Nushell

Due to Nushell's unique design, it is not possible to eval a piece of code dynamically like in other shells therefore the integration process is a bit more involved. Here is an example:

1. run ^navi widget nushell | save ($nu.default-config-dir | path join "navi-integration.nu")
2. add the following lines to config.nu:

   source ($nu.default-config-dir | path join "navi-integration.nu")
   

By default, Ctrl+G is assigned to launching navi (in xonsh can be customized with $X_NAVI_KEY, see xontrib-navi for details).

There's currently no way to customize the widget behavior out-of-the-box. If you want to change the keybinding or the navi flags used by the widget, please:

1. run, e.g., navi widget bash in your terminal
2. copy the output
3. paste the output in your .bashrc-like file
4. edit the contents accordingly