Skip to content
This repository has been archived by the owner on Jun 1, 2024. It is now read-only.

Latest commit

 

History

History
567 lines (384 loc) · 20.9 KB

configuration.md

File metadata and controls

567 lines (384 loc) · 20.9 KB
Raw

Configuration

.mise.toml

.mise.toml is a new config file that replaces asdf-style .tool-versions files with a file that has lot more flexibility. It supports functionality that is not possible with .tool-versions, such as:

  • setting arbitrary env vars while inside the directory
  • passing options to plugins like virtualenv=".venv" for python.
  • specifying custom plugin URLs

They can use any of the following file locations (in order of precedence, top is highest):

  • .mise.local.toml
  • mise.local.toml
  • .mise.$MISE_ENV.toml
  • mise.$MISE_ENV.toml
  • .mise.toml
  • .mise/config.toml
  • mise.toml
  • mise/config.toml
  • .config/mise.toml
  • .config/mise/config.toml

See Profiles for more information about .mise.$MISE_ENV.toml files. These files recurse upwards, so if you have a ~/src/work/myproj/.mise.toml file, what is defined there will override anything set in ~/src/work/.mise.toml or ~/.config/mise.toml. The config contents are merged together.

:::tip Run mise config to see what files mise has loaded along with their precedence. :::

Here is what an .mise.toml looks like:

[env]
# supports arbitrary env vars so mise can be used like direnv/dotenv
NODE_ENV = 'production'

[tools]
# specify single or multiple versions
terraform = '1.0.0'
erlang = ['23.3', '24.0']

# supports everything you can do with .tool-versions currently
node = ['16', 'prefix:20', 'ref:master', 'path:~/.nodes/14']

# send arbitrary options to the plugin, passed as:
# MISE_TOOL_OPTS__VENV=.venv
python = {version='3.10', virtualenv='.venv'}

[plugins]
# specify a custom repo url
# note this will only be used if the plugin does not already exist
python = 'https://github.com/asdf-community/asdf-python'

[alias.node] # project-local aliases
my_custom_node = '20'

.mise.toml files are hierarchical. The configuration in a file in the current directory will override conflicting configuration in parent directories. For example, if ~/src/myproj/.mise.toml defines the following:

[tools]
node = '20'
python = '3.10'

And ~/src/myproj/backend/.mise.toml defines:

[tools]
node = '18'
ruby = '3.1'

Then when inside of ~/src/myproj/backend, node will be 18, python will be 3.10, and ruby will be 3.1. You can check the active versions with mise ls --current.

You can also have environment specific config files like .mise.production.toml, see Profiles for more details.

[env] - Arbitrary Environment Variables

See environments.

[plugins] - Specify Custom Plugin Repository URLs

Use [plugins] to add/modify plugin shortnames. Note that this will only modify new plugin installations. Existing plugins can use any URL.

[plugins]
elixir = "https://github.com/my-org/mise-elixir.git"
node = "https://github.com/my-org/mise-node.git#DEADBEEF" # supports specific gitref

If you simply want to install a plugin from a specific URL once, it's better to use mise plugin install plugin <GIT_URL>. Add this section to .mise.toml if you want to share the plugin location/revision with other developers in your project.

This is similar to MISE_SHORTHANDS but doesn't require a separate file.

[aliases] - Tool version aliases

The following makes mise install node@my_custom_node install node-20.x this can also be specified in a plugin. note adding an alias will also add a symlink, in this case:

~/.local/share/mise/installs/node/20 -> ./20.x.x

my_custom_node = '20'

Global config: ~/.config/mise/config.toml

mise can be configured in ~/.config/mise/config.toml. It's like local .mise.toml files except that it is used for all directories.

[tools]
# global tool versions go here
# you can set these with `mise use -g`
node = 'lts'
python = ['3.10', '3.11']

[settings]
# plugins can read the versions files used by other version managers (if enabled by the plugin)
# for example, .nvmrc in the case of node's nvm
legacy_version_file = true                     # enabled by default (unlike asdf)
legacy_version_file_disable_tools = ['python'] # disable for specific tools

# configure `mise install` to always keep the downloaded archive
always_keep_download = false        # deleted after install by default
always_keep_install = false         # deleted on failure by default

# configure how frequently (in minutes) to fetch updated plugin repository changes
# this is updated whenever a new runtime is installed
# (note: this isn't currently implemented but there are plans to add it: https://github.com/jdx/mise/issues/128)
plugin_autoupdate_last_check_duration = '1 week' # set to 0 to disable updates

# config files with these prefixes will be trusted by default
trusted_config_paths = [
    '~/work/my-trusted-projects',
]

verbose = false     # set to true to see full installation output, see `MISE_VERBOSE`
asdf_compat = false # set to true to ensure .tool-versions will be compatible with asdf, see `MISE_ASDF_COMPAT`
http_timeout = 30   # set the timeout for http requests in seconds, see `MISE_HTTP_TIMEOUT`
jobs = 4            # number of plugins or runtimes to install in parallel. The default is `4`.
raw = false         # set to true to directly pipe plugins to stdin/stdout/stderr
yes = false         # set to true to automatically answer yes to all prompts

not_found_auto_install = true # see MISE_NOT_FOUND_AUTO_INSTALL
task_output = "prefix" # see Tasks Runner for more information
paranoid = false       # see MISE_PARANOID

shorthands_file = '~/.config/mise/shorthands.toml' # path to the shorthands file, see `MISE_SHORTHANDS_FILE`
disable_default_shorthands = false # disable the default shorthands, see `MISE_DISABLE_DEFAULT_SHORTHANDS`
disable_tools = ['node']           # disable specific tools, generally used to turn off core tools

env_file = '.env' # load env vars from a dotenv file, see `MISE_ENV_FILE`

experimental = true # enable experimental features

# configure messages displayed when entering directories with config files
status = {missing_tools = "if_other_versions_installed", show_env = false, show_tools = false}

System config: /etc/mise/config.toml

Similar to ~/.config/mise/config.toml but for all users on the system. This is useful for setting defaults for all users.

.tool-versions

The .tool-versions file is asdf's config file and it can be used in mise just like .mise.toml. It isn't as flexible so it's recommended to use .mise.toml instead. It can be useful if you already have a lot of .tool-versions files or work on a team that uses asdf.

Here is an example with all the supported syntax:

node        20.0.0       # comments are allowed
ruby        3            # can be fuzzy version
shellcheck  latest       # also supports "latest"
jq          1.6
erlang      ref:master   # compile from vcs ref
go          prefix:1.19  # uses the latest 1.19.x version—needed in case "1.19" is an exact match
shfmt       path:./shfmt # use a custom runtime
node        lts          # use lts version of node (not supported by all plugins)

node        sub-2:lts      # install 2 versions behind the latest lts (e.g.: 18 if lts is 20)
python      sub-0.1:latest # install python-3.10 if the latest is 3.11

See the asdf docs for more info on this file format.

Scopes

Both .mise.toml and .tool-versions support "scopes" which modify the behavior of the version:

  • ref:<SHA> - compile from a vcs (usually git) ref
  • prefix:<PREFIX> - use the latest version that matches the prefix. Useful for Go since 1.20 would only match 1.20 exactly but prefix:1.20 will match 1.20.1 and 1.20.2 etc.
  • path:<PATH> - use a custom compiled version at the given path. One use-case is to re-use Homebrew tools (e.g.: path:/opt/homebrew/opt/node@20).
  • sub-<PARTIAL_VERSION>:<ORIG_VERSION> - subtracts PARTIAL_VERSION from ORIG_VERSION. This can be used to express something like "2 versions behind lts" such as sub-2:lts. Or 1 minor version behind the latest version: sub-0.1:latest.

Legacy version files

mise supports "legacy version files" just like asdf. They're language-specific files like .node-version and .python-version. These are ideal for setting the runtime version of a project without forcing other developers to use a specific tool like mise/asdf.

They support aliases, which means you can have an .nvmrc file with lts/hydrogen and it will work in mise and nvm. Here are some of the supported legacy version files:

Plugin "Legacy" (Idiomatic) Files
crystal .crystal-version
elixir .exenv-version
go .go-version, go.mod
java .java-version, .sdkmanrc
node .nvmrc, .node-version
python .python-version
ruby .ruby-version, Gemfile
terraform .terraform-version, .packer-version, main.tf
yarn .yarnrc

In mise these are enabled by default. You can disable them with mise settings set legacy_version_file false. There is a performance cost to having these when they're parsed as it's performed by the plugin in bin/parse-version-file. However these are cached so it's not a huge deal. You may not even notice.

::: info asdf calls these "legacy version files" so we do too. I think this is a bad name since it implies that they shouldn't be used—which is definitely not the case IMO. I prefer the term "idiomatic" version files since they're version files not specific to asdf/mise and can be used by other tools. (.nvmrc being a notable exception, which is tied to a specific tool.) :::

Settings

The following is a list of all of mise's settings. These can be set via mise settings set, by directly modifying ~/.config/mise/config.toml or local config, or via environment variables.

Some of them also can be set via global CLI flags.

activate_aggressive

  • Type: bool
  • Env: MISE_ACTIVATE_AGGRESSIVE
  • Default: false

Pushes tools' bin-paths to the front of PATH instead of allowing modifications of PATH after activation to take precedence.

For example, if you have the following in your .mise.toml:

[tools]
node = '20'
python = '3.12'

But you also have this in your ~/.zshrc:

eval "$(mise activate zsh)"
PATH="/some/other/python:$PATH"

What will happen is /some/other/python will be used instead of the python installed by mise. This means you typically want to put mise activate at the end of your shell config so nothing overrides it.

If you want to always use the mise versions of tools despite what is in your shell config, set this to true. In that case, using this example again, /some/other/python will be after mise's python in PATH.

asdf_compat

  • Type: bool
  • Env: MISE_ASDF_COMPAT
  • Default: false

Only output .tool-versions files in mise local|global which will be usable by asdf. This disables mise functionality that would otherwise make these files incompatible with asdf such as non-pinned versions.

This will also change the default global tool config to be ~/.tool-versions instead of ~/.config/mise/config.toml.

disable_tools

  • Type: string[] (comma-delimited)
  • Env: MISE_DISABLE_TOOLS
  • Default: []

Disables the specified tools. Separate with ,. Generally used for core plugins but works with any tool.

status.missing_tools

  • Type: enum
  • Env: MISE_STATUS_MISSING_TOOLS
  • Default: if_other_versions_installed
Choice Description
if_other_versions_installed [default] Show the warning only when the tool has at least 1 other version installed
always Always show the warning
never Never show the warning

Show a warning if tools are not installed when entering a directory with a .mise.toml file.

::: tip Disable tools with disable_tools. :::

status.show_env

  • Type: bool
  • Env: MISE_STATUS_SHOW_ENV
  • Default: false

Show configured env vars when entering a directory with a .mise.toml file.

status.show_tools

  • Type: bool
  • Env: MISE_STATUS_SHOW_TOOLS
  • Default: false

Show active tools when entering a directory with a .mise.toml file.

Environment variables

mise can also be configured via environment variables. The following options are available:

MISE_DATA_DIR

Default: ~/.local/share/mise or $XDG_DATA_HOME/mise

This is the directory where mise stores plugins and tool installs. These are not supposed to be shared across machines.

MISE_CACHE_DIR

Default (Linux): ~/.cache/mise or $XDG_CACHE_HOME/mise Default (macOS): ~/Library/Caches/mise or $XDG_CACHE_HOME/mise

This is the directory where mise stores internal cache. This is not supposed to be shared across machines. It may be deleted at any time mise is not running.

MISE_TMP_DIR

Default: std::env::temp_dir() implementation in rust

This is used for temporary storage such as when installing tools.

MISE_SYSTEM_DIR

Default: /etc/mise

This is the directory where mise stores system-wide configuration.

MISE_GLOBAL_CONFIG_FILE

Default: $MISE_CONFIG_DIR/config.toml (Usually ~/.config/mise/config.toml)

This is the path to the config file.

MISE_DEFAULT_TOOL_VERSIONS_FILENAME

Set to something other than ".tool-versions" to have mise look for .tool-versions files but with a different name.

MISE_DEFAULT_CONFIG_FILENAME

Set to something other than .mise.toml to have mise look for .mise.toml config files with a different name.

MISE_ENV

Enables environment-specific config files such as .mise.development.toml. Use this for different env vars or different tool versions in development/staging/production environments. See Profiles for more on how to use this feature.

MISE_ENV_FILE

Set to a filename to read from env from a dotenv file. e.g.: MISE_ENV_FILE=.env. Uses dotenvy under the hood.

MISE_USE_VERSIONS_HOST

Default: true

Set to "false" to disable using mise-versions as a quick way for mise to query for new versions. This host regularly grabs all the latest versions of core and community plugins. It's faster than running a plugin's list-all command and gets around GitHub rate limiting problems when using it.

See FAQ for more information.

MISE_${PLUGIN}_VERSION

Set the version for a runtime. For example, MISE_NODE_VERSION=20 will use [email protected] regardless of what is set in .tool-versions/.mise.toml.

MISE_LEGACY_VERSION_FILE=1

Plugins can read the versions files used by other version managers (if enabled by the plugin) for example, .nvmrc in the case of node's nvm. See legacy version files for more information.

Set to "0" to disable legacy version file parsing.

MISE_LEGACY_VERSION_FILE_DISABLE_TOOLS=node,python

Disable legacy version file parsing for specific tools. Separate with ,.

MISE_USE_TOML=0

Set to 1 to default to using .mise.toml in mise local instead of .tool-versions for configuration.

For now this is not used by mise use which will only use .mise.toml unless --path is specified.

MISE_TRUSTED_CONFIG_PATHS

This is a list of paths that mise will automatically mark as trusted. They can be separated with :.

MISE_LOG_LEVEL=trace|debug|info|warn|error

These change the verbosity of mise.

You can also use MISE_DEBUG=1, MISE_TRACE=1, and MISE_QUIET=1 as well as --log-level=trace|debug|info|warn|error.

MISE_LOG_FILE=~/mise.log

Output logs to a file.

MISE_LOG_FILE_LEVEL=trace|debug|info|warn|error

Same as MISE_LOG_LEVEL but for the log file output level. This is useful if you want to store the logs but not have them litter your display.

MISE_ALWAYS_KEEP_DOWNLOAD=1

Set to "1" to always keep the downloaded archive. By default it is deleted after install.

MISE_ALWAYS_KEEP_INSTALL=1

Set to "1" to always keep the install directory. By default it is deleted on failure.

MISE_VERBOSE=1

This shows the installation output during mise install and mise plugin install. This should likely be merged so it behaves the same as MISE_DEBUG=1 and we don't have 2 configuration for the same thing, but for now it is its own config.

Equivalent to MISE_LOG_LEVEL=debug.

MISE_QUIET=1

Equivalent to MISE_LOG_LEVEL=warn.

MISE_PARANOID=0

Enables extra-secure behavior. See Paranoid.

MISE_HTTP_TIMEOUT

Set the timeout for http requests in seconds. The default is 30.

MISE_JOBS=1

Set the number plugins or runtimes to install in parallel. The default is 4.

MISE_RAW=1

Set to "1" to directly pipe plugin scripts to stdin/stdout/stderr. By default stdin is disabled because when installing a bunch of plugins in parallel you won't see the prompt. Use this if a plugin accepts input or otherwise does not seem to be installing correctly.

Sets MISE_JOBS=1 because only 1 plugin script can be executed at a time.

MISE_SHORTHANDS_FILE=~/.config/mise/shorthands.toml

Use a custom file for the shorthand aliases. This is useful if you want to share plugins within an organization.

Shorthands make it so when a user runs something like mise install elixir mise will automatically install the asdf-elixir plugin. By default, it uses the shorthands in src/default_shorthands.rs.

The file should be in this toml format:

elixir = "https://github.com/my-org/mise-elixir.git"
node = "https://github.com/my-org/mise-node.git"

MISE_DISABLE_DEFAULT_SHORTHANDS=1

Disables the shorthand aliases for installing plugins. You will have to specify full URLs when installing plugins, e.g.: mise plugin install node https://github.com/asdf-vm/asdf-node.git

MISE_YES=1

This will automatically answer yes or no to prompts. This is useful for scripting.

MISE_NOT_FOUND_AUTO_INSTALL=true

Set to false to disable the "command not found" handler to autoinstall missing tool versions. Disable this if experiencing strange behavior in your shell when a command is not found—but please submit a ticket to help diagnose problems.

MISE_TASK_OUTPUT=prefix

This controls the output of mise run. It can be one of:

  • prefix - (default if jobs > 1) print by line with the prefix of the task name
  • interleave - (default if jobs == 1) display stdout/stderr as it comes in

MISE_EXPERIMENTAL=1

Enables experimental features. I generally will publish new features under this config which needs to be enabled to use them. While a feature is marked as "experimental" its behavior may change or even disappear in any release.

The idea is experimental features can be iterated on this way so we can get the behavior right, but once that label goes away you shouldn't expect things to change without a proper deprecation—and even then it's unlikely.

Also, I very often will use experimental as a beta flag as well. New functionality that I want to test with a smaller subset of users I will often push out under experimental mode even if it's not related to an experimental feature.

If you'd like to help me out, consider enabling it even if you don't have a particular feature you'd like to try. Also, if something isn't working right, try disabling it if you can.

MISE_ALL_COMPILE=1

Default: false unless running NixOS or Alpine (let me know if others should be added)

Do not use precompiled binaries for all languages. Useful if running on a Linux distribution like Alpine that does not use glibc and therefore likely won't be able to run precompiled binaries.

Note that this needs to be setup for each language. File a ticket if you notice a language that is not working with this config.

MISE_FISH_AUTO_ACTIVATE=1

Configures the vendor_conf.d script for fish shell to automatically activate. This file is automatically used in homebrew and potentially other installs to automatically activate mise without configuring.

Defaults to enabled, set to "0" to disable.