Back to Navi

The info subcommands of navi

docs/usage/commands/info/README.md

2.24.02.2 KB
Original Source

The info subcommands of navi

Navi exposes information about its default values or examples for you to use.

<!-- TOC --> <!-- TOC -->

Commands Reference

CommandDescription
config-path[DEPRECATED] Lets you see the default config path
cheats-path[DEPRECATED] Lets you see the default cheats path
default-config-pathLets you see the default config path
default-cheats-pathLets you see the default cheats path
config-exampleLets you see an example for the configuration file
cheats-exampleLets you see an example for a cheat file

Default configuration information

Default configuration path

Navi exposes its default configuration path with:

sh
navi info config-path

[!NOTE] See /docs/configuration/ for more details on how the default configuration path is defined.

Example configuration file

Navi lets you get an example configuration file with:

sh
navi info config-example

[!NOTE] You can retrieve this file at the following address: /docs/examples/configuration/config-example.yaml

For example, you can use this command to create the default configuration file, if not already present:

sh
navi info config-example > "$(navi info config-path)"

Default cheatsheets path

Navi exposes its default cheatsheets path with:

sh
navi info cheats-path

[!NOTE] See /docs/configuration/ for more details on how the cheatsheets path is defined.