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

Merge pull request #866 from tapyu/tidy-up

Browse Source 
concentrate all information concerning the navi settings in `docs/navi_config.md`
This commit is contained in:
Denis Isidoro 2023-12-11 22:24:56 -03:00 committed by GitHub
commit 6692d6ab36
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/config_file.md
View File

@ -1,37 +0,0 @@
## Config file
- [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:
```sh
navi info config-path
```
### Creating the file
Run the following command to generate a config file with the default parameters:
```sh
navi info config-example > "$(navi info config-path)"
```
### 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`.

18
docs/navi_config.md
View File

@ -1,10 +1,15 @@
# 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
```sh
navi info config-path
```
prints which config file path is being used. You can get an config file example by running
prints which config file path is being used. You can get a config file example by running
```sh
navi info config-example
```
@ -30,3 +35,14 @@ You can also add other paths at runtime by running `navi` with the `--path` opti
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 `%`.
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.
And you can use the `RUST_LOG` env to set the log level, e.g. `RUST_LOG=debug navi`.

25
docs/paths_and_env_vars.md
View File

@ -1,25 +0,0 @@
# 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"
```
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).