denisidoro/navi
1
1
Fork 0
mirror of https://github.com/denisidoro/navi.git synced 2024-10-06 14:47:48 +03:00
Code Issues Projects Releases Wiki Activity

Add paths_and_env_vars.md into navi_config.md

Browse Source
This commit is contained in:
Rubem Pacelli 2023-12-10 23:48:35 -03:00 committed by GitHub
parent 19ff052223
commit 7835f39203
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/navi_config.md
View File

@ -1,3 +1,8 @@
# 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`).
## Config file path
The default config file path is set by the `$NAVI_CONFIG` environment variable. If it is not set, it fallbacks to `~/.config/navi/config.yaml`. The command
@ -31,7 +36,12 @@ navi --path '/some/dir:/other/dir'
```
It's irrelevant the directory structure within each path. They can even be all in a single file if you wish, as long as you split them accordingly with lines starting with `%`.
## Logging
Despite `$NAVI_PATH` being set, it will not be used when installing cheat sheets directly via navi's own commands. For example when running `navi add repo <repo>`, the default paths as per the `directories-next` package will still be used. To avoid this, you may simply clone repos via a regular `git clone` command, directly into `$NAVI_PATH`.
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).
# Logging
The log file will be created under the same directory where the config locates.