diff options
| author | tjex <tjex@tjex.net> | 2023-11-04 20:53:33 +0100 |
|---|---|---|
| committer | Denis Isidoro <denis.isidoro@uber.com> | 2023-12-10 06:26:34 -0300 |
| commit | 422d37f328b6d2e1d9edf383f246b60756c5f498 (patch) | |
| tree | 2c2e137b36b6dd3eeed9175e39d9ff19509f7f9c | |
| parent | aeb9cd4b8baf80cb19a2de31c634437c847ea236 (diff) | |
documentation on paths and environment vars
| -rw-r--r-- | README.md | 1 | ||||
| -rw-r--r-- | docs/paths_and_environment_variables.md | 21 |
2 files changed, 22 insertions, 0 deletions
@@ -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) diff --git a/docs/paths_and_environment_variables.md b/docs/paths_and_environment_variables.md new file mode 100644 index 0000000..c53e828 --- /dev/null +++ b/docs/paths_and_environment_variables.md @@ -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. |