mirror of
https://github.com/denisidoro/navi
synced 2024-11-24 12:33:05 +00:00
documentation on paths and environment vars
This commit is contained in:
parent
aeb9cd4b8b
commit
422d37f328
2 changed files with 22 additions and 0 deletions
|
@ -90,6 +90,7 @@ The full syntax and examples can be found [here](docs/cheatsheet_syntax.md).
|
||||||
You can:
|
You can:
|
||||||
|
|
||||||
- [setup your own config file](docs/config_file.md)
|
- [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)
|
- [change colors](docs/customization.md#changing-colors)
|
||||||
- [resize columns](docs/customization.md#resizing-columns)
|
- [resize columns](docs/customization.md#resizing-columns)
|
||||||
- [change how search is performed](docs/customization.md#overriding-fzf-options)
|
- [change how search is performed](docs/customization.md#overriding-fzf-options)
|
||||||
|
|
21
docs/paths_and_environment_variables.md
Normal file
21
docs/paths_and_environment_variables.md
Normal 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.
|
Loading…
Reference in a new issue