mise config explain

• Usage: mise config explain [FLAGS] [KEY]
• Effect: read-only
• Source code: src/cli/config/explain.rs

Describe each key in a mise TOML file

Lists every key the file sets, with its line and what it does, from the same schema editors use to check a config. A key mise does not read is marked, with the known key it most likely meant, and so is a deprecated one. Reads the highest-precedence loaded TOML file by default; select another with --file, --global, or --system.

Arguments

• [KEY] — Dotted key path to describe, with the keys under it; omit for the whole file

  Quote a key with a dot in its name as TOML does, inside shell quotes: 'tasks."build.sh"'. Unquoted, tasks.build.sh still finds the task build.sh when there is no key build in the way.

Flags

• -f --file <FILE> — Config file to read, or a directory whose config file to read

  Defaults to the highest-precedence loaded TOML file other than the global override files.

  Aliases: --path

• -g --global — Read the global config file

• --system — Read the system config file

• --override — Read the global override file, config.override.toml

• -J --json — Print the keys as JSON

• -h --help — Print help

Examples

Describe the keys of the project config

mise config explain
~/src/app/mise.toml
   1  tools                  dev tools to use
   2  tools.node             a version of the tool, or a table with its version and options
   4  settings               mise settings
   5  settings.experimantal  not a key mise reads; did you mean experimental?

Describe only the keys under [tasks]

mise config explain tasks

Related documentation

• Configuration.
• mise config [FLAGS] [SUBCOMMAND].
• Global flags and argument syntax.