diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 20 insertions, 3 deletions
@@ -76,14 +76,28 @@ cd "$plugins_dir" git clone https://github.com/denisidoro/navi ``` -Then, add it to the oh-my-zsh plugin array: +Then, add it to the oh-my-zsh plugin array to automatically enable the zsh widget: ```sh plugins=(docker tmux fzf navi) ``` -Finally, you can use it as a [shell widget](#shell-widget). +Lastly, reload your `zshrc` or spawn a new terminal to load navi. Once this is done, you should be able to use it +as a [shell widget](#shell-widget) with no additional setup. + +> Please note that when installing as an oh-my-zsh plugin, `navi` will not be available as a command. If you also want +> to be able to run the command interactively, you will need to do one of the following: + +- Install it to /usr/bin/local (via `sudo make install`) +- Manually set your `PATH` so that navi can be found. + +You can manually update your path by adding a line like this in your `.zshrc`: + +```sh +export PATH=$PATH:"$ZSH_CUSTOM/plugins/navi" +``` + +And verify that it works by running `which navi` after reloading your configuration. -This method has the advantage of not requiring root to install and the disadvantage of not allowing you to invoke the script by calling `navi` (unless you add an alias to it or copy it to a folder in `$PATH`). Upgrading --------- @@ -124,6 +138,9 @@ source "$(navi widget bash)" # zsh source "$(navi widget zsh)" + +# fish +source (navi widget fish) ``` By default, `Ctrl+G` is assigned to launching **navi**. If you want to change the keybinding, replace the argument of `bind` or `bindkey` in [the widget file](https://github.com/denisidoro/navi/search?q=filename%3Anavi.plugin.*&unscoped_q=filename%3Anavi.plugin.*). |