navi/docs/installation.md
2022-07-08 11:15:34 +09:00

3.8 KiB

Installation

Installing the main binary

Using Homebrew

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 --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:

Packaging status

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)

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

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