Skip to content

Commit

Permalink
Merge pull request #124 from alxbl/omz-readme
Browse files Browse the repository at this point in the history
doc(#121): Clarify that oh-my-zsh does not add navi to PATH.

I've updated the documentation for oh-my-zsh setup to explicitly state that navi won't be callable as a command unless it is also installed or manually added to PATH, along with instructions on how to do that.

Cheers,
Alex
  • Loading branch information
denisidoro authored Oct 14, 2019
2 parents 6036e3c + 653d30c commit fe8c6fd
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------
Expand Down

0 comments on commit fe8c6fd

Please sign in to comment.