diff options
author | Rubem Pacelli <rubem.engenharia@gmail.com> | 2023-12-04 03:17:34 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-12-04 03:17:34 -0300 |
commit | fdc5603278016cab01074909fb4507411011e012 (patch) | |
tree | 1303cb59c6c0f1669b713aa402d99f163bcf03ac | |
parent | 924ffb82ad02d1c1a183b435b8c2f93642893bf3 (diff) |
Update navi_config.md
-rw-r--r-- | docs/navi_config.md | 41 |
1 files changed, 21 insertions, 20 deletions
diff --git a/docs/navi_config.md b/docs/navi_config.md index d7db573..eb0bebf 100644 --- a/docs/navi_config.md +++ b/docs/navi_config.md @@ -1,31 +1,32 @@ -## Config file - -- [Example](#example) -- [Location](#location) -- [Creating the file](#creating-the-file) - -### Example - -An example config can be found by running: +## 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 +```sh +navi info config-path +``` +prints which config file path is being used. You can get an config file example by running ```sh navi info config-example ``` - -You can also read it online by clicking [here](./config_file_example.yaml). - -### Location - -Run the following command to check where the config file is/should be located: +or by clicking [here](./config_file_example.yaml). To this this example your config file, run ```sh -navi info config-path +navi info config-example > "$(navi info config-path)" ``` +## Cheat sheet paths -### Creating the file - -Run the following command to generate a config file with the default parameters: +The default `.cheat` files paths are defined in the `$NAVI_PATH` environment variable in a colon-separated list, e.g., +``` +export NAVI_PATH='/path/to/a/dir:/path/to/another/dir:/yet/another/dir' +``` +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 there is no `.cheat` file paths settings there, the default `.cheat` file path fallbacks to `~/.local/share/navi/cheats/`. The command +```sh +navi info cheats-path +``` +prints to you all paths used to search for `.cheat` files. +You can also add other paths at runtime by running `navi` with the `--path` option and a colon-separed paths list, e.g., ```sh -navi info config-example > "$(navi info config-path)" +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 `%`. |