denisidoro/navi
1
1
Fork 0
mirror of https://github.com/denisidoro/navi.git synced 2024-09-18 22:07:34 +03:00
Code Issues Projects Releases Wiki Activity

doc(#121): Clarify that oh-my-zsh does not add navi to PATH.

Browse Source
This commit is contained in:
Alexandre Beaulieu 2019-10-12 12:45:43 -04:00
parent cc2e3f7832
commit 1a6407d9ff
No known key found for this signature in database
GPG Key ID: 8B02EA7AE3FC7081
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

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