navi/docs/usage/commands/info/README.md

The info subcommands of navi

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

• The info subcommands of navi
  • Commands Reference
  • Default configuration information
    • Default configuration path
    • Example configuration file
  • Default cheatsheets path

Commands Reference

Command	Description
config-path	[DEPRECATED] Lets you see the default config path
cheats-path	[DEPRECATED] Lets you see the default cheats path
default-config-path	Lets you see the default config path
default-cheats-path	Lets you see the default cheats path
config-example	Lets you see an example for the configuration file
cheats-example	Lets you see an example for a cheat file

Default configuration information

Default configuration path

Navi exposes its default configuration path with:

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:

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:

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

Default cheatsheets path

Navi exposes its default cheatsheets path with:

navi info cheats-path

Note

See /docs/configuration/ for more details on how the cheatsheets path is defined.