From 212ed34bd754bf432923c54a573d655af33fdaa8 Mon Sep 17 00:00:00 2001 From: Rubem Pacelli Date: Sun, 10 Dec 2023 23:17:07 -0300 Subject: [PATCH 1/4] add: logging to navi_config.md --- docs/navi_config.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/navi_config.md b/docs/navi_config.md index 6b53af8..85dc4db 100644 --- a/docs/navi_config.md +++ b/docs/navi_config.md @@ -4,7 +4,7 @@ The default config file path is set by the `$NAVI_CONFIG` environment variable. ```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 +30,9 @@ 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 `%`. + +## 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`. From 19ff052223f8deddcf6221a5e3c5e56730bd3359 Mon Sep 17 00:00:00 2001 From: Rubem Pacelli Date: Sun, 10 Dec 2023 23:18:29 -0300 Subject: [PATCH 2/4] Delete docs/config_file.md --- docs/config_file.md | 37 ------------------------------------- 1 file changed, 37 deletions(-) delete mode 100644 docs/config_file.md diff --git a/docs/config_file.md b/docs/config_file.md deleted file mode 100644 index 25498c0..0000000 --- a/docs/config_file.md +++ /dev/null @@ -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`. From 7835f39203bc4fffa6efc436250408137a0ca7bb Mon Sep 17 00:00:00 2001 From: Rubem Pacelli Date: Sun, 10 Dec 2023 23:48:35 -0300 Subject: [PATCH 3/4] Add paths_and_env_vars.md into navi_config.md --- docs/navi_config.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/navi_config.md b/docs/navi_config.md index 85dc4db..e702307 100644 --- a/docs/navi_config.md +++ b/docs/navi_config.md @@ -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 `, 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. From fa7215ed5bd84b9b57a7320c3e31d33e6a84b643 Mon Sep 17 00:00:00 2001 From: Rubem Pacelli Date: Sun, 10 Dec 2023 23:48:52 -0300 Subject: [PATCH 4/4] Delete docs/paths_and_env_vars.md --- docs/paths_and_env_vars.md | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 docs/paths_and_env_vars.md diff --git a/docs/paths_and_env_vars.md b/docs/paths_and_env_vars.md deleted file mode 100644 index f0cdbb9..0000000 --- a/docs/paths_and_env_vars.md +++ /dev/null @@ -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 `, 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).