navi/docs/paths_and_env_vars.md

26 lines
1.1 KiB
Markdown
Raw Normal View History

# 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"
```
2023-11-04 20:03:10 +00:00
Despite `$NAVI_PATH` being set, it will not be used when installing cheat
sheets directly via navi's own commands.
2023-11-04 19:56:48 +00:00
For example when running `navi add repo <repo>`, the default paths as per the `directories-next`
package will still be used.
2023-11-04 19:56:48 +00:00
To avoid this, you may simply clone repos via a regular `git clone` command,
directly into `$NAVI_PATH`.
2023-11-04 20:03:10 +00:00
Note! `navi info cheats-path` and `navi info config-path` display the *default* path, not
the path set by the user. [It is known that this is a little misleading!](https://github.com/denisidoro/navi/issues/664#issuecomment-1004721178).