navi/docs/navi_config.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

2023-12-04 06:17:34 +00:00
## Config file path
2023-12-04 07:07:51 +00:00
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
2023-12-04 06:17:34 +00:00
```sh
navi info config-path
```
2023-12-11 02:17:07 +00:00
prints which config file path is being used. You can get a config file example by running
```sh
navi info config-example
```
2023-12-04 07:08:41 +00:00
or by clicking [here](./config_file_example.yaml). To turn this example your config file, run
```sh
2023-12-04 06:17:34 +00:00
navi info config-example > "$(navi info config-path)"
```
2023-12-04 06:17:34 +00:00
## Cheat sheet paths
2023-12-04 06:17:34 +00:00
The default `.cheat` files paths are defined in the `$NAVI_PATH` environment variable in a colon-separated list, e.g.,
2023-12-04 07:09:23 +00:00
```sh
2023-12-04 06:17:34 +00:00
export NAVI_PATH='/path/to/a/dir:/path/to/another/dir:/yet/another/dir'
```
2023-12-04 07:11:06 +00:00
If this environment variable is unset or if all directories do not exist, `navi` uses that paths defined in its config files. Finally, if there is no config file or if the `.cheat` file paths was not set, the default `.cheat` file paths fallbacks to `~/.local/share/navi/cheats/`. The command
2023-12-04 06:17:34 +00:00
```sh
navi info cheats-path
```
prints to you all paths used to search for `.cheat` files.
2023-12-04 06:17:34 +00:00
You can also add other paths at runtime by running `navi` with the `--path` option and a colon-separed paths list, e.g.,
```sh
2023-12-04 06:17:34 +00:00
navi --path '/some/dir:/other/dir'
```
2023-12-04 06:17:34 +00:00
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 `%`.
2023-12-11 02:17:07 +00:00
## Logging
The log file will be created under the same directory where the config locates.
And you can use the `RUST_LOG` env to set the log level, e.g. `RUST_LOG=debug navi`.