documentation on paths and environment vars

This commit is contained in:
tjex 2023-11-04 20:53:33 +01:00
parent 20c658a503
commit 75e9306c0d
2 changed files with 22 additions and 0 deletions

View file

@ -90,6 +90,7 @@ The full syntax and examples can be found [here](docs/cheatsheet_syntax.md).
You can:
- [setup your own config file](docs/config_file.md)
- [set custom paths for your config file and cheat sheets](docs/paths_and_environment_variables.md)
- [change colors](docs/customization.md#changing-colors)
- [resize columns](docs/customization.md#resizing-columns)
- [change how search is performed](docs/customization.md#overriding-fzf-options)

View file

@ -0,0 +1,21 @@
# Paths and Environment Variables
Navi uses the [`directories-next`](https://crates.io/crates/directories-next) package, which
defines platform-specific standard locations of directories for config, cache and other data.
Mac users, this is why your files are being stored in `~/Library/Application Support/navi`.
To set custom paths for your config and cheat sheets, you can set the following
environment variables:
```zsh
export NAVI_CONFIG="~/.config/navi/config.yaml"
export NAVI_PATH="~/.local/share/navi"
```
Note! Even when set, `$NAVI_PATH` will not be used when installing cheat
sheets directly via navi's own commands.
For example when running `navi add repo <repo> `~/Library/...` will still be used.
Instead, you may clone repos directly into `$NAVI_PATH`, or write your own
manually.