mise(1)

MISE(1)

General Commands Manual

MISE(1)

NAME

mise - Dev tools, env vars, and tasks in one CLI

SYNOPSIS

mise [OPTIONS] [<TASK>] [<TASK_ARGS>] ... [<TASK_ARGS_LAST>] ... [COMMAND]

DESCRIPTION

mise prepares your development environment before each command runs. https://github.com/jdx/mise

OPTIONS

-c, --continue-on-error: Continue running tasks even if one fails
-C, --cd <DIR>: Change directory before running command
-E, --env <ENV>: Set the environment for loading `mise.<ENV>.toml`
-f, --force: Force the operation
-j, --jobs <JOBS>: How many jobs to run in parallel [default: 8]
-n, --dry-run: Dry run, don't actually do anything
-P, --profile <PROFILE>: Set the profile (environment)
-q, --quiet: Suppress non-error messages
-s, --shell <SHELL>
-t, --tool <TOOL@VERSION>: Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10
-v, --verbose: Show extra output (use -vv for even more)
-V, --version
-y, --yes: Answer yes to all confirmation prompts
--debug: Sets log level to debug
--log-level <LEVEL>
--no-config: Do not load any config files
Can also use `MISE_NO_CONFIG=1`
--no-env: Do not load environment variables from config files
Can also use `MISE_NO_ENV=1`
--no-hooks: Do not execute hooks from config files
Can also use `MISE_NO_HOOKS=1`
--no-timings: Hides elapsed time after each task completes
Default to always hide with `MISE_TASK_TIMINGS=0`
--output <OUTPUT>
--raw: Read/write directly to stdin/stdout/stderr instead of by line
--locked: Require lockfile URLs to be present during installation
Fails if tools don't have pre-resolved URLs in the lockfile for the current platform. This prevents API calls to GitHub, aqua registry, etc. Can also be enabled via MISE_LOCKED=1 or settings.locked=true
--silent: Suppress all task output and mise non-error messages
--timings: Shows elapsed time after each task completes
Default to always show with `MISE_TASK_TIMINGS=1`
--trace: Sets log level to trace

ARGUMENTS

<TASK>: Task to run.
Shorthand for `mise tasks run <TASK>`.
<TASK_ARGS>: Task arguments

COMMANDS

activate: Initializes mise in the current shell session
tool-alias: Manage tool version aliases.
tool-alias get: Show an alias for a tool
tool-alias ls: List tool version aliases

Aliases: list

tool-alias set: Add/update an alias for a tool/backend

Aliases: add, create

tool-alias unset: Clears an alias for a tool/backend

Aliases: rm, remove, delete, del

backends: Manage backends
backends ls: List built-in backends

Aliases: list

bin-paths: List all the active runtime bin paths
bootstrap: Set up a machine for the current config in one command
bootstrap dotfiles: Manage dotfiles from `[dotfiles]`
bootstrap dotfiles apply: Apply dotfiles from `[dotfiles]`
bootstrap dotfiles status: Show the status of dotfiles from `[dotfiles]`

Aliases: ls

bootstrap linux: Manage Linux bootstrap config from `[bootstrap.linux]`
bootstrap linux systemd-units: Manage systemd user services from `[bootstrap.linux.systemd.units]`
bootstrap linux systemd-units apply
bootstrap linux systemd-units status
bootstrap macos: Manage macOS bootstrap config from `[bootstrap.macos]`
bootstrap macos defaults: Manage macOS defaults from `[bootstrap.macos.defaults]`
bootstrap macos defaults apply
bootstrap macos defaults status
bootstrap macos launchd-agents: Manage macOS LaunchAgents from `[bootstrap.macos.launchd.agents]`
bootstrap macos launchd-agents apply
bootstrap macos launchd-agents status
bootstrap mise-shell-activate: Manage mise shell activation from `[bootstrap.mise_shell_activate]`
bootstrap mise-shell-activate apply
bootstrap mise-shell-activate status
bootstrap packages: Manage bootstrap system packages from `[bootstrap.packages]`
bootstrap packages apply: Apply system packages from `[bootstrap.packages]`

Aliases: i

bootstrap packages brew: Manage Homebrew taps used by bootstrap packages
bootstrap packages brew tap: Add a Homebrew tap URL to [bootstrap.brew.taps]
bootstrap packages brew untap: Remove Homebrew tap URLs from [bootstrap.brew.taps]

Aliases: remove, rm

bootstrap packages import: Import installed system packages into `[bootstrap.packages]`
bootstrap packages prune: Prune installed system packages no longer declared in `[bootstrap.packages]`
bootstrap packages status: Show the status of system packages from `[bootstrap.packages]`

Aliases: ls

bootstrap packages upgrade: Upgrade installed bootstrap packages from `[bootstrap.packages]`

Aliases: up

bootstrap packages use: Add bootstrap packages to [bootstrap.packages] and install them

Aliases: u

bootstrap repos: Manage git repo checkouts from `[bootstrap.repos]`
bootstrap repos apply
bootstrap repos status
bootstrap status: Show the aggregate bootstrap status

Aliases: ls

bootstrap user: Manage current-user bootstrap settings from `[bootstrap.user]`
bootstrap user apply
bootstrap user status
cache: Manage the mise cache
cache clear: Deletes all cache files in mise

Aliases: c

cache path: Show the cache directory path

Aliases: dir

cache prune: Removes stale mise cache files

Aliases: p

completion: Generate shell completions
config: Manage config files

Aliases: cfg

config get: Display the value of a setting in a mise.toml file
config ls: List config files currently in use

Aliases: list

config set: Set the value of a setting in a mise.toml file
deactivate: Disable mise for current shell session
dotfiles: Manage dotfiles from `[dotfiles]`
dotfiles add: Add or update dotfiles in `[dotfiles]`
dotfiles apply: Apply dotfiles from `[dotfiles]`
dotfiles edit: Edit a managed dotfile source
dotfiles status: Show the status of dotfiles from `[dotfiles]`

Aliases: ls

doctor: Check mise installation for possible problems

Aliases: dr

doctor path: Print the current PATH entries mise is providing
en: Starts a new shell with the mise environment built from the current configuration
env: Exports env vars to activate mise a single time

Aliases: e

exec: Execute a command with tool(s) set

Aliases: x

fmt: Formats mise.toml
generate: Generate files for various tools/services

Aliases: gen

generate bootstrap: Generate a script to download+execute mise
generate config: Generate a mise.toml file
generate devcontainer: Generate a devcontainer to execute mise
generate git-pre-commit: Generate a git pre-commit hook

Aliases: pre-commit

generate github-action: Generate a GitHub Action workflow file
generate task-docs: Generate documentation for tasks in a project
generate task-stubs: Generates shims to run mise tasks
generate tool-stub: Generate a tool stub for HTTP-based tools
implode: Removes mise CLI and all related data
edit: Edit mise.toml interactively
install: Install a tool version

Aliases: i

install-into: Install a tool version to a specific path
latest: Gets the latest available version for a plugin
link: Symlinks a tool version into mise

Aliases: ln

lock: Update lockfile checksums and URLs for all specified platforms
ls: List installed and active tool versions

Aliases: list

ls-remote: List runtime versions available for install.
mcp: Run Model Context Protocol (MCP) server
oci: [experimental] Build OCI container images from a mise.toml
oci build: [experimental] Build an OCI image from the current mise.toml
oci push: [experimental] Build an OCI image and push it to a registry
oci run: [experimental] Build an OCI image from the current mise.toml and run a command in it
outdated: Shows outdated tool versions
patrons: Show the individuals supporting mise as Patron-tier members
plugins: Manage plugins

Aliases: p

plugins install: Install a plugin

Aliases: i, a, add

plugins link: Symlinks a plugin into mise

Aliases: ln

plugins ls: List installed plugins

Aliases: list

plugins ls-remote

Aliases: list-remote, list-all

plugins uninstall: Removes a plugin

Aliases: remove, rm

plugins update: Updates a plugin to the latest version

Aliases: up, upgrade

deps: [experimental] Manage project dependencies

Aliases: dep

deps add: Add a dependency
deps install: Install all project dependencies
deps remove: Remove a dependency
prune: Delete unused versions of tools
registry: List available tools to install
reshim: Creates new shims based on bin paths from currently installed tools.
run: Run task(s)

Aliases: r

search: Search for tools in the registry
self-update: Updates mise itself.
set: Set environment variables in mise.toml
settings: Show current settings
settings add: Adds a setting to the configuration file
settings get: Show a current setting
settings ls: Show current settings

Aliases: list

settings set: Add/update a setting

Aliases: create

settings unset: Clears a setting

Aliases: rm, remove, delete, del

shell: Sets a tool version for the current session.

Aliases: sh

shell-alias: Manage shell aliases.
shell-alias get: Show the command for a shell alias
shell-alias ls: List shell aliases

Aliases: list

shell-alias set: Add/update a shell alias

Aliases: add, create

shell-alias unset: Removes a shell alias

Aliases: rm, remove, delete, del

sponsors: Show the companies sponsoring mise and the jdx.dev open source tools
sync: Synchronize tools from other version managers with mise
sync node: Symlinks all tool versions from an external tool into mise
sync python: Symlinks all tool versions from an external tool into mise
sync ruby: Symlinks all ruby tool versions from an external tool into mise
tasks: Manage tasks

Aliases: t

tasks add: Create a new task
tasks deps: Display a tree visualization of a dependency graph
tasks edit: Edit a task with $EDITOR
tasks info: Get information about a task
tasks ls: List available tasks to execute
tasks run: Run task(s)

Aliases: r

tasks validate: Validate tasks for common errors and issues
test-tool: Test a tool installs and executes
token: Display git provider tokens mise will use
token forgejo: Forgejo token
token github: GitHub token
token gitlab: GitLab token
tool: Gets information about a tool
tool-stub: Execute a tool stub
trust: Marks a config file as trusted
uninstall: Removes installed tool versions
unset: Remove environment variable(s) from the config file.
untrust: No longer trust a config, will prompt in the future
unuse: Removes installed tool versions from mise.toml

Aliases: rm, remove

upgrade: Upgrades outdated tools

Aliases: up

use: Installs a tool and adds the version to mise.toml.

Aliases: u

version: Display the version of mise

Aliases: v

watch: Run task(s) and watch for changes to rerun it

Aliases: w

where: Display the installation path for a tool
which: Shows the path that a tool's bin points to.

MISE ACTIVATE

Initializes mise in the current shell session

This should go into your shell's rc file or login shell. Otherwise, it will only take effect in the current session. (e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish, or $PROFILE for powershell)

Typically, this can be added with something like the following:

echo 'eval "$(mise activate zsh)"' >> ~/.zshrc

However, this requires that "mise" is in your PATH. If it is not, you need to specify the full path like this:

echo 'eval "$(/path/to/mise activate zsh)"' >> ~/.zshrc

Customize status output with `status` settings.

Usage: mise activate [OPTIONS] [<SHELL_TYPE>]

Options:

-q, --quiet

Suppress non-error messages

-s, --shell <SHELL>

Shell type to generate the script for

--no-hook-env

Do not automatically call hook-env

This can be helpful for debugging mise. If you run `eval "$(mise activate --no-hook-env)"`, then you can call `mise hook-env` manually which will output the env vars to stdout without actually modifying the environment. That way you can do things like `mise hook-env --trace` to get more information or just see the values that hook-env is outputting.

--shims

Use shims instead of modifying PATH Effectively the same as:

PATH="$HOME/.local/share/mise/shims:$PATH"

`mise activate --shims` does not support all the features of `mise activate`. See https://mise.en.dev/dev-tools/shims.html#shims-vs-path for more information

--status

Show "mise: <TOOL>@<VERSION>" message when changing directories Arguments:

<SHELL_TYPE>

Shell type to generate the script for

MISE TOOL-ALIAS

Manage tool version aliases.

Usage: mise tool-alias [OPTIONS] [COMMAND]

Options:

-p, --tool <TOOL>: Filter aliases by tool
--no-header: Don't show table header

MISE TOOL-ALIAS GET

Show an alias for a tool

This is the contents of a tool_alias.<TOOL> entry in ~/.config/mise/config.toml

Usage: mise tool-alias get <TOOL> <ALIAS>

Arguments:

<TOOL>: The tool to show the alias for
<ALIAS>: The alias to show

MISE TOOL-ALIAS LS

List tool version aliases Shows the aliases that can be specified. These can come from user config or from plugins in `bin/list-aliases`.

For user config, aliases are defined like the following in `~/.config/mise/config.toml`:

[tool_alias.node.versions]
lts = "22.0.0"

Usage: mise tool-alias ls [OPTIONS] [<TOOL>]

Options:

--no-header: Don't show table header Arguments:
<TOOL>: Show aliases for <TOOL>

MISE TOOL-ALIAS SET

Add/update an alias for a tool/backend

This modifies the contents of ~/.config/mise/config.toml

Usage: mise tool-alias set <TOOL> <ALIAS> [<VALUE>]

Arguments:

<TOOL>: The tool/backend to set the alias for
<ALIAS>: The alias to set
<VALUE>: The value to set the alias to

MISE TOOL-ALIAS UNSET

Clears an alias for a tool/backend

This modifies the contents of ~/.config/mise/config.toml

Usage: mise tool-alias unset <TOOL> [<ALIAS>]

Arguments:

<TOOL>: The tool/backend to remove the alias from
<ALIAS>: The alias to remove

MISE BIN-PATHS

List all the active runtime bin paths

Usage: mise bin-paths [OPTIONS] [<TOOL@VERSION>] ...

Options:

--bin-names: Output executable names instead of bin directories
-J, --json: Output executable entries in JSON format (implies --bin-names) Arguments:
<TOOL@VERSION>: Tool(s) to look up e.g.: ruby@3

MISE BOOTSTRAP

Set up a machine for the current config in one command

Runs the bootstrap steps for the current config in order:

0. `[bootstrap.hooks.pre-packages]` — optional setup hook 1. `mise bootstrap packages apply` — install missing
`[bootstrap.packages]`
then `[bootstrap.hooks.post-packages]` 2. `mise bootstrap repos apply` — clone/update `[bootstrap.repos]`
surrounded by `pre-repos`/`post-repos` hooks 3. `mise bootstrap dotfiles apply` — apply dotfiles from `[dotfiles]`
surrounded by `pre-dotfiles`/`post-dotfiles` hooks 4. `mise bootstrap mise-shell-activate apply` — configure shell activation
from `[bootstrap.mise_shell_activate]` 5. `mise bootstrap macos defaults apply` — write
`[bootstrap.macos.defaults]` entries (macOS)
surrounded by `pre-defaults`/`post-defaults` hooks 6. `mise bootstrap macos launchd-agents apply` — install/load
`[bootstrap.macos.launchd.agents]` 7. `mise bootstrap linux systemd-units apply` — install/start
`[bootstrap.linux.systemd.units]` 8. `mise bootstrap user apply` — set `[bootstrap.user].login_shell`
(Unix)
surrounded by `pre-user`/`post-user` hooks 9. `mise install` — install missing tools from `[tools]`
surrounded by `pre-tools`/`post-tools` hooks 10. `mise run bootstrap` — if a task named `bootstrap` is defined 11. `[bootstrap.hooks.final]` — optional final hook

The declarative steps converge — anything already in its desired state is skipped, so re-running is safe. The `bootstrap` task runs on every invocation; keep it idempotent. Use it for any project-specific setup that doesn't fit the declarative sections (seeding databases, auth flows, etc.) — it runs with the installed tools on PATH.

Use `--skip <part>` to skip named parts, or `--only <part>` to run just named parts. Both flags can be repeated or comma-separated, but they cannot be used together.

Usage: mise bootstrap [OPTIONS] [COMMAND]

Options:

-n, --dry-run: Print what would happen without installing anything
-y, --yes: Skip confirmation prompts
--force-dotfiles: Overwrite existing files that conflict with whole-file dotfile entries
--only <ONLY>: Run only one or more bootstrap parts
Can be passed multiple times or as a comma-separated list. Cannot be used with `--skip`.
--skip <SKIP>: Skip one or more bootstrap parts
Can be passed multiple times or as a comma-separated list.
--update: Refresh system package manager metadata first (apk: `--update-cache`, apt: `apt-get update`)

MISE BOOTSTRAP DOTFILES APPLY

Apply dotfiles from `[dotfiles]`

Applies configured whole-file entries and edits that aren't in their desired state. Whole-file entries may symlink, copy, or render templates. Edit entries manage a marker-delimited block or a single line in a file mise doesn't otherwise own.

Usage: mise bootstrap dotfiles apply [OPTIONS] [<TARGET>] ...

Options:

-f, --force: Overwrite existing files that conflict with whole-file dotfile entries
-n, --dry-run: Print the actions that would run without writing anything
-y, --yes: Skip the confirmation prompt Arguments:
<TARGET>: Only apply these targets

MISE BOOTSTRAP DOTFILES STATUS

Show the status of dotfiles from `[dotfiles]`

Usage: mise bootstrap dotfiles status [OPTIONS] [<TARGET>] ...

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured dotfiles are not in their desired state (missing, source missing, differs) Arguments:
<TARGET>: Only show these targets

MISE BOOTSTRAP LINUX SYSTEMD-UNITS APPLY

Usage: mise bootstrap linux systemd-units apply [OPTIONS]

Options:

-n, --dry-run: Print the commands that would run without running them
-y, --yes: Skip the confirmation prompt

MISE BOOTSTRAP LINUX SYSTEMD-UNITS STATUS

Usage: mise bootstrap linux systemd-units status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured systemd user service is not in its desired state

MISE BOOTSTRAP MACOS DEFAULTS APPLY

Usage: mise bootstrap macos defaults apply [OPTIONS]

Options:

-n, --dry-run: Print the commands that would run without running them
-y, --yes: Skip the confirmation prompt

MISE BOOTSTRAP MACOS DEFAULTS STATUS

Usage: mise bootstrap macos defaults status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured defaults are not in their desired state

MISE BOOTSTRAP MACOS LAUNCHD-AGENTS APPLY

Usage: mise bootstrap macos launchd-agents apply [OPTIONS]

Options:

-n, --dry-run: Print the commands that would run without running them
-y, --yes: Skip the confirmation prompt

MISE BOOTSTRAP MACOS LAUNCHD-AGENTS STATUS

Usage: mise bootstrap macos launchd-agents status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured LaunchAgent is not in its desired state

MISE BOOTSTRAP MISE-SHELL-ACTIVATE APPLY

Usage: mise bootstrap mise-shell-activate apply [OPTIONS]

Options:

-n, --dry-run: Print the actions that would run without writing anything
-y, --yes: Skip the confirmation prompt

MISE BOOTSTRAP MISE-SHELL-ACTIVATE STATUS

Usage: mise bootstrap mise-shell-activate status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured shell activation is not in its desired state

MISE BOOTSTRAP PACKAGES APPLY

Apply system packages from `[bootstrap.packages]`

Checks which configured packages are missing and installs them with the system package manager. This may elevate with sudo when not running as root (see the `system_packages.sudo` setting).

Packages can also be given explicitly in `manager:package` form (e.g. `apk:zlib-dev`, `apt:curl`, `brew:jq`); they are installed whether or not they appear in the config. Explicit packages and `--manager` scope the run to packages only. `install` is accepted as an alias for this command.

Usage: mise bootstrap packages apply [OPTIONS] [<PACKAGE>] ...

Options:

-m, --manager <MANAGER>: Only install packages for this manager, e.g. `apk`, `apt`, `brew`, `brew-cask`, `flatpak`, or `mas`
-n, --dry-run: Print the commands that would run without running them
-y, --yes: Skip the confirmation prompt
--update: Refresh package manager metadata first (apk: `--update-cache`, apt: `apt-get update`) Arguments:
<PACKAGE>: Packages in `manager:package` form; defaults to everything configured in [bootstrap.packages]

MISE BOOTSTRAP PACKAGES BREW TAP

Add a Homebrew tap URL to [bootstrap.brew.taps]

Usage: mise bootstrap packages brew tap [OPTIONS] <TAP> [<URL>]

Options:

-l, --local: Write to the local config instead of the global config
-n, --dry-run: Print the config change without writing it
-p, --path <PATH>: Write to this config file or directory Arguments:
<TAP>: Tap name, e.g. `owner/repo`
<URL>: GitHub URL for the tap. Defaults to https://github.com/<owner>/homebrew-<repo>.git

MISE BOOTSTRAP PACKAGES BREW UNTAP

Remove Homebrew tap URLs from [bootstrap.brew.taps]

Usage: mise bootstrap packages brew untap [OPTIONS] <TAPS> ...

Options:

-l, --local: Write to the local config instead of the global config
-n, --dry-run: Print the config change without writing it
-p, --path <PATH>: Write to this config file or directory Arguments:
<TAPS>: Tap name(s), e.g. `owner/repo`

MISE BOOTSTRAP PACKAGES IMPORT

Import installed system packages into `[bootstrap.packages]`

Currently supports Homebrew formulae only. By default, imports linked formulae whose active keg receipt says they were installed on request. Pass `--all` to import every linked formula, including dependencies.

Usage: mise bootstrap packages import [OPTIONS]

Options:

-e, --env <ENV>: Write to the config file for this environment (mise.<ENV>.toml)
-g, --global: Write to the global config (~/.config/mise/config.toml)
-m, --manager <MANAGER>: Only import packages for this manager. Currently only `brew` is supported

Default: brew

--all: Import every linked formula, including dependencies
-n, --dry-run: Print the config change without writing config
-p, --path <PATH>: Write to this config file or directory

MISE BOOTSTRAP PACKAGES PRUNE

Prune installed system packages no longer declared in `[bootstrap.packages]`

Currently supports Homebrew formulae only. Pruning removes linked formulae that are not needed by the current config or by trusted, loadable tracked configs.

Usage: mise bootstrap packages prune [OPTIONS]

Options:

-m, --manager <MANAGER>: Only prune packages for this manager. Currently only `brew` is supported

Default: brew

-n, --dry-run: Print what would be removed without deleting anything
-y, --yes: Skip the confirmation prompt

MISE BOOTSTRAP PACKAGES STATUS

Show the status of system packages from `[bootstrap.packages]`

Usage: mise bootstrap packages status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured packages are not in their desired state

MISE BOOTSTRAP PACKAGES UPGRADE

Upgrade installed bootstrap packages from `[bootstrap.packages]`

Refreshes package manager metadata and upgrades the configured packages that are already installed: apk/apt/dnf/pacman upgrade to the newest available version (apk, apt, and dnf honor a version pinned in config), brew pours the formula's current bottle and replaces the old keg, brew-cask installs the current cask artifact, flatpak updates applications and runtimes, and mas upgrades App Store apps. Packages that are not installed yet are skipped — use `mise bootstrap packages apply` for those.

Packages can also be given explicitly in `manager:package` form.

Usage: mise bootstrap packages upgrade [OPTIONS] [<PACKAGE>] ...

Options:

-m, --manager <MANAGER>: Only upgrade packages for this manager, e.g. `apk`, `apt`, `brew`, `brew-cask`, `flatpak`, or `mas`
-n, --dry-run: Print the commands that would run without running them
-y, --yes: Skip the confirmation prompt Arguments:
<PACKAGE>: Packages in `manager:package` form; defaults to everything configured in [bootstrap.packages]

MISE BOOTSTRAP PACKAGES USE

Add bootstrap packages to [bootstrap.packages] and install them

Like `mise use` for tools: writes `"manager:package" = "version"` entries to mise.toml (the local config by default, the global one with `-g`) and then installs whatever is missing.

Versions are pinned with `@`: `mise bootstrap packages use apt:curl@8.5.0-2`. Without `@` (or with `@latest`) no pin is written. brew formulae and casks version through their names instead (for example `brew:postgresql@17`, `brew-cask:temurin@17`), where `@` is part of the Homebrew name rather than a mise version selector. mas uses numeric ADAM IDs and does not support pins.

Usage: mise bootstrap packages use [OPTIONS] <PACKAGE> ...

Options:

-e, --env <ENV>: Write to the config file for this environment (mise.<ENV>.toml)
-g, --global: Write to the global config (~/.config/mise/config.toml) instead of the local one
-n, --dry-run: Print the commands that would run without writing config or installing
-p, --path <PATH>: Write to this config file or directory
-y, --yes: Skip the confirmation prompt Arguments:
<PACKAGE>: Packages in `manager:package[@version]` form

MISE BOOTSTRAP REPOS APPLY

Usage: mise bootstrap repos apply [OPTIONS]

Options:

-n, --dry-run: Print the commands that would run without running them
-y, --yes: Skip the confirmation prompt

MISE BOOTSTRAP REPOS STATUS

Usage: mise bootstrap repos status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured repo is not in its desired state

MISE BOOTSTRAP STATUS

Show the aggregate bootstrap status

Usage: mise bootstrap status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured bootstrap state is not in its desired state

MISE BOOTSTRAP USER APPLY

Usage: mise bootstrap user apply [OPTIONS]

Options:

-n, --dry-run: Print the commands that would run without running them
-y, --yes: Skip the confirmation prompt

MISE BOOTSTRAP USER STATUS

Usage: mise bootstrap user status [OPTIONS]

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured user setting is not in its desired state

MISE CACHE CLEAR

Deletes all cache files in mise

Usage: mise cache clear [OPTIONS] [<TOOL>] ...

Options:

--outdate: Mark all cache files as old Arguments:
<TOOL>: Tool(s) to clear cache for e.g.: node, python

MISE CACHE PRUNE

Removes stale mise cache files

By default, this command will remove files that have not been accessed in 30 days. Change this with the MISE_CACHE_PRUNE_AGE environment variable.

Usage: mise cache prune [OPTIONS] [<TOOL>] ...

Options:

-v, --verbose: Show pruned files
--dry-run: Just show what would be pruned Arguments:
<TOOL>: Tool(s) to prune cache for e.g.: node, python

MISE COMPLETION

Generate shell completions

Usage: mise completion [OPTIONS] [<SHELL>]

Options:

-s, --shell <SHELL_TYPE>: Shell type to generate completions for
--include-bash-completion-lib: Include the bash completion library in the bash completion script
This is required for completions to work in bash, but it is not included by default you may source it separately or enable this flag to enable it in the script.
--usage: Always use usage for completions. Currently, usage is the default for fish and bash but not zsh since it has a few quirks to work out first.
This requires the `usage` CLI to be installed. https://usage.jdx.dev Arguments:
<SHELL>: Shell type to generate completions for

MISE CONFIG

Manage config files

Usage: mise config [OPTIONS] [COMMAND]

Options:

-J, --json: Output in JSON format
--no-header: Do not print table header
--tracked-configs: List all tracked config files

MISE CONFIG GET

Display the value of a setting in a mise.toml file

Usage: mise config get [OPTIONS] [<KEY>]

Options:

-f, --file <FILE>: The path to the mise.toml file to edit
If not provided, the nearest mise.toml file will be used Arguments:
<KEY>: The path of the config to display

MISE CONFIG LS

List config files currently in use

Usage: mise config ls [OPTIONS]

Options:

-J, --json: Output in JSON format
--no-header: Do not print table header
--tracked-configs: List all tracked config files

MISE CONFIG SET

Set the value of a setting in a mise.toml file

Usage: mise config set [OPTIONS] <KEY> [<VALUE>]

Options:

-f, --file <FILE>: The path to the mise.toml file to edit
If not provided, the nearest mise.toml file will be used
-t, --type <TYPE>

Default: infer

Arguments:

<KEY>: The path of the config to display
<VALUE>: The value to set the key to (optional if provided as KEY=VALUE)

MISE DOTFILES ADD

Add or update dotfiles in `[dotfiles]`

If the target is already managed, this updates its source from the live target. Otherwise it creates a `[dotfiles]` entry and seeds the source under `dotfiles.root` unless `--source` is provided.

Usage: mise dotfiles add [OPTIONS] <TARGET> ...

Options:

-f, --force: Overwrite existing sources without prompting
-g, --global: Write to the global config
-l, --local: Write to the local config instead of the global config
-m, --mode <MODE>: Dotfile mode to write
-n, --dry-run: Print the config/source updates without writing anything
-p, --path <PATH>: Write to this config file or directory
-s, --source <PATH>: Source path to use for a single target
-y, --yes: Skip the confirmation prompt Arguments:
<TARGET>: Targets to add or update

MISE DOTFILES APPLY

Apply dotfiles from `[dotfiles]`

Usage: mise dotfiles apply [OPTIONS] [<TARGET>] ...

Options:

-f, --force: Overwrite existing files that conflict with whole-file dotfile entries
-n, --dry-run: Print the actions that would run without writing anything
-y, --yes: Skip the confirmation prompt Arguments:
<TARGET>: Only apply these targets

MISE DOTFILES EDIT

Edit a managed dotfile source

Usage: mise dotfiles edit [OPTIONS] <TARGET>

Options:

--apply: Apply this target after the editor exits
-m, --mode <MODE>: Dotfile mode to use if the target is not yet managed
-s, --source <PATH>: Source path to use if the target is not yet managed
-y, --yes: Skip the confirmation prompt when adding an unmanaged target Arguments:
<TARGET>: Target to edit

MISE DOTFILES STATUS

Show the status of dotfiles from `[dotfiles]`

Usage: mise dotfiles status [OPTIONS] [<TARGET>] ...

Options:

-J, --json: Output in JSON format
--missing: Exit with code 1 if any configured dotfiles are not in their desired state (missing, source missing, differs) Arguments:
<TARGET>: Only show these targets

MISE DOCTOR

Check mise installation for possible problems

Usage: mise doctor [OPTIONS] [COMMAND]

Options:

-J, --json

MISE DOCTOR PATH

Print the current PATH entries mise is providing

Usage: mise doctor path [OPTIONS]

Options:

-f, --full: Print all entries including those not provided by mise

MISE EN

Starts a new shell with the mise environment built from the current configuration

This is an alternative to `mise activate` that allows you to explicitly start a mise session. It will have the tools and environment variables in the configs loaded. Note that changing directories will not update the mise environment.

Usage: mise en [OPTIONS] [<DIR>]

Options:

-s, --shell <SHELL>: Shell to start
Defaults to $SHELL Arguments:
<DIR>: Directory to start the shell in

Default: .

MISE ENV

Exports env vars to activate mise a single time

Use this if you don't want to permanently install mise. It's not necessary to use this if you have `mise activate` in your shell rc file.

Usage: mise env [OPTIONS] [<TOOL@VERSION>] ...

Options:

-D, --dotenv: Output in dotenv format
-J, --json: Output in JSON format
-s, --shell <SHELL>: Shell type to generate environment variables for
--json-extended: Output in JSON format with additional information (source, tool)
--redacted: Only show redacted environment variables
--values: Only show values of environment variables Arguments:
<TOOL@VERSION>: Tool(s) to use

MISE EXEC

Execute a command with tool(s) set

use this to avoid modifying the shell session or running ad-hoc commands with mise tools set.

Tools will be loaded from mise.toml, though they can be overridden with <RUNTIME> args Note that only the plugin specified will be overridden, so if a `mise.toml` file includes "node 20" but you run `mise exec python@3.11`; it will still load node@20.

The "--" separates runtimes from the commands to pass along to the subprocess.

Usage: mise exec [OPTIONS] [<TOOL@VERSION>] ... [<COMMAND>] ...

Options:

-c, --command <C>: Command string to execute
-j, --jobs <JOBS>: Number of jobs to run in parallel [default: 4]
--allow-env <VAR>: Allow specific env var through (implies --deny-env for everything else) Supports wildcards, e.g. --allow-env='MYAPP_*'
--allow-net <HOST>: Allow network to specific host (implies --deny-net for everything else) macOS only in v1; on Linux falls back to allowing all network
--allow-read <PATH>: Allow reads from specific path (implies --deny-read for everything else)
--allow-write <PATH>: Allow writes to specific path (implies --deny-write for everything else)
--deny-all: Block reads, writes, network, and env vars
--deny-env: Block env var inheritance (only PATH, HOME, USER, SHELL, TERM, LANG pass through)
--deny-net: Block all network access
--deny-read: Block filesystem reads (system libs and tool dirs still accessible)
--deny-write: Block all filesystem writes
--fresh-env: Bypass the environment cache and recompute the environment
--no-deps: Skip automatic dependency preparation
--raw: Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1 Arguments:
<TOOL@VERSION>: Tool(s) to start e.g.: node@20 python@3.10
<COMMAND>: Command string to execute (same as --command)

MISE FMT

Formats mise.toml

Sorts keys and cleans up whitespace in mise.toml

Usage: mise fmt [OPTIONS]

Options:

-a, --all: Format all files from the current directory
-c, --check: Check if the configs are formatted, no formatting is done
-s, --stdin: Read config from stdin and write its formatted version into stdout

MISE GENERATE BOOTSTRAP

Generate a script to download+execute mise

This is designed to be used in a project where contributors may not have mise installed.

Usage: mise generate bootstrap [OPTIONS]

Options:

-l, --localize: Sandboxes mise internal directories like MISE_DATA_DIR and MISE_CACHE_DIR into a `.mise` directory in the project
This is necessary if users may use a different version of mise outside the project.
-V, --version <VERSION>: Specify mise version to fetch
-w, --write <WRITE>: instead of outputting the script to stdout, write to a file and make it executable
--localized-dir <LOCALIZED_DIR>: Directory to put localized data into

Default: .mise

MISE GENERATE CONFIG

Generate a mise.toml file

Usage: mise generate config [OPTIONS] [<PATH>]

Options:

-g, --global: Generate the global config file (~/.config/mise/config.toml)
-n, --dry-run: Show what would be generated without writing to file
-t, --tool-versions <TOOL_VERSIONS>: Path to a .tool-versions file to import tools from Arguments:
<PATH>: Path to the config file to create

MISE GENERATE DEVCONTAINER

Generate a devcontainer to execute mise

Usage: mise generate devcontainer [OPTIONS]

Options:

-i, --image <IMAGE>: The image to use for the devcontainer
-m, --mount-mise-data: Bind the mise-data-volume to the devcontainer
-n, --name <NAME>: The name of the devcontainer
-w, --write: write to .devcontainer/devcontainer.json

MISE GENERATE GIT-PRE-COMMIT

Generate a git pre-commit hook

This command generates a git pre-commit hook that runs a mise task like `mise run pre-commit` when you commit changes to your repository.

Staged files are passed to the task as `STAGED`.

For more advanced pre-commit functionality, see mise's sister project: https://hk.jdx.dev/

Usage: mise generate git-pre-commit [OPTIONS]

Options:

-t, --task <TASK>: The task to run when the pre-commit hook is triggered

Default: pre-commit

-w, --write: write to .git/hooks/pre-commit and make it executable
--hook <HOOK>: Which hook to generate (saves to .git/hooks/$hook)

Default: pre-commit

MISE GENERATE GITHUB-ACTION

Generate a GitHub Action workflow file

This command generates a GitHub Action workflow file that runs a mise task like `mise run ci` when you push changes to your repository.

Usage: mise generate github-action [OPTIONS]

Options:

-t, --task <TASK>: The task to run when the workflow is triggered

Default: ci

-w, --write: write to .github/workflows/$name.yml
--name <NAME>: the name of the workflow to generate

Default: ci

MISE GENERATE TASK-DOCS

Generate documentation for tasks in a project

Usage: mise generate task-docs [OPTIONS]

Options:

-i, --inject: inserts the documentation into an existing file
This will look for a special comment, ``, and replace it with the generated documentation. It will replace everything between the comment and the next comment, `` so it can be run multiple times on the same file to update the documentation.
-I, --index: write only an index of tasks, intended for use with `--multi`
-m, --multi: render each task as a separate document, requires `--output` to be a directory
-o, --output <OUTPUT>: writes the generated docs to a file/directory
-r, --root <ROOT>: root directory to search for tasks
-s, --style <STYLE>

Default: simple

MISE GENERATE TASK-STUBS

Generates shims to run mise tasks

By default, this will build shims like ./bin/<task>. These can be paired with `mise generate bootstrap` so contributors to a project can execute mise tasks without installing mise into their system.

Usage: mise generate task-stubs [OPTIONS]

Options:

-d, --dir <DIR>: Directory to create task stubs inside of

Default: bin

-m, --mise-bin <MISE_BIN>: Path to a mise bin to use when running the task stub.
Use `--mise-bin=./bin/mise` to use a mise bin generated from `mise generate bootstrap`

Default: mise

MISE GENERATE TOOL-STUB

Generate a tool stub for HTTP-based tools

This command generates tool stubs that can automatically download and execute tools from HTTP URLs. It can detect checksums, file sizes, and binary paths automatically by downloading and analyzing the tool.

When generating stubs with platform-specific URLs, the command will append new platforms to existing stub files rather than overwriting them. This allows you to incrementally build cross-platform tool stubs.

Usage: mise generate tool-stub [OPTIONS] <OUTPUT>

Options:

-b, --bin <BIN>: Binary path within the extracted archive
If not specified and the archive is downloaded, will auto-detect the most likely binary
--bootstrap: Wrap stub in a bootstrap script that installs mise if not already present
When enabled, generates a bash script that: 1. Checks if mise is installed at the expected path 2. If not, downloads and installs mise using the embedded installer 3. Executes the tool stub using mise
--bootstrap-version <BOOTSTRAP_VERSION>: Specify mise version for the bootstrap script
By default, uses the latest version from the install script. Use this to pin to a specific version (e.g., "2025.1.0").
--fetch: Fetch checksums and sizes for an existing tool stub file
This reads an existing stub file and fills in any missing checksum/size fields by downloading the files. URLs must already be present in the stub.
--http <HTTP>: HTTP backend type to use

Default: http

--lock

Resolve and embed lockfile data (exact version + platform URLs/checksums) into an existing stub file for reproducible installs without runtime API calls

--platform-bin <PLATFORM_BIN>

Platform-specific binary paths in the format platform:path

Examples: --platform-bin windows-x64:tool.exe --platform-bin linux-x64:bin/tool

--platform-url <PLATFORM_URL>

Platform-specific URLs in the format platform:url or just url (auto-detect platform)

When the output file already exists, new platforms will be appended to the existing platforms table. Existing platform URLs will be updated if specified again.

If only a URL is provided (without platform:), the platform will be automatically detected from the URL filename.

Examples: --platform-url linux-x64:https://... --platform-url https://nodejs.org/dist/v22.17.1/node-v22.17.1-darwin-arm64.tar.gz

--skip-download

Skip downloading for checksum and binary path detection (faster but less informative)

-u, --url <URL>

URL for downloading the tool

Example: https://github.com/owner/repo/releases/download/v2.0.0/tool-linux-x64.tar.gz

--version <VERSION>

Version of the tool

Default: latest

Arguments:

<OUTPUT>: Output file path for the tool stub

MISE IMPLODE

Removes mise CLI and all related data

Skips config directory by default.

Usage: mise implode [OPTIONS]

Options:

-n, --dry-run: List directories that would be removed without actually removing them
--config: Also remove config directory

MISE EDIT

Edit mise.toml interactively

Usage: mise edit [OPTIONS] [<PATH>]

Options:

-g, --global: Edit the global config file (~/.config/mise/config.toml)
-n, --dry-run: Show what would be generated without writing to file
-t, --tool-versions <TOOL_VERSIONS>: Path to a .tool-versions file to import tools from Arguments:
<PATH>: Path to the config file to create

MISE INSTALL

Install a tool version

Installs a tool version to `~/.local/share/mise/installs/<TOOL>/<VERSION>` Installing alone will not activate the tools so they won't be in PATH. To install and/or activate in one command, use `mise use` which will create a `mise.toml` file in the current directory to activate this tool when inside the directory. Alternatively, run `mise exec <TOOL>@<VERSION> -- <COMMAND>` to execute a tool without creating config files.

Tools will be installed in parallel. To disable, set `--jobs=1` or `MISE_JOBS=1`

Usage: mise install [OPTIONS] [<TOOL@VERSION>] ...

Options:

-f, --force: Force reinstall even if already installed
-j, --jobs <JOBS>: Number of jobs to run in parallel [default: 4]
-n, --dry-run: Show what would be installed without actually installing
-v, --verbose: Show installation output
This argument will print backend output such as download, configuration, and compilation output.
--dry-run-code: Like --dry-run but exits with code 1 if there are tools to install
This is useful for scripts to check if tools need to be installed.
--minimum-release-age <MINIMUM_RELEASE_AGE>: Only install versions released before this date or older than this duration
Supports absolute dates like "2024-06-01" and relative durations like "90d" or "1y".
--monorepo: Install tools from every [monorepo].config_roots config root
Uses the active MISE_ENV and requires monorepo_root = true plus explicit [monorepo].config_roots in the monorepo root config.
--raw: Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1
--shared <SHARED>: Install tool(s) to a shared directory
Installs to the specified directory instead of the default install location. May require elevated permissions depending on the path.
--system: Install tool(s) to the system-wide shared directory
Installs to /usr/local/share/mise/installs (or MISE_SYSTEM_DATA_DIR/installs). May require elevated permissions (e.g. sudo). Arguments:
<TOOL@VERSION>: Tool(s) to install e.g.: node@20

MISE INSTALL-INTO

Install a tool version to a specific path

Used for building a tool to a directory for use outside of mise

Usage: mise install-into <TOOL@VERSION> <PATH>

Arguments:

<TOOL@VERSION>: Tool to install e.g.: node@20
<PATH>: Path to install the tool into

MISE LATEST

Gets the latest available version for a plugin

Supports prefixes such as `node@20` to get the latest version of node 20.

Usage: mise latest [OPTIONS] <TOOL@VERSION> [<ASDF_VERSION>]

Options:

-i, --installed: Show latest installed instead of available version
--minimum-release-age <MINIMUM_RELEASE_AGE>: Only consider versions released before this date or older than this duration
Supports absolute dates like "2024-06-01" and relative durations like "90d" or "1y". Overrides per-tool `minimum_release_age` options and the global `minimum_release_age` setting. Arguments:
<TOOL@VERSION>: Tool to get the latest version of
<ASDF_VERSION>: The version prefix to use when querying the latest version same as the first argument after the "@" used for asdf compatibility

MISE LINK

Symlinks a tool version into mise

Use this for adding installs either custom compiled outside mise or built with a different tool.

Usage: mise link [OPTIONS] <TOOL@VERSION> <PATH>

Options:

-f, --force: Overwrite an existing tool version if it exists Arguments:
<TOOL@VERSION>: Tool name and version to create a symlink for
<PATH>: The local path to the tool version e.g.: ~/.nvm/versions/node/v20.0.0

MISE LOCK

Update lockfile checksums and URLs for all specified platforms

Updates checksums and download URLs for all platforms already specified in the lockfile. If no lockfile exists, shows what would be created based on the current configuration. This allows you to refresh lockfile data for platforms other than the one you're currently on. Operates on the lockfile in the current config root. Use TOOL arguments to target specific tools.

Usage: mise lock [OPTIONS] [<TOOL>] ...

Options:

-g, --global: Target only global config lockfiles (~/.config/mise/mise.lock and system config) By default, only the active project config root is locked
-j, --jobs <JOBS>: Number of jobs to run in parallel
-n, --dry-run: Show what would be updated without making changes
-p, --platform <PLATFORM>: Comma-separated list of platforms to target e.g.: linux-x64,macos-arm64,windows-x64 If not specified, all platforms already in lockfile will be updated
--local: Update mise.local.lock instead of mise.lock Use for tools defined in .local.toml configs
--minimum-release-age <MINIMUM_RELEASE_AGE>: Only lock versions released before this age or date
Supports absolute dates like "2024-06-01" and relative durations like "90d" or "1y". This only affects fuzzy version matches like "20" or "latest". Explicitly pinned versions like "22.5.0" are not filtered. Existing matching lockfile entries are preserved and are not downgraded solely by this flag. Arguments:
<TOOL>: Tool(s) to update in lockfile e.g.: node python If not specified, all tools in lockfile will be updated

MISE LS

List installed and active tool versions

This command lists tools that mise "knows about". These may be tools that are currently installed, or those that are in a config file (active) but may or may not be installed.

It's a useful command to get the current state of your tools.

Usage: mise ls [OPTIONS] [<INSTALLED_TOOL>] ...

Options:

-c, --current: Only show tool versions currently specified in a mise.toml
-g, --global: Only show tool versions currently specified in the global mise.toml
-i, --installed: Only show tool versions that are installed (Hides tools defined in mise.toml but not installed)
-J, --json: Output in JSON format
-l, --local: Only show tool versions currently specified in the local mise.toml
-m, --missing: Display missing tool versions
-o, --offline: Don't fetch information such as outdated versions
-p, --plugin <TOOL_FLAG>
--all-sources: Display all tracked config sources for tools
--monorepo: List tools from every [monorepo].config_roots config root
Uses the active MISE_ENV and requires monorepo_root = true plus explicit [monorepo].config_roots in the monorepo root config.
--no-header: Don't display headers
--outdated: Display whether a version is outdated
--prefix <PREFIX>: Display versions matching this prefix
--prunable: List only tools that can be pruned with `mise prune` Arguments:
<INSTALLED_TOOL>: Only show tool versions from [TOOL]

MISE LS-REMOTE

List runtime versions available for install.

Note that the results may be cached, run `mise cache clean` to clear the cache and get fresh results.

Usage: mise ls-remote [OPTIONS] [<TOOL@VERSION>] [<PREFIX>]

Options:

--all

Show all installed plugins and versions

--minimum-release-age <MINIMUM_RELEASE_AGE>

Only show versions released before this age or date

Supports absolute dates like "2024-06-01" and relative durations like "90d" or "1y".

-J, --json

Output in JSON format (includes version metadata like created_at timestamps when available)

--no-versions-host

Disable checking the mise-versions host

--prerelease

Include pre-release versions in the output for backends that report upstream prerelease metadata or opt in to regex-based prerelease detection. Equivalent to setting `MISE_PRERELEASES=1` or the `prereleases` setting for the duration of this command.

--strict-metadata

Fail if release metadata fetches fail

Requires --json and --no-versions-host.

This prevents metadata consumers from accepting empty fallback results when a backend's metadata-producing upstream request fails. Arguments:

<TOOL@VERSION>

Tool to get versions for

<PREFIX>

The version prefix to use when querying the latest version same as the first argument after the "@"

MISE OCI BUILD

[experimental] Build an OCI image from the current mise.toml

Each tool version becomes its own content-addressable OCI layer. Bumping a tool version only invalidates that tool's layer — other tools, the base image, and config are reused unchanged. The output directory conforms to the OCI image-layout spec and can be consumed by `skopeo`, `crane`, or `podman load`.

Requires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`).

Usage: mise oci build [OPTIONS]

Options:

--copy <HOST_PATH:IMAGE_PATH>: Copy a host file, directory, or symlink into the image (repeatable, HOST:IMAGE)
-o, --output <OUTPUT>: Output directory for the OCI image layout

Default: ./mise-oci

--from <FROM>: Base image reference (overrides [oci].from and the oci.default_from setting)
--include-global: Also include tools from the global / system config (default: project-only)
By default `mise oci build` only packages tools declared in the project's mise config (and any parent configs at-or-below the project root, e.g. a monorepo root config). Personal dev tools in `~/.config/mise/config.toml` are excluded so they don't bake into a project image. Pass `--include-global` to revert to the old "merge all loaded configs" behavior.
-t, --tag <TAG>: Tag to record in the image index (the org.opencontainers.image.ref.name annotation)
--mount-point <MOUNT_POINT>: Where to place tool installs inside the image (default: /mise)
--no-mise: Do not embed the currently-running mise binary at /usr/local/bin/mise
--owner <UID[:GID]>: UID[:GID] to assign to every tar entry in generated layers
Overrides [oci].user_id / [oci].group_id. Defaults to 0:0. If GID is omitted, it defaults to UID. This affects file ownership only; [oci].user controls the image USER directive.

MISE OCI PUSH

[experimental] Build an OCI image and push it to a registry

Requires `skopeo` (or `crane`) on PATH. If `--image-dir` is not passed, builds fresh from the current mise.toml first, then shells out to `skopeo copy oci:<dir> docker://<ref>` (or `crane push <dir> <ref>`). Authentication is handled by the underlying tool — configure it the same way you would for a plain `skopeo` / `crane` push (e.g. `docker login`, `REGISTRY_AUTH_FILE`, `~/.config/containers/auth.json`).

Requires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`).

Usage: mise oci push [OPTIONS] <REF>

Options:

--from <FROM>: Base image for the build (ignored with --image-dir)
--image-dir <IMAGE_DIR>: Push an already-built OCI image layout (skip the build step)
--include-global: Also include tools from the global / system config (default: project-only)
See `mise oci build --help` for details.
--mount-point <MOUNT_POINT>: Override in-image mount point (ignored with --image-dir)
--no-mise: Don't embed the mise binary (ignored with --image-dir)
--owner <UID[:GID]>: UID[:GID] to assign to every tar entry when building (conflicts with --image-dir)
Overrides [oci].user_id / [oci].group_id. Defaults to 0:0. If GID is omitted, it defaults to UID. This affects file ownership only; [oci].user controls the image USER directive.
--tool <TOOL>: Force the push tool (`auto`, `skopeo`, `crane`). Default `auto`

Default: auto

Arguments:

<REF>: Destination registry reference (e.g. `ghcr.io/me/devenv:latest`)

MISE OCI RUN

[experimental] Build an OCI image from the current mise.toml and run a command in it

Equivalent to `mise oci build` followed by `docker run` / `podman run`. The built image is loaded into the local container engine (podman is preferred; docker works via skopeo) and the given command is executed inside it with stdin/stdout/stderr inherited.

Requires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`) and one of: `podman`, `docker+skopeo`.

Usage: mise oci run [OPTIONS] [<CMD>] ...

Options:

--engine <ENGINE>: Container engine to use (`auto`, `podman`, or `docker`)

Default: auto

--from <FROM>: Base image reference for the build (ignored with --image-dir)
--image-dir <IMAGE_DIR>: Use an already-built OCI image layout instead of building fresh
--include-global: Also include tools from the global / system config (default: project-only)
See `mise oci build --help` for details.
--keep: Keep the loaded image in the engine's storage after the run
By default, both the container (`--rm`) and the loaded image are removed when the command exits, so repeated `mise oci run` calls don't accumulate images in podman / docker storage. Pass `--keep` to retain the image under the tag mise used (`mise-oci:run-*` for docker; the pulled image ID for podman).
--mount-point <MOUNT_POINT>: Override in-image mount point (ignored with --image-dir)
--no-mise: Don't embed the mise binary (ignored with --image-dir)
--owner <UID[:GID]>: UID[:GID] to assign to every tar entry when building (conflicts with --image-dir)
Overrides [oci].user_id / [oci].group_id. Defaults to 0:0. If GID is omitted, it defaults to UID. This affects file ownership only; [oci].user controls the image USER directive.
--volume <HOST:CONTAINER>: Bind-mount a host path (repeatable, `HOST:CONTAINER[:MODE]`)
Note: unlike `docker run -v`, there's no `-v` short flag here because mise reserves `-v` for --verbose. Use `--volume` or `--mount`.
-e, --env <KEY=VAL>: Set environment variable in the container (repeatable, `KEY=VAL`)
-i, --interactive: Run interactively (pass `-i` to the engine)
-t, --tty: Allocate a TTY (pass `-t` to the engine)
-w, --workdir <WORKDIR>: Working directory inside the container Arguments:
<CMD>: Command and arguments to run inside the container (after `--`)

MISE OUTDATED

Shows outdated tool versions

See `mise upgrade` to upgrade these versions.

Usage: mise outdated [OPTIONS] [<TOOL@VERSION>] ...

Options:

-J, --json

Output in JSON format

-l, --bump

Compares against the latest versions available, not what matches the current config

For example, if you have `node = "20"` in your config by default `mise outdated` will only show other 20.x versions, not 21.x or 22.x versions.

Using this flag, if there are 21.x or newer versions it will display those instead of 20.x.

--inactive

Show outdated tools including installed-but-inactive tools not present in the current config

By default, `mise outdated` only shows tools that come from the current config.

--local

Only show outdated tools defined in local config files

This will only show tools that are defined in project-local mise.toml and will skip tools defined in the global config (~/.config/mise/config.toml).

--monorepo

Placeholder for future monorepo outdated checks; `mise outdated --monorepo` is not implemented yet.

--no-header

Don't show table header Arguments:

<TOOL@VERSION>

Tool(s) to show outdated versions for e.g.: node@20 python@3.10 If not specified, all tools in global and local configs will be shown

MISE PATRONS

Show the individuals supporting mise as Patron-tier members

Lists the individuals on the Patron tier from <https://jdx.dev/patrons.json>. The list refreshes daily; supporting terminals will render each patron's name as a clickable link via OSC 8 hyperlinks.

To appear here, become a patron at <https://jdx.dev/sponsors.html>.

Usage: mise patrons [OPTIONS]

Options:

-J, --json: Output in JSON format
--refresh: Bypass the local cache and re-fetch

MISE PLUGINS

Manage plugins

Usage: mise plugins [OPTIONS] [COMMAND]

Options:

-a, --all: list all available remote plugins
same as `mise plugins ls-remote`
-c, --core: The built-in plugins only Normally these are not shown
-u, --urls: Show the git url for each plugin e.g.: https://github.com/mise-plugins/vfox-cmake.git
--refs: Show the git refs for each plugin e.g.: main 1234abc
--user: List installed plugins
This is the default behavior but can be used with --core to show core and user plugins

MISE PLUGINS INSTALL

Install a plugin

note that mise can automatically install plugins when you install a tool e.g.: `mise install cmake@3.30` will autoinstall the cmake plugin

This behavior can be modified in ~/.config/mise/config.toml

Usage: mise plugins install [OPTIONS] [<NEW_PLUGIN>] [<GIT_URL>] [<REST>] ...

Options:

-a, --all: Install all missing plugins This will only install plugins that have matching shorthands. i.e.: they don't need the full git repo url
-f, --force: Reinstall even if plugin exists
-j, --jobs <JOBS>: Number of jobs to run in parallel
-v, --verbose: Show installation output Arguments:
<NEW_PLUGIN>: The name of the plugin to install e.g.: cmake, poetry Can specify multiple plugins: `mise plugins install cmake poetry`
<GIT_URL>: The git url of the plugin

MISE PLUGINS LINK

Symlinks a plugin into mise

This is used for developing a plugin.

Usage: mise plugins link [OPTIONS] <NAME> [<DIR>]

Options:

-f, --force: Overwrite existing plugin Arguments:
<NAME>: The name of the plugin e.g.: cmake, poetry
<DIR>: The local path to the plugin e.g.: ./vfox-cmake

MISE PLUGINS LS

List installed plugins

Can also show remotely available plugins to install.

Usage: mise plugins ls [OPTIONS]

Options:

-a, --all: List all available remote plugins Same as `mise plugins ls-remote`
-c, --core: The built-in plugins only Normally these are not shown
-o, --outdated: Show plugins with available updates Checks the remote for newer versions and only displays plugins that are outdated
-u, --urls: Show the git url for each plugin e.g.: https://github.com/mise-plugins/vfox-cmake.git
--refs: Show the git refs for each plugin e.g.: main 1234abc
--user: List installed plugins

MISE PLUGINS LS-REMOTE

List all available remote plugins

The full list is here: https://github.com/jdx/mise/blob/main/registry/

Examples:

$ mise plugins ls-remote

Usage: mise plugins ls-remote [OPTIONS]

Options:

-u, --urls: Show the git url for each plugin e.g.: https://github.com/mise-plugins/mise-poetry.git
--only-names: Only show the name of each plugin by default it will show a "*" next to installed plugins

MISE PLUGINS UNINSTALL

Removes a plugin

Usage: mise plugins uninstall [OPTIONS] [<PLUGIN>] ...

Options:

-a, --all: Remove all plugins
-p, --purge: Also remove the plugin's installs, downloads, and cache Arguments:
<PLUGIN>: Plugin(s) to remove

MISE PLUGINS UPDATE

Updates a plugin to the latest version

note: this updates the plugin itself, not the runtime versions

Usage: mise plugins update [OPTIONS] [<PLUGIN>] ...

Options:

-j, --jobs <JOBS>: Number of jobs to run in parallel Default: 4 Arguments:
<PLUGIN>: Plugin(s) to update

MISE DEPS

[experimental] Manage project dependencies

Runs all applicable dependency install steps for the current project. This checks if dependency lockfiles are newer than installed outputs (e.g., package-lock.json vs node_modules/) and runs install commands if needed.

Providers with `auto = true` are automatically invoked before `mise x` and `mise run` unless skipped with the --no-deps flag.

Usage: mise deps [OPTIONS] [<PROVIDER>] [COMMAND]

Options:

--explain: Show why a provider is fresh or stale (requires a provider argument)
-f, --force: Force run all deps steps even if outputs are fresh
-n, --dry-run: Only check if deps install is needed, don't run commands
--list: Show what deps providers are available
--monorepo: Install dependencies from every [monorepo].config_roots config root
Requires monorepo_root = true plus explicit [monorepo].config_roots in the monorepo root config. Providers are named like //apps/api:uv.
--only <ONLY>: Run specific deps rule(s) only
--skip <SKIP>: Skip specific deps rule(s) Arguments:
<PROVIDER>: Provider to operate on (runs only this provider, or use with --explain)

MISE DEPS ADD

Add a dependency

Adds one or more packages to the project using the appropriate package manager. Package specs use the format `ecosystem:package`, e.g., `npm:react` or `npm:@types/react@19`.

Usage: mise deps add [OPTIONS] <PACKAGES> ...

Options:

-D, --dev: Add as a development dependency Arguments:
<PACKAGES>: Package(s) to add (e.g., npm:react, npm:@types/react@19)

MISE DEPS INSTALL

Install all project dependencies

Checks if dependency lockfiles are newer than installed outputs and runs install commands if needed.

Usage: mise deps install [OPTIONS] [<PROVIDER>]

Options:

--explain: Show why a provider is fresh or stale (requires a provider argument)
-f, --force: Force run all deps steps even if outputs are fresh
-n, --dry-run: Only check if deps install is needed, don't run commands
--list: Show what deps providers are available
--monorepo: Install dependencies from every [monorepo].config_roots config root
Requires monorepo_root = true plus explicit [monorepo].config_roots in the monorepo root config. Providers are named like //apps/api:uv.
--only <ONLY>: Run specific deps rule(s) only
--skip <SKIP>: Skip specific deps rule(s) Arguments:
<PROVIDER>: Provider to operate on (runs only this provider, or use with --explain)

MISE DEPS REMOVE

Remove a dependency

Removes one or more packages from the project using the appropriate package manager. Package specs use the format `ecosystem:package`, e.g., `npm:lodash`.

Usage: mise deps remove <PACKAGES> ...

Arguments:

<PACKAGES>: Package(s) to remove (e.g., npm:lodash)

MISE PRUNE

Delete unused versions of tools

mise tracks which config files have been used in ~/.local/state/mise/tracked-configs Versions which are no longer the latest specified in any of those configs are deleted. Versions installed only with environment variables `MISE_<TOOL>_VERSION` will be deleted, as will versions only referenced on the command line `mise exec <TOOL>@<VERSION>`.

Tool stubs that have been executed are tracked in ~/.local/state/mise/tracked-stubs. Versions still referenced by a tracked stub are not deleted.

You can list prunable tools with `mise ls --prunable`

Usage: mise prune [OPTIONS] [<INSTALLED_TOOL>] ...

Options:

-n, --dry-run: Do not actually delete anything
--configs: Prune only tracked and trusted configuration links that point to nonexistent configurations
--dry-run-code: Like --dry-run but exits with code 1 if there are tools to prune
This is useful for scripts to check if tools need to be pruned.
--monorepo: Placeholder for future monorepo pruning; `mise prune --monorepo` is not implemented yet.
--tools: Prune only unused versions of tools Arguments:
<INSTALLED_TOOL>: Prune only these tools

MISE REGISTRY

List available tools to install

This command lists the tools available in the registry as shorthand names.

For example, `poetry` is shorthand for `asdf:mise-plugins/mise-poetry`.

Usage: mise registry [OPTIONS] [<NAME>]

Options:

-b, --backend <BACKEND>: Show only tools for this backend
--complete: Print all tools with descriptions for shell completions
--hide-aliased: Hide aliased tools
-J, --json: Output in JSON format
--security: Include security features for each tool's backends in JSON output.
Requires --json. Security info is de-duplicated across all of a tool's backends. This can add noticeable time for large listings since each backend's security info is resolved individually. Arguments:
<NAME>: Show only the specified tool's full name

MISE RESHIM

Creates new shims based on bin paths from currently installed tools.

This creates new shims in ~/.local/share/mise/shims for CLIs that have been added. mise will try to do this automatically for commands like `npm i -g` but there are other ways to install things (like using yarn or pnpm for node) that mise does not know about and so it will be necessary to call this explicitly.

If you think mise should automatically call this for a particular command, please open an issue on the mise repo. You can also set up a shell function to reshim automatically (it's really fast so you don't need to worry about overhead):

npm() {
command npm "$@"
mise reshim
}

Note that this creates shims for _all_ installed tools, not just the ones that are currently active in mise.toml.

Usage: mise reshim [OPTIONS] [<TOOL>] [<VERSION>]

Options:

-f, --force: Removes all shims before reshimming

MISE RUN

Run task(s)

This command will run a task, or multiple tasks in parallel. Tasks may have dependencies on other tasks or on source files. If source is configured on a task, it will only run if the source files have changed.

Tasks can be defined in mise.toml or as standalone scripts. In mise.toml, tasks take this form:

[tasks.build]
run = "npm run build"
sources = ["src/**/*.ts"]
outputs = ["dist/**/*.js"]

Alternatively, tasks can be defined as standalone scripts. These must be located in `mise-tasks`, `.mise-tasks`, `.mise/tasks`, `mise/tasks` or `.config/mise/tasks`. The name of the script will be the name of the tasks.

$ cat .mise/tasks/build<<EOF
#!/usr/bin/env bash
npm run build
EOF
$ mise run build

Usage: mise run [OPTIONS]

Options:

-c, --continue-on-error: Continue running tasks even if one fails
-C, --cd <CD>: Change to this directory before executing the command
-f, --force: Force the tasks to run even if outputs are up to date
-j, --jobs <JOBS>: Number of tasks to run in parallel [default: 4] Configure with `jobs` config or `MISE_JOBS` env var
-n, --dry-run: Don't actually run the task(s), just print them in order of execution
-o, --output <OUTPUT>: Change how tasks information is output when running tasks
- `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `replacing` - Stdout is replaced each time, stderr is printed as is - `timed` - Only show stdout lines if they are displayed for more than 1 second - `keep-order` - Print stdout/stderr by line, prefixed with the task's label, but keep the order of the output - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors
-q, --quiet: Don't show extra output
-r, --raw: Read/write directly to stdin/stdout/stderr instead of by line Redactions are not applied with this option Configure with `raw` config or `MISE_RAW` env var
-s, --shell <SHELL>: Shell to use to run toml tasks
Defaults to `sh -c -o errexit -o pipefail` on unix, and `cmd /c` on Windows Can also be set with the setting `MISE_UNIX_DEFAULT_INLINE_SHELL_ARGS` or `MISE_WINDOWS_DEFAULT_INLINE_SHELL_ARGS` Or it can be overridden with the `shell` property on a task.
-S, --silent: Don't show any output except for errors
-t, --tool <TOOL@VERSION>: Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10
--allow-env <VAR>: Allow specific env var through (implies --deny-env for everything else) Supports wildcards, e.g. --allow-env='MYAPP_*'
--allow-net <HOST>: Allow network to specific host (implies --deny-net for everything else)
--allow-read <PATH>: Allow reads from specific path (implies --deny-read for everything else)
--allow-write <PATH>: Allow writes to specific path (implies --deny-write for everything else)
--deny-all: Block reads, writes, network, and env vars
--deny-env: Block env var inheritance (only PATH, HOME, USER, SHELL, TERM, LANG pass through)
--deny-net: Block all network access
--deny-read: Block filesystem reads (system libs and tool dirs still accessible)
--deny-write: Block all filesystem writes
--fresh-env: Bypass the environment cache and recompute the environment
--no-cache: Do not use cache on remote tasks
--no-deps: Skip automatic dependency preparation
--no-timings: Hides elapsed time after each task completes
Default to always hide with `MISE_TASK_TIMINGS=0`
--skip-deps: Run only the specified tasks skipping all dependencies
--skip-tools: Skip installing tools before running tasks
Can also be set persistently with the `task.run_auto_install` setting or `MISE_TASK_RUN_AUTO_INSTALL=false` env var
--timeout <TIMEOUT>: Timeout for the task to complete e.g.: 30s, 5m
--timings: Shows elapsed time after each task completes
Default to always show with `MISE_TASK_TIMINGS=1`

MISE SEARCH

Search for tools in the registry

This command searches a tool in the registry.

By default, it will show all tools that fuzzy match the search term. For non-fuzzy matches, use the `--match-type` flag.

Usage: mise search [OPTIONS] [<NAME>]

Options:

-i, --interactive: Show interactive search
-m, --match-type <MATCH_TYPE>: Match type: equal, contains, or fuzzy

Default: fuzzy

--no-header: Don't display headers Arguments:
<NAME>: The tool to search for

MISE SELF-UPDATE

Updates mise itself.

Uses the GitHub Releases API to find the latest release and binary. By default, this will also update any installed plugins. Uses mise's GitHub token resolution chain for authenticated requests.

This command is not available if mise is installed via a package manager.

Usage: mise self-update [OPTIONS] [<VERSION>]

Options:

-f, --force: Update even if already up to date
-y, --yes: Skip confirmation prompt
--no-plugins: Disable auto-updating plugins Arguments:
<VERSION>: Update to a specific version

MISE SET

Set environment variables in mise.toml

By default, this command modifies `mise.toml` in the current directory. If multiple config files exist (e.g., both `mise.toml` and `mise.local.toml`), the lowest precedence file (`mise.toml`) will be used. See https://mise.en.dev/configuration.html#target-file-for-write-operations

Use `-E <env>` to create/modify environment-specific config files like `mise.<env>.toml`.

Usage: mise set [OPTIONS] [<ENV_VAR>] ...

Options:

-E, --env <ENV>: Create/modify an environment-specific config file like .mise.<env>.toml
-g, --global: Set the environment variable in the global config file
--age-encrypt: [experimental] Encrypt the value with age before storing
--age-key-file <PATH>: [experimental] Age identity file for encryption
Defaults to ~/.config/mise/age.txt if it exists
--age-recipient <RECIPIENT>: [experimental] Age recipient (x25519 public key) for encryption
Can be used multiple times. Requires --age-encrypt.
--age-ssh-recipient <PATH_OR_PUBKEY>: [experimental] SSH recipient (public key or path) for age encryption
Can be used multiple times. Requires --age-encrypt.
--complete: Render completions
--file <FILE>: The TOML file to update
Can be a file path or directory. If a directory is provided, will create/use mise.toml in that directory. Defaults to [`MISE_DEFAULT_CONFIG_FILENAME`](https://mise.en.dev/configuration.html#mise_default_config_filename) environment variable, or `mise.toml`. Use [`MISE_GLOBAL_CONFIG_FILE`](https://mise.en.dev/configuration.html#mise_global_config_file) to choose a different global config path.
--no-redact: Show raw values instead of redacting secrets
--prompt: Prompt for environment variable values
--remove, --rm, --unset <ENV_KEY>: Remove the environment variable from config file
Can be used multiple times.
--stdin: Read the value from stdin (for multiline input)
When using --stdin, provide a single key without a value. The value will be read from stdin until EOF. Arguments:
<ENV_VAR>: Environment variable(s) to set e.g.: NODE_ENV=production

MISE SETTINGS

Show current settings

This is the contents of ~/.config/mise/config.toml

Note that aliases are also stored in this file but managed separately with `mise tool-alias`

Usage: mise settings [OPTIONS] [<SETTING>] [<VALUE>] [COMMAND]

Options:

-a, --all: List all settings
-J, --json: Output in JSON format
-l, --local: Use the local config file instead of the global one
-T, --toml: Output in TOML format
--complete: Print all settings with descriptions for shell completions
--json-extended: Output in JSON format with sources Arguments:
<SETTING>: Name of setting
<VALUE>: Setting value to set

MISE SETTINGS ADD

Adds a setting to the configuration file

Used with an array setting, this will append the value to the array. This modifies the contents of ~/.config/mise/config.toml

Usage: mise settings add [OPTIONS] <SETTING> [<VALUE>]

Options:

-l, --local: Use the local config file instead of the global one Arguments:
<SETTING>: The setting to set
<VALUE>: The value to set (optional if provided as KEY=VALUE)

MISE SETTINGS GET

Show a current setting

This is the contents of a single entry in ~/.config/mise/config.toml

Note that aliases are also stored in this file but managed separately with `mise tool-alias get`

Usage: mise settings get [OPTIONS] <SETTING>

Options:

-l, --local: Use the local config file instead of the global one Arguments:
<SETTING>: The setting to show

MISE SETTINGS LS

Show current settings

This is the contents of ~/.config/mise/config.toml

Note that aliases are also stored in this file but managed separately with `mise tool-alias`

Usage: mise settings ls [OPTIONS] [<SETTING>]

Options:

-a, --all: List all settings
-J, --json: Output in JSON format
-l, --local: Use the local config file instead of the global one
-T, --toml: Output in TOML format
--complete: Print all settings with descriptions for shell completions
--json-extended: Output in JSON format with sources Arguments:
<SETTING>: Name of setting

MISE SETTINGS SET

Add/update a setting

This modifies the contents of ~/.config/mise/config.toml by default. With `--local`, modifies the local config file instead. See https://mise.en.dev/configuration.html#target-file-for-write-operations

Usage: mise settings set [OPTIONS] <SETTING> [<VALUE>]

Options:

-l, --local: Use the local config file instead of the global one Arguments:
<SETTING>: The setting to set
<VALUE>: The value to set (optional if provided as KEY=VALUE)

MISE SETTINGS UNSET

Clears a setting

This modifies the contents of ~/.config/mise/config.toml

Usage: mise settings unset [OPTIONS] <KEY>

Options:

-l, --local: Use the local config file instead of the global one Arguments:
<KEY>: The setting to remove

MISE SHELL

Sets a tool version for the current session.

Only works in a session where mise is already activated.

This works by setting environment variables for the current shell session such as `MISE_NODE_VERSION=20` which is "eval"ed as a shell function created by `mise activate`.

Usage: mise shell [OPTIONS] <TOOL@VERSION> ...

Options:

-j, --jobs <JOBS>: Number of jobs to run in parallel [default: 4]
-u, --unset: Removes a previously set version
--raw: Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1 Arguments:
<TOOL@VERSION>: Tool(s) to use

MISE SHELL-ALIAS

Manage shell aliases.

Usage: mise shell-alias [OPTIONS] [COMMAND]

Options:

--no-header: Don't show table header

MISE SHELL-ALIAS GET

Show the command for a shell alias

Usage: mise shell-alias get <shell_alias>

Arguments:

<shell_alias>: The alias to show

MISE SHELL-ALIAS LS

List shell aliases

Shows the shell aliases that are set in the current directory. These are defined in `mise.toml` under the `[shell_alias]` section.

Usage: mise shell-alias ls [OPTIONS]

Options:

--no-header: Don't show table header

MISE SHELL-ALIAS SET

Add/update a shell alias

This modifies the contents of ~/.config/mise/config.toml

Usage: mise shell-alias set <shell_alias> [<COMMAND>]

Arguments:

<shell_alias>: The alias name
<COMMAND>: The command to run (optional if provided as ALIAS=COMMAND)

MISE SHELL-ALIAS UNSET

Removes a shell alias

This modifies the contents of ~/.config/mise/config.toml

Usage: mise shell-alias unset <shell_alias>

Arguments:

<shell_alias>: The alias to remove

MISE SYNC NODE

Symlinks all tool versions from an external tool into mise

For example, use this to import all Homebrew node installs into mise

This won't overwrite any existing installs but will overwrite any existing symlinks

Usage: mise sync node [OPTIONS]

Options:

--brew: Get tool versions from Homebrew
--nodenv: Get tool versions from nodenv
--nvm: Get tool versions from nvm

MISE SYNC PYTHON

Symlinks all tool versions from an external tool into mise

For example, use this to import all pyenv installs into mise

This won't overwrite any existing installs but will overwrite any existing symlinks

Usage: mise sync python [OPTIONS]

Options:

--pyenv: Get tool versions from pyenv
--uv: Sync tool versions with uv (2-way sync)

MISE SYNC RUBY

Symlinks all ruby tool versions from an external tool into mise

Usage: mise sync ruby [OPTIONS]

Options:

--brew: Get tool versions from Homebrew

MISE TASKS

Manage tasks

Usage: mise tasks [OPTIONS] [<TASK>] [COMMAND]

Options:

-g, --global: Only show global tasks
-J, --json: Output in JSON format
-l, --local: Only show non-global tasks
-x, --extended: Show all columns
--all: Load all tasks from the entire monorepo, including sibling directories. By default, only tasks from the current directory hierarchy are loaded.
--complete: Display tasks for usage completion
--hidden: Show hidden tasks
--name-only: Only show task names, one per line. Useful for piping to fzf and similar tools.
--no-header: Do not print table header
--sort <COLUMN>: Sort by column. Default is name.
--sort-order <SORT_ORDER>: Sort order. Default is asc.
--usage: Arguments:
<TASK>: Task name to get info of

MISE TASKS ADD

Create a new task

Adds a task to the local mise.toml file. See https://mise.en.dev/configuration.html#target-file-for-write-operations

Usage: mise tasks add [OPTIONS] <TASK> [<RUN>] ...

Options:

-a, --alias <ALIAS>: Other names for the task
-d, --depends <DEPENDS>: Add dependencies to the task
-D, --dir <DIR>: Run the task in a specific directory
-f, --file: Create a file task instead of a toml task
-H, --hide: Hide the task from `mise tasks` and completions
-q, --quiet: Do not print the command before running
-r, --raw: Directly connect stdin/stdout/stderr
-s, --sources <SOURCES>: Glob patterns of files this task uses as input
-w, --wait-for <WAIT_FOR>: Wait for these tasks to complete if they are to run
--depends-post <DEPENDS_POST>: Dependencies to run after the task runs
--description <DESCRIPTION>: Description of the task
--outputs <OUTPUTS>: Glob patterns of files this task creates, to skip if they are not modified
--run-windows <RUN_WINDOWS>: Command to run on windows
--shell <SHELL>: Run the task in a specific shell
--silent: Do not print the command or its output Arguments:
<TASK>: Tasks name to add

MISE TASKS DEPS

Display a tree visualization of a dependency graph

Usage: mise tasks deps [OPTIONS] [<TASKS>] ...

Options:

--dot: Display dependencies in DOT format
--hidden: Show hidden tasks Arguments:
<TASKS>: Tasks to show dependencies for Can specify multiple tasks by separating with spaces e.g.: mise tasks deps lint test check

MISE TASKS EDIT

Edit a task with $EDITOR

The task will be created as a standalone script if it does not already exist.

Usage: mise tasks edit [OPTIONS] <TASK>

Options:

-p, --path: Display the path to the task instead of editing it Arguments:
<TASK>: Task to edit

MISE TASKS INFO

Get information about a task

Usage: mise tasks info [OPTIONS] <TASK>

Options:

-J, --json: Output in JSON format Arguments:
<TASK>: Name of the task to get information about

MISE TASKS LS

List available tasks to execute These may be included from the config file or from the project's .mise/tasks directory mise will merge all tasks from all parent directories into this list.

So if you have global tasks in `~/.config/mise/tasks/*` and project-specific tasks in ~/myproject/.mise/tasks/*, then they'll both be available but the project-specific tasks will override the global ones if they have the same name.

Usage: mise tasks ls [OPTIONS]

Options:

-g, --global: Only show global tasks
-J, --json: Output in JSON format
-l, --local: Only show non-global tasks
-x, --extended: Show all columns
--all: Load all tasks from the entire monorepo, including sibling directories. By default, only tasks from the current directory hierarchy are loaded.
--complete: Display tasks for usage completion
--hidden: Show hidden tasks
--name-only: Only show task names, one per line. Useful for piping to fzf and similar tools.
--no-header: Do not print table header
--sort <COLUMN>: Sort by column. Default is name.
--sort-order <SORT_ORDER>: Sort order. Default is asc.
--usage

MISE TASKS RUN

Run task(s)

Tasks can be defined in mise.toml or as standalone scripts. In mise.toml, tasks take this form:

[tasks.build]
run = "npm run build"
sources = ["src/**/*.ts"]
outputs = ["dist/**/*.js"]

$ cat .mise/tasks/build<<EOF
#!/usr/bin/env bash
npm run build
EOF
$ mise run build

Usage: mise tasks run [OPTIONS] [<TASK>] [<ARGS>] ... [<ARGS_LAST>] ...

Options:

-c, --continue-on-error: Continue running tasks even if one fails
-C, --cd <CD>: Change to this directory before executing the command
-f, --force: Force the tasks to run even if outputs are up to date
-j, --jobs <JOBS>: Number of tasks to run in parallel [default: 4] Configure with `jobs` config or `MISE_JOBS` env var
-n, --dry-run: Don't actually run the task(s), just print them in order of execution
-o, --output <OUTPUT>: Change how tasks information is output when running tasks
- `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `replacing` - Stdout is replaced each time, stderr is printed as is - `timed` - Only show stdout lines if they are displayed for more than 1 second - `keep-order` - Print stdout/stderr by line, prefixed with the task's label, but keep the order of the output - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors
-q, --quiet: Don't show extra output
-r, --raw: Read/write directly to stdin/stdout/stderr instead of by line Redactions are not applied with this option Configure with `raw` config or `MISE_RAW` env var
-s, --shell <SHELL>: Shell to use to run toml tasks
Defaults to `sh -c -o errexit -o pipefail` on unix, and `cmd /c` on Windows Can also be set with the setting `MISE_UNIX_DEFAULT_INLINE_SHELL_ARGS` or `MISE_WINDOWS_DEFAULT_INLINE_SHELL_ARGS` Or it can be overridden with the `shell` property on a task.
-S, --silent: Don't show any output except for errors
-t, --tool <TOOL@VERSION>: Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10
--allow-env <VAR>: Allow specific env var through (implies --deny-env for everything else) Supports wildcards, e.g. --allow-env='MYAPP_*'
--allow-net <HOST>: Allow network to specific host (implies --deny-net for everything else)
--allow-read <PATH>: Allow reads from specific path (implies --deny-read for everything else)
--allow-write <PATH>: Allow writes to specific path (implies --deny-write for everything else)
--deny-all: Block reads, writes, network, and env vars
--deny-env: Block env var inheritance (only PATH, HOME, USER, SHELL, TERM, LANG pass through)
--deny-net: Block all network access
--deny-read: Block filesystem reads (system libs and tool dirs still accessible)
--deny-write: Block all filesystem writes
--fresh-env: Bypass the environment cache and recompute the environment
--no-cache: Do not use cache on remote tasks
--no-deps: Skip automatic dependency preparation
--no-timings: Hides elapsed time after each task completes
Default to always hide with `MISE_TASK_TIMINGS=0`
--skip-deps: Run only the specified tasks skipping all dependencies
--skip-tools: Skip installing tools before running tasks
Can also be set persistently with the `task.run_auto_install` setting or `MISE_TASK_RUN_AUTO_INSTALL=false` env var
--timeout <TIMEOUT>: Timeout for the task to complete e.g.: 30s, 5m
--timings: Shows elapsed time after each task completes
Default to always show with `MISE_TASK_TIMINGS=1` Arguments:
<TASK>: Tasks to run Can specify multiple tasks by separating with `:::` e.g.: mise run task1 arg1 arg2 ::: task2 arg1 arg2

Default: default

<ARGS>: Arguments to pass to the tasks. Use ":::" to separate tasks
<ARGS_LAST>: Arguments to pass to the tasks. Use ":::" to separate tasks

MISE TASKS VALIDATE

Validate tasks for common errors and issues

Usage: mise tasks validate [OPTIONS] [<TASKS>] ...

Options:

--errors-only: Only show errors (skip warnings)
--json: Output validation results in JSON format Arguments:
<TASKS>: Tasks to validate If not specified, validates all tasks

MISE TEST-TOOL

Test a tool installs and executes

Usage: mise test-tool [OPTIONS] [<TOOLS>] ...

Options:

-a, --all: Test every tool specified in registry/
-j, --jobs <JOBS>: Number of tool tests to run in parallel [default: 4]
--all-config: Test all tools specified in config files
--include-non-defined: Also test tools not defined in registry/, guessing how to test it
--raw: Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1 Arguments:
<TOOLS>: Tool(s) to test

MISE TOKEN FORGEJO

Forgejo token

Usage: mise token forgejo [OPTIONS] [<HOST>]

Options:

--unmask: Show the full unmasked token Arguments:
<HOST>: Forgejo hostname

Default: codeberg.org

MISE TOKEN GITHUB

GitHub token

Usage: mise token github [OPTIONS] [<HOST>]

Options:

--oauth: Resolve only via the native GitHub OAuth source (cache, refresh, or device-code flow), bypassing other token sources
--raw: Print only the token value
--refresh: Mint a fresh OAuth token even if the cached one has not expired, via the refresh-token grant or a new device-code flow. Use after changing the GitHub App's installations or permissions: cached tokens keep their original access until they expire
--unmask: Show the full unmasked token Arguments:
<HOST>: GitHub hostname

Default: github.com

MISE TOKEN GITLAB

GitLab token

Usage: mise token gitlab [OPTIONS] [<HOST>]

Options:

--unmask: Show the full unmasked token Arguments:
<HOST>: GitLab hostname

Default: gitlab.com

MISE TOOL

Gets information about a tool

Usage: mise tool [OPTIONS] <TOOL>

Options:

-J, --json: Output in JSON format
--active: Only show active versions
--backend: Only show backend field
--config-source: Only show config source
--description: Only show description field
--installed: Only show installed versions
--requested: Only show requested versions
--tool-options: Only show tool options Arguments:
<TOOL>: Tool name to get information about

MISE TOOL-STUB

Execute a tool stub

Tool stubs are executable files containing TOML configuration that specify which tool to run and how to run it. They provide a convenient way to create portable, self-contained executables that automatically manage tool installation and execution.

A tool stub consists of: - A shebang line: #!/usr/bin/env -S mise tool-stub - TOML configuration specifying the tool, version, and options - Optional comments describing the tool's purpose

Example stub file: #!/usr/bin/env -S mise tool-stub # Node.js v20 development environment

tool = "node" version = "20.0.0" bin = "node"

The stub will automatically install the specified tool version if missing and execute it with any arguments passed to the stub.

For more information, see: https://mise.en.dev/dev-tools/tool-stubs.html

Usage: mise tool-stub <FILE> [<ARGS>] ...

Arguments:

<FILE>: Path to the TOML tool stub file to execute
The stub file must contain TOML configuration specifying the tool and version to run. At minimum, it should specify a 'version' field. Other common fields include 'tool', 'bin', and backend-specific options.
<ARGS>: Arguments to pass to the tool
All arguments after the stub file path will be forwarded to the underlying tool. Use '--' to separate mise arguments from tool arguments if needed.

MISE TRUST

Marks a config file as trusted

This means mise is allowed to parse the file when it needs to read config that may execute code or affect the environment. mise checks trust before parsing `mise.toml`. Without trust, mise may prompt, skip the config in some discovery paths, fail with an untrusted-config error when it cannot prompt, or assume trust in detected CI unless paranoid mode is enabled.

Safe config files do not require trust: files that only contain `min_version`, `[tools]` entries with plain version strings (or arrays of them), and `[tasks]` (no templates and no tool options) are loaded without prompting, since nothing in them executes code at load time — tools install and tasks run only on explicit commands like `mise install` or `mise run`.

Trust is shared across git worktrees: a config file inside a linked worktree is trusted when the equivalent path in the repository's main checkout has been trusted. Paranoid mode disables this sharing since worktrees can check out branches with different config contents.

Usage: mise trust [OPTIONS] [<CONFIG_FILE>]

Options:

-a, --all: Trust all config files in the current directory, its parents, and its subdirectories
Subdirectories are walked respecting .gitignore, skipping hidden directories and common build/dependency directories (node_modules, vendor, target, dist, build).
--ignore: Do not trust this config and ignore it in the future
--show: Show the trusted status of config files from the current directory and its parents. Does not trust or untrust any files.
--untrust: No longer trust this config, will prompt in the future Arguments:
<CONFIG_FILE>: The config file to trust

MISE UNINSTALL

Removes installed tool versions

This only removes the installed version, it does not modify mise.toml.

Usage: mise uninstall [OPTIONS] [<INSTALLED_TOOL@VERSION>] ...

Options:

-a, --all: Delete all installed versions
-n, --dry-run: Do not actually delete anything
--dry-run-code: Like --dry-run but exits with code 1 if there are tools to uninstall
This is useful for scripts to check if tools need to be uninstalled. Arguments:
<INSTALLED_TOOL@VERSION>: Tool(s) to remove

MISE UNSET

Remove environment variable(s) from the config file.

By default, this command modifies `mise.toml` in the current directory.

Usage: mise unset [OPTIONS] [<ENV_KEY>] ...

Options:

-f, --file <FILE>: Specify a file to use instead of `mise.toml`
Defaults to [`MISE_DEFAULT_CONFIG_FILENAME`](https://mise.en.dev/configuration.html#mise_default_config_filename) environment variable, or `mise.toml`. Use [`MISE_GLOBAL_CONFIG_FILE`](https://mise.en.dev/configuration.html#mise_global_config_file) to choose a different global config path.
-g, --global: Use the global config file Arguments:
<ENV_KEY>: Environment variable(s) to remove e.g.: NODE_ENV

MISE UNTRUST

No longer trust a config, will prompt in the future

Usage: mise untrust [<CONFIG_FILE>]

Arguments:

<CONFIG_FILE>: The config file to untrust

MISE UNUSE

Removes installed tool versions from mise.toml

By default, this will use the `mise.toml` file that has the tool defined. If multiple config files exist (e.g., both `mise.toml` and `mise.local.toml`), the lowest precedence file (`mise.toml`) will be used. See https://mise.en.dev/configuration.html#target-file-for-write-operations

In the following order:
- If `--global` is set, it will use the global config file.
- If `--path` is set, it will use the config file at the given path.
- If `--env` is set, it will use `mise.<env>.toml`.
- If [`MISE_DEFAULT_CONFIG_FILENAME`](https://mise.en.dev/configuration.html#mise_default_config_filename) is set, it will use that instead.
- If `MISE_OVERRIDE_CONFIG_FILENAMES` is set, it will the first from that list.
- Otherwise just "mise.toml" or global config if cwd is home directory.

Use [`MISE_GLOBAL_CONFIG_FILE`](https://mise.en.dev/configuration.html#mise_global_config_file) to choose a different global config path.

Will also prune the installed version if no other configurations are using it.

Usage: mise unuse [OPTIONS] <INSTALLED_TOOL@VERSION> ...

Options:

-e, --env <ENV>: Create/modify an environment-specific config file like .mise.<env>.toml
-g, --global: Use the global config file (`~/.config/mise/config.toml`) instead of the local one
-p, --path <PATH>: Specify a path to a config file or directory
If a directory is specified, it will look for a config file in that directory following the rules above.
--no-prune: Do not also prune the installed version Arguments:
<INSTALLED_TOOL@VERSION>: Tool(s) to remove

MISE UPGRADE

Upgrades outdated tools

By default, this keeps the range specified in mise.toml. So if you have node@20 set, it will upgrade to the latest 20.x.x version available. See the `--bump` flag to use the latest version and bump the version in mise.toml.

This will update mise.lock if it is enabled, see https://mise.en.dev/configuration/settings.html#lockfile

Usage: mise upgrade [OPTIONS] [<INSTALLED_TOOL@VERSION>] ...

Options:

-i, --interactive

Display multiselect menu to choose which tools to upgrade

-j, --jobs <JOBS>

Number of jobs to run in parallel [default: 4]

-l, --bump

Upgrades to the latest version available, bumping the version in mise.toml

For example, if you have `node = "20.0.0"` in your mise.toml but 22.1.0 is the latest available, this will install 22.1.0 and set `node = "22.1.0"` in your config.

It keeps the same precision as what was there before, so if you instead had `node = "20"`, it would change your config to `node = "22"`.

-n, --dry-run

Just print what would be done, don't actually do it

-x, --exclude <INSTALLED_TOOL>

Tool(s) to exclude from upgrading e.g.: go python

--dry-run-code

Like --dry-run but exits with code 1 if there are outdated tools

This is useful for scripts to check if tools need to be upgraded.

--inactive

Upgrade all tools, including installed-but-inactive tools not present in the current config

--local

Only upgrade tools defined in local config files

This will only upgrade tools that are defined in project-local mise.toml and will skip tools defined in the global config (~/.config/mise/config.toml).

--minimum-release-age <MINIMUM_RELEASE_AGE>

Only upgrade to versions released before this date or older than this duration

Supports absolute dates like "2024-06-01" and relative durations like "90d" or "1y". This can be useful for reproducibility or security purposes.

This only affects fuzzy version matches like "20" or "latest". Explicitly pinned versions like "22.5.0" are not filtered.

--monorepo

Placeholder for future monorepo upgrades; `mise upgrade --monorepo` is not implemented yet.

--raw

Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1 Arguments:

<INSTALLED_TOOL@VERSION>

Tool(s) to upgrade e.g.: node@20 python@3.10 If not specified, all current tools will be upgraded

MISE USE

Installs a tool and adds the version to mise.toml.

This will install the tool version if it is not already installed. By default, this will use a `mise.toml` file in the current directory. If multiple config files exist (e.g., both `mise.toml` and `mise.local.toml`), the lowest precedence file (`mise.toml`) will be used. See https://mise.en.dev/configuration.html#target-file-for-write-operations

Use [`MISE_GLOBAL_CONFIG_FILE`](https://mise.en.dev/configuration.html#mise_global_config_file) to choose a different global config path.

Use the `--global` flag to use the global config file instead.

Usage: mise use [OPTIONS] [<TOOL@VERSION>] ...

Options:

-e, --env <ENV>

Create/modify an environment-specific config file like .mise.<env>.toml

-f, --force

Force reinstall even if already installed

-g, --global

Use the global config file (`~/.config/mise/config.toml`) instead of the local one

-j, --jobs <JOBS>

Number of jobs to run in parallel [default: 4]

-n, --dry-run

Perform a dry run, showing what would be installed and modified without making changes

-p, --path <PATH>

Specify a path to a config file or directory

If a directory is specified, it will look for a config file in that directory following the rules above.

--dry-run-code

Like --dry-run but exits with code 1 if there are changes to make

This is useful for scripts to check if tools need to be added or removed.

--fuzzy

Save fuzzy version to config file

e.g.: `mise use --fuzzy node@20` will save 20 as the version this is the default behavior unless `MISE_PIN=1`

--minimum-release-age <MINIMUM_RELEASE_AGE>

Only install versions released before this date or older than this duration

Supports absolute dates like "2024-06-01" and relative durations like "90d" or "1y".

--pin

Save exact version to config file e.g.: `mise use --pin node@20` will save 20.0.0 as the version Set `MISE_PIN=1` to make this the default behavior

Consider using mise.lock as a better alternative to pinning in mise.toml: https://mise.en.dev/configuration/settings.html#lockfile

--raw

Connect backend install command stdin/stdout/stderr directly to the terminal Implies `--jobs=1`

--remove <TOOL>

Remove the tool(s) from config file Arguments:

<TOOL@VERSION>

Tool(s) to add to config file

e.g.: node@20, cargo:ripgrep@latest npm:prettier@3 If no version is specified, it will default to @latest

Tool options can be set with this syntax:

mise use ubi:BurntSushi/ripgrep[exe=rg]

MISE VERSION

Display the version of mise

Displays the version, os, architecture, and the date of the build.

If the version is out of date, it will display a warning.

Usage: mise version [OPTIONS]

Options:

-J, --json: Print the version information in JSON format

MISE WATCH

Run task(s) and watch for changes to rerun it

This command uses the `watchexec` tool to watch for changes to files and rerun the specified task(s). It must be installed for this command to work, but you can install it with `mise use -g watchexec@latest`.

For more advanced process management (daemon management, auto-restart, readiness checks, cron scheduling), see mise's sister project: https://pitchfork.jdx.dev

Usage: mise watch [OPTIONS] [<TASK>] [<ARGS>] ...

Options:

-t, --task-flag <TASK_FLAG>

Tasks to run

-g, --glob <GLOB>

Files to watch Defaults to sources from the task(s)

--skip-deps

Run only the specified tasks skipping all dependencies

-w, --watch <PATH>

Watch a specific file or directory

By default, Watchexec watches the current directory.

When watching a single file, it's often better to watch the containing directory instead, and filter on the filename. Some editors may replace the file with a new one when saving, and some platforms may not detect that or further changes.

Upon starting, Watchexec resolves a "project origin" from the watched paths. See the help for '--project-origin' for more information.

This option can be specified multiple times to watch multiple files or directories.

The special value '/dev/null', provided as the only path watched, will cause Watchexec to not watch any paths. Other event sources (like signals or key events) may still be used.

-W, --watch-non-recursive <PATH>

Watch a specific directory, non-recursively

Unlike '-w', folders watched with this option are not recursed into.

This option can be specified multiple times to watch multiple directories non-recursively.

-F, --watch-file <PATH>

Watch files and directories from a file

Each line in the file will be interpreted as if given to '-w'.

For more complex uses (like watching non-recursively), use the argfile capability: build a file containing command-line options and pass it to watchexec with `@path/to/argfile`.

The special value '-' will read from STDIN; this in incompatible with '--stdin-quit'.

-c, --clear <MODE>

Clear screen before running command

If this doesn't completely clear the screen, try '--clear=reset'.

-o, --on-busy-update <MODE>

What to do when receiving events while the command is running

Default is to 'do-nothing', which ignores events while the command is running, so that changes that occur due to the command are ignored, like compilation outputs. You can also use 'queue' which will run the command once again when the current run has finished if any events occur while it's running, or 'restart', which terminates the running command and starts a new one. Finally, there's 'signal', which only sends a signal; this can be useful with programs that can reload their configuration without a full restart.

The signal can be specified with the '--signal' option.

Default: do-nothing

-r, --restart

Restart the process if it's still running

This is a shorthand for '--on-busy-update=restart'.

-s, --signal <SIGNAL>

Send a signal to the process when it's still running

Specify a signal to send to the process when it's still running. This implies '--on-busy-update=signal'; otherwise the signal used when that mode is 'restart' is controlled by '--stop-signal'.

See the long documentation for '--stop-signal' for syntax.

Signals are not supported on Windows at the moment, and will always be overridden to 'kill'. See '--stop-signal' for more on Windows "signals".

--stop-signal <SIGNAL>

Signal to send to stop the command

This is used by 'restart' and 'signal' modes of '--on-busy-update' (unless '--signal' is provided). The restart behaviour is to send the signal, wait for the command to exit, and if it hasn't exited after some time (see '--timeout-stop'), forcefully terminate it.

The default on unix is "SIGTERM".

Input is parsed as a full signal name (like "SIGTERM"), a short signal name (like "TERM"), or a signal number (like "15"). All input is case-insensitive.

On Windows this option is technically supported but only supports the "KILL" event, as Watchexec cannot yet deliver other events. Windows doesn't have signals as such; instead it has termination (here called "KILL" or "STOP") and "CTRL+C", "CTRL+BREAK", and "CTRL+CLOSE" events. For portability the unix signals "SIGKILL", "SIGINT", "SIGTERM", and "SIGHUP" are respectively mapped to these.

--stop-timeout <TIMEOUT>

Time to wait for the command to exit gracefully

This is used by the 'restart' mode of '--on-busy-update'. After the graceful stop signal is sent, Watchexec will wait for the command to exit. If it hasn't exited after this time, it is forcefully terminated.

Takes a unit-less value in seconds, or a time span value such as "5min 20s". Providing a unit-less value is deprecated and will warn; it will be an error in the future.

The default is 10 seconds. Set to 0 to immediately force-kill the command.

This has no practical effect on Windows as the command is always forcefully terminated; see '--stop-signal' for why.

Default: 10s

--map-signal <SIGNAL:SIGNAL>

Translate signals from the OS to signals to send to the command

Takes a pair of signal names, separated by a colon, such as "TERM:INT" to map SIGTERM to SIGINT. The first signal is the one received by watchexec, and the second is the one sent to the command. The second can be omitted to discard the first signal, such as "TERM:" to not do anything on SIGTERM.

If SIGINT or SIGTERM are mapped, then they no longer quit Watchexec. Besides making it hard to quit Watchexec itself, this is useful to send pass a Ctrl-C to the command without also terminating Watchexec and the underlying program with it, e.g. with "INT:INT".

This option can be specified multiple times to map multiple signals.

Signal syntax is case-insensitive for short names (like "TERM", "USR2") and long names (like "SIGKILL", "SIGHUP"). Signal numbers are also supported (like "15", "31"). On Windows, the forms "STOP", "CTRL+C", and "CTRL+BREAK" are also supported to receive, but Watchexec cannot yet deliver other "signals" than a STOP.

-d, --debounce <TIMEOUT>

Time to wait for new events before taking action

When an event is received, Watchexec will wait for up to this amount of time before handling it (such as running the command). This is essential as what you might perceive as a single change may actually emit many events, and without this behaviour, Watchexec would run much too often. Additionally, it's not infrequent that file writes are not atomic, and each write may emit an event, so this is a good way to avoid running a command while a file is partially written.

An alternative use is to set a high value (like "30min" or longer), to save power or bandwidth on intensive tasks, like an ad-hoc backup script. In those use cases, note that every accumulated event will build up in memory.

Takes a unit-less value in milliseconds, or a time span value such as "5sec 20ms". Providing a unit-less value is deprecated and will warn; it will be an error in the future.

The default is 50 milliseconds. Setting to 0 is highly discouraged.

Default: 50ms

--stdin-quit

Exit when stdin closes

This watches the stdin file descriptor for EOF, and exits Watchexec gracefully when it is closed. This is used by some process managers to avoid leaving zombie processes around.

--no-vcs-ignore

Don't load gitignores

Among other VCS exclude files, like for Mercurial, Subversion, Bazaar, DARCS, Fossil. Note that Watchexec will detect which of these is in use, if any, and only load the relevant files. Both global (like '~/.gitignore') and local (like '.gitignore') files are considered.

This option is useful if you want to watch files that are ignored by Git.

--no-project-ignore

Don't load project-local ignores

This disables loading of project-local ignore files, like '.gitignore' or '.ignore' in the watched project. This is contrasted with '--no-vcs-ignore', which disables loading of Git and other VCS ignore files, and with '--no-global-ignore', which disables loading of global or user ignore files, like '~/.gitignore' or '~/.config/watchexec/ignore'.

Supported project ignore files:

- Git: .gitignore at project root and child directories, .git/info/exclude, and the file pointed to by `core.excludesFile` in .git/config.
- Mercurial: .hgignore at project root and child directories.
- Bazaar: .bzrignore at project root.
- Darcs: _darcs/prefs/boring
- Fossil: .fossil-settings/ignore-glob
- Ripgrep/Watchexec/generic: .ignore at project root and child directories.

VCS ignore files (Git, Mercurial, Bazaar, Darcs, Fossil) are only used if the corresponding VCS is discovered to be in use for the project/origin. For example, a .bzrignore in a Git repository will be discarded.

--no-global-ignore

Don't load global ignores

This disables loading of global or user ignore files, like '~/.gitignore', '~/.config/watchexec/ignore', or '%APPDATA%\Bazaar\2.0\ignore'. Contrast with '--no-vcs-ignore' and '--no-project-ignore'.

Supported global ignore files

- Git (if core.excludesFile is set): the file at that path
- Git (otherwise): the first found of $XDG_CONFIG_HOME/git/ignore, %APPDATA%/.gitignore, %USERPROFILE%/.gitignore, $HOME/.config/git/ignore, $HOME/.gitignore.
- Bazaar: the first found of %APPDATA%/Bazaar/2.0/ignore, $HOME/.bazaar/ignore.
- Watchexec: the first found of $XDG_CONFIG_HOME/watchexec/ignore, %APPDATA%/watchexec/ignore, %USERPROFILE%/.watchexec/ignore, $HOME/.watchexec/ignore.

Like for project files, Git and Bazaar global files will only be used for the corresponding VCS as used in the project.

--no-default-ignore

Don't use internal default ignores

Watchexec has a set of default ignore patterns, such as editor swap files, `*.pyc`, `*.pyo`, `.DS_Store`, `.bzr`, `_darcs`, `.fossil-settings`, `.git`, `.hg`, `.pijul`, `.svn`, and Watchexec log files.

--no-discover-ignore

Don't discover ignore files at all

This is a shorthand for '--no-global-ignore', '--no-vcs-ignore', '--no-project-ignore', but even more efficient as it will skip all the ignore discovery mechanisms from the get go.

Note that default ignores are still loaded, see '--no-default-ignore'.

--ignore-nothing

Don't ignore anything at all

This is a shorthand for '--no-discover-ignore', '--no-default-ignore'.

Note that ignores explicitly loaded via other command line options, such as '--ignore' or '--ignore-file', will still be used.

-p, --postpone

Wait until first change before running command

By default, Watchexec will run the command once immediately. With this option, it will instead wait until an event is detected before running the command as normal.

--delay-run <DURATION>

Sleep before running the command

This option will cause Watchexec to sleep for the specified amount of time before running the command, after an event is detected. This is like using "sleep 5 && command" in a shell, but portable and slightly more efficient.

Takes a unit-less value in seconds, or a time span value such as "2min 5s". Providing a unit-less value is deprecated and will warn; it will be an error in the future.

--poll <INTERVAL>

Poll for filesystem changes

By default, and where available, Watchexec uses the operating system's native file system watching capabilities. This option disables that and instead uses a polling mechanism, which is less efficient but can work around issues with some file systems (like network shares) or edge cases.

Optionally takes a unit-less value in milliseconds, or a time span value such as "2s 500ms", to use as the polling interval. If not specified, the default is 30 seconds. Providing a unit-less value is deprecated and will warn; it will be an error in the future.

Aliased as '--force-poll'.

--shell <SHELL>

Use a different shell

By default, Watchexec will use '$SHELL' if it's defined or a default of 'sh' on Unix-likes, and either 'pwsh', 'powershell', or 'cmd' (CMD.EXE) on Windows, depending on what Watchexec detects is the running shell.

With this option, you can override that and use a different shell, for example one with more features or one which has your custom aliases and functions.

If the value has spaces, it is parsed as a command line, and the first word used as the shell program, with the rest as arguments to the shell.

The command is run with the '-c' flag (except for 'cmd' on Windows, where it's '/C').

The special value 'none' can be used to disable shell use entirely. In that case, the command provided to Watchexec will be parsed, with the first word being the executable and the rest being the arguments, and executed directly. Note that this parsing is rudimentary, and may not work as expected in all cases.

Using 'none' is a little more efficient and can enable a stricter interpretation of the input, but it also means that you can't use shell features like globbing, redirection, control flow, logic, or pipes.

Examples:

Use without shell:

$ watchexec -n -- zsh -x -o shwordsplit scr

Use with powershell core:

$ watchexec --shell=pwsh -- Test-Connection localhost

Use with CMD.exe:

$ watchexec --shell=cmd -- dir

Use with a different unix shell:

$ watchexec --shell=bash -- 'echo $BASH_VERSION'

Use with a unix shell and options:

$ watchexec --shell='zsh -x -o shwordsplit' -- scr

-n

Shorthand for '--shell=none'

--emit-events-to <MODE>

Configure event emission

Watchexec can emit event information when running a command, which can be used by the child process to target specific changed files.

One thing to take care with is assuming inherent behaviour where there is only chance. Notably, it could appear as if the `RENAMED` variable contains both the original and the new path being renamed. In previous versions, it would even appear on some platforms as if the original always came before the new. However, none of this was true. It's impossible to reliably and portably know which changed path is the old or new, "half" renames may appear (only the original, only the new), "unknown" renames may appear (change was a rename, but whether it was the old or new isn't known), rename events might split across two debouncing boundaries, and so on.

This option controls where that information is emitted. It defaults to 'none', which doesn't emit event information at all. The other options are 'environment' (deprecated), 'stdio', 'file', 'json-stdio', and 'json-file'.

The 'stdio' and 'file' modes are text-based: 'stdio' writes absolute paths to the stdin of the command, one per line, each prefixed with `create:`, `remove:`, `rename:`, `modify:`, or `other:`, then closes the handle; 'file' writes the same thing to a temporary file, and its path is given with the $WATCHEXEC_EVENTS_FILE environment variable.

There are also two JSON modes, which are based on JSON objects and can represent the full set of events Watchexec handles. Here's an example of a folder being created on Linux:

```json
{
"tags": [
{
"kind": "path",
"absolute": "/home/user/your/new-folder",
"filetype": "dir"
},
{
"kind": "fs",
"simple": "create",
"full": "Create(Folder)"
},
{
"kind": "source",
"source": "filesystem",
}
],
"metadata": {
"notify-backend": "inotify"
}
} ```

The fields are as follows:

- `tags`, structured event data.
- `tags[].kind`, which can be:
* 'path', along with:
+ `absolute`, an absolute path.
+ `filetype`, a file type if known ('dir', 'file', 'symlink', 'other').
* 'fs':
+ `simple`, the "simple" event type ('access', 'create', 'modify', 'remove', or 'other').
+ `full`, the "full" event type, which is too complex to fully describe here, but looks like 'General(Precise(Specific))'.
* 'source', along with:
+ `source`, the source of the event ('filesystem', 'keyboard', 'mouse', 'os', 'time', 'internal').
* 'keyboard', along with:
+ `keycode`. Currently only the value 'eof' is supported.
* 'process', for events caused by processes:
+ `pid`, the process ID.
* 'signal', for signals sent to Watchexec:
+ `signal`, the normalised signal name ('hangup', 'interrupt', 'quit', 'terminate', 'user1', 'user2').
* 'completion', for when a command ends:
+ `disposition`, the exit disposition ('success', 'error', 'signal', 'stop', 'exception', 'continued').
+ `code`, the exit, signal, stop, or exception code.
- `metadata`, additional information about the event.

The 'json-stdio' mode will emit JSON events to the standard input of the command, one per line, then close stdin. The 'json-file' mode will create a temporary file, write the events to it, and provide the path to the file with the $WATCHEXEC_EVENTS_FILE environment variable.

Finally, the 'environment' mode was the default until 2.0. It sets environment variables with the paths of the affected files, for filesystem events:

$WATCHEXEC_COMMON_PATH is set to the longest common path of all of the below variables, and so should be prepended to each path to obtain the full/real path. Then:

- $WATCHEXEC_CREATED_PATH is set when files/folders were created
- $WATCHEXEC_REMOVED_PATH is set when files/folders were removed
- $WATCHEXEC_RENAMED_PATH is set when files/folders were renamed
- $WATCHEXEC_WRITTEN_PATH is set when files/folders were modified
- $WATCHEXEC_META_CHANGED_PATH is set when files/folders' metadata were modified
- $WATCHEXEC_OTHERWISE_CHANGED_PATH is set for every other kind of pathed event

Multiple paths are separated by the system path separator, ';' on Windows and ':' on unix. Within each variable, paths are deduplicated and sorted in binary order (i.e. neither Unicode nor locale aware).

This is the legacy mode, is deprecated, and will be removed in the future. The environment is a very restricted space, while also limited in what it can usefully represent. Large numbers of files will either cause the environment to be truncated, or may error or crash the process entirely. The $WATCHEXEC_COMMON_PATH is also unintuitive, as demonstrated by the multiple confused queries that have landed in my inbox over the years.

Default: none

--only-emit-events

Only emit events to stdout, run no commands.

This is a convenience option for using Watchexec as a file watcher, without running any commands. It is almost equivalent to using `cat` as the command, except that it will not spawn a new process for each event.

This option requires `--emit-events-to` to be set, and restricts the available modes to `stdio` and `json-stdio`, modifying their behaviour to write to stdout instead of the stdin of the command.

-E, --env <KEY=VALUE>

Add env vars to the command

This is a convenience option for setting environment variables for the command, without setting them for the Watchexec process itself.

Use key=value syntax. Multiple variables can be set by repeating the option.

--wrap-process <MODE>

Configure how the process is wrapped

By default, Watchexec will run the command in a process group in Unix, and in a Job Object in Windows.

Some Unix programs prefer running in a session, while others do not work in a process group.

Use 'group' to use a process group, 'session' to use a process session, and 'none' to run the command directly. On Windows, either of 'group' or 'session' will use a Job Object.

Default: group

-N, --notify: Alert when commands start and end
With this, Watchexec will emit a desktop notification when a command starts and ends, on supported platforms. On unsupported platforms, it may silently do nothing, or log a warning.
--color <MODE>: When to use terminal colours
Setting the environment variable `NO_COLOR` to any value is equivalent to `--color=never`.

Default: auto

--timings

Print how long the command took to run

This may not be exactly accurate, as it includes some overhead from Watchexec itself. Use the `time` utility, high-precision timers, or benchmarking tools for more accurate results.

-q, --quiet

Don't print starting and stopping messages

By default Watchexec will print a message when the command starts and stops. This option disables this behaviour, so only the command's output, warnings, and errors will be printed.

--bell

Ring the terminal bell on command completion

--project-origin <DIRECTORY>

Set the project origin

Watchexec will attempt to discover the project's "origin" (or "root") by searching for a variety of markers, like files or directory patterns. It does its best but sometimes gets it it wrong, and you can override that with this option.

The project origin is used to determine the path of certain ignore files, which VCS is being used, the meaning of a leading '/' in filtering patterns, and maybe more in the future.

When set, Watchexec will also not bother searching, which can be significantly faster.

--workdir <DIRECTORY>

Set the working directory

By default, the working directory of the command is the working directory of Watchexec. You can change that with this option. Note that paths may be less intuitive to use with this.

-e, --exts <EXTENSIONS>

Filename extensions to filter to

This is a quick filter to only emit events for files with the given extensions. Extensions can be given with or without the leading dot (e.g. 'js' or '.js'). Multiple extensions can be given by repeating the option or by separating them with commas.

-f, --filter <PATTERN>

Filename patterns to filter to

Provide a glob-like filter pattern, and only events for files matching the pattern will be emitted. Multiple patterns can be given by repeating the option. Events that are not from files (e.g. signals, keyboard events) will pass through untouched.

--filter-file <PATH>

Files to load filters from

Provide a path to a file containing filters, one per line. Empty lines and lines starting with '#' are ignored. Uses the same pattern format as the '--filter' option.

This can also be used via the $WATCHEXEC_FILTER_FILES environment variable.

-J, --filter-prog <EXPRESSION>

[experimental] Filter programs.

/!\ This option is EXPERIMENTAL and may change and/or vanish without notice.

Provide your own custom filter programs in jaq (similar to jq) syntax. Programs are given an event in the same format as described in '--emit-events-to' and must return a boolean. Invalid programs will make watchexec fail to start; use '-v' to see program runtime errors.

In addition to the jaq stdlib, watchexec adds some custom filter definitions:

- 'path | file_meta' returns file metadata or null if the file does not exist.

- 'path | file_size' returns the size of the file at path, or null if it does not exist.

- 'path | file_read(bytes)' returns a string with the first n bytes of the file at path. If the file is smaller than n bytes, the whole file is returned. There is no filter to read the whole file at once to encourage limiting the amount of data read and processed.

- 'string | hash', and 'path | file_hash' return the hash of the string or file at path. No guarantee is made about the algorithm used: treat it as an opaque value.

- 'any | kv_store(key)', 'kv_fetch(key)', and 'kv_clear' provide a simple key-value store. Data is kept in memory only, there is no persistence. Consistency is not guaranteed.

- 'any | printout', 'any | printerr', and 'any | log(level)' will print or log any given value to stdout, stderr, or the log (levels = error, warn, info, debug, trace), and pass the value through (so '[1] | log("debug") | .[]' will produce a '1' and log '[1]').

All filtering done with such programs, and especially those using kv or filesystem access, is much slower than the other filtering methods. If filtering is too slow, events will back up and stall watchexec. Take care when designing your filters.

If the argument to this option starts with an '@', the rest of the argument is taken to be the path to a file containing a jaq program.

Jaq programs are run in order, after all other filters, and short-circuit: if a filter (jaq or not) rejects an event, execution stops there, and no other filters are run. Additionally, they stop after outputting the first value, so you'll want to use 'any' or 'all' when iterating, otherwise only the first item will be processed, which can be quite confusing!

Find user-contributed programs or submit your own useful ones at <https://github.com/watchexec/watchexec/discussions/592>.

## Examples:

Regexp ignore filter on paths:

'all(.tags[] | select(.kind == "path"); .absolute | test("[.]test[.]js$")) | not'

Pass any event that creates a file:

'any(.tags[] | select(.kind == "fs"); .simple == "create")'

Pass events that touch executable files:

'any(.tags[] | select(.kind == "path" && .filetype == "file"); .absolute | metadata | .executable)'

Ignore files that start with shebangs:

'any(.tags[] | select(.kind == "path" && .filetype == "file"); .absolute | read(2) == "#!") | not'

-i, --ignore <PATTERN>

Filename patterns to filter out

Provide a glob-like filter pattern, and events for files matching the pattern will be excluded. Multiple patterns can be given by repeating the option. Events that are not from files (e.g. signals, keyboard events) will pass through untouched.

--ignore-file <PATH>

Files to load ignores from

Provide a path to a file containing ignores, one per line. Empty lines and lines starting with '#' are ignored. Uses the same pattern format as the '--ignore' option.

This can also be used via the $WATCHEXEC_IGNORE_FILES environment variable.

--fs-events <EVENTS>

Filesystem events to filter to

This is a quick filter to only emit events for the given types of filesystem changes. Choose from 'access', 'create', 'remove', 'rename', 'modify', 'metadata'. Multiple types can be given by repeating the option or by separating them with commas. By default, this is all types except for 'access'.

This may apply filtering at the kernel level when possible, which can be more efficient, but may be more confusing when reading the logs.

Default: create,remove,rename,modify,metadata

--no-meta

Don't emit fs events for metadata changes

This is a shorthand for '--fs-events create,remove,rename,modify'. Using it alongside the '--fs-events' option is non-sensical and not allowed.

--print-events

Print events that trigger actions

This prints the events that triggered the action when handling it (after debouncing), in a human readable form. This is useful for debugging filters.

Use '-vvv' instead when you need more diagnostic information.

--manual

Show the manual page

This shows the manual page for Watchexec, if the output is a terminal and the 'man' program is available. If not, the manual page is printed to stdout in ROFF format (suitable for writing to a watchexec.1 file). Arguments:

<TASK>

Tasks to run Can specify multiple tasks by separating with `:::` e.g.: `mise run task1 arg1 arg2 ::: task2 arg1 arg2`

<ARGS>

Task and arguments to run

MISE WHERE

Display the installation path for a tool

The tool must be installed for this to work.

Usage: mise where <TOOL@VERSION> [<ASDF_VERSION>]

Arguments:

<TOOL@VERSION>: Tool(s) to look up e.g.: ruby@3 if "@<PREFIX>" is specified, it will show the latest installed version that matches the prefix otherwise, it will show the current, active installed version
<ASDF_VERSION>: the version prefix to use when querying the latest version same as the first argument after the "@" used for asdf compatibility

MISE WHICH

Shows the path that a tool's bin points to.

Use this to figure out what version of a tool is currently active.

Usage: mise which [OPTIONS] [<BIN_NAME>]

Options:

-t, --tool <TOOL@VERSION>: Use a specific tool@version e.g.: `mise which npm --tool=node@20`
--complete
--plugin: Show the plugin name instead of the path
--version: Show the version instead of the path Arguments:
<BIN_NAME>: The bin to look up