mirror of
https://github.com/denisidoro/navi
synced 2024-11-21 19:13:07 +00:00
Update navi_config.md
This commit is contained in:
parent
924ffb82ad
commit
fdc5603278
1 changed files with 24 additions and 23 deletions
|
@ -1,31 +1,32 @@
|
||||||
## Config file
|
## Config file path
|
||||||
|
|
||||||
- [Example](#example)
|
|
||||||
- [Location](#location)
|
|
||||||
- [Creating the file](#creating-the-file)
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
An example config can be found 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:
|
|
||||||
|
|
||||||
|
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
|
```sh
|
||||||
navi info config-path
|
navi info config-path
|
||||||
```
|
```
|
||||||
|
prints which config file path is being used. You can get an config file example by running
|
||||||
### Creating the file
|
```sh
|
||||||
|
navi info config-example
|
||||||
Run the following command to generate a config file with the default parameters:
|
```
|
||||||
|
or by clicking [here](./config_file_example.yaml). To this this example your config file, run
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
navi info config-example > "$(navi info config-path)"
|
navi info config-example > "$(navi info config-path)"
|
||||||
```
|
```
|
||||||
|
## Cheat sheet paths
|
||||||
|
|
||||||
|
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 --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 `%`.
|
||||||
|
|
Loading…
Reference in a new issue