navi/docs/usage
alexis-opolka fda4a2d154 Update the repo subcommands docs
Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>
2025-04-01 09:07:19 +02:00
..
commands Update the repo subcommands docs 2025-04-01 09:07:19 +02:00
fzf-overrides Moved parts around and updated the TOC 2025-03-29 12:31:47 +01:00
shell-scripting Refactors shell-scripting article 2025-03-29 23:31:55 +01:00
README.md Update the usage article 2025-03-30 07:39:28 +02:00

The usage of Navi

Navi can be used in multiple ways

Defining the cheatsheets path at runtime

You can define the paths to use for cheatsheets at runtime using the --path parameter and a colon-separated paths list

For example, if we want to search for cheatsheets in /some/dir and in /other/dir:

navi --path '/some/dir:/other/dir'

Logging

The log file will be created under the same directory where the configuration file is located.
You can use the RUST_LOG environment variable to set the log level.

For example, to have the logging in debug mode when running navi:

RUST_LOG=debug navi

Note

If the directory of the configuration file doesn't exist, no log file is going to be created.