.TH MISE 1
.SH NAME
mise \- The front\-end to your dev env
.SH SYNOPSIS
\fBmise\fR [OPTIONS] [<TASK>] [<TASK_ARGS>] ... [<TASK_ARGS_LAST>] ... [COMMAND]
.SH DESCRIPTION
mise manages dev tools, env vars, and runs tasks. https://github.com/jdx/mise
.PP
.SH OPTIONS
.TP
\fB\-c, \-\-continue\-on\-error\fR
Continue running tasks even if one fails
.TP
\fB\-C, \-\-cd\fR \fI<DIR>\fR
Change directory before running command
.TP
\fB\-E, \-\-env\fR \fI<ENV>\fR
Set the environment for loading `mise.<ENV>.toml`
.TP
\fB\-f, \-\-force\fR
Force the operation
.TP
\fB\-i, \-\-interleave\fR
Set the log output verbosity
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
How many jobs to run in parallel [default: 8]
.TP
\fB\-n, \-\-dry\-run\fR
Dry run, don't actually do anything
.TP
\fB\-p, \-\-prefix\fR
.TP
\fB\-P, \-\-profile\fR \fI<PROFILE>\fR
Set the profile (environment)
.TP
\fB\-q, \-\-quiet\fR
Suppress non\-error messages
.TP
\fB\-s, \-\-shell\fR \fI<SHELL>\fR
.TP
\fB\-t, \-\-tool\fR \fI<TOOL@VERSION>\fR
Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10
.TP
\fB\-v, \-\-verbose\fR
Show extra output (use \-vv for even more)
.TP
\fB\-V, \-\-version\fR
.TP
\fB\-y, \-\-yes\fR
Answer yes to all confirmation prompts
.TP
\fB\-\-debug\fR
Sets log level to debug
.TP
\fB\-\-log\-level\fR \fI<LEVEL>\fR
.TP
\fB\-\-no\-config\fR
Do not load any config files

Can also use `MISE_NO_CONFIG=1`
.TP
\fB\-\-no\-env\fR
Do not load environment variables from config files

Can also use `MISE_NO_ENV=1`
.TP
\fB\-\-no\-hooks\fR
Do not execute hooks from config files

Can also use `MISE_NO_HOOKS=1`
.TP
\fB\-\-no\-timings\fR
Hides elapsed time after each task completes

Default to always hide with `MISE_TASK_TIMINGS=0`
.TP
\fB\-\-output\fR \fI<OUTPUT>\fR
.TP
\fB\-\-raw\fR
Read/write directly to stdin/stdout/stderr instead of by line
.TP
\fB\-\-locked\fR
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
.TP
\fB\-\-silent\fR
Suppress all task output and mise non\-error messages
.TP
\fB\-\-timings\fR
Shows elapsed time after each task completes

Default to always show with `MISE_TASK_TIMINGS=1`
.TP
\fB\-\-trace\fR
Sets log level to trace
.SH ARGUMENTS
.TP
\fB<TASK>\fR
Task to run.

Shorthand for `mise tasks run <TASK>`.
.TP
\fB<TASK_ARGS>\fR
Task arguments
.SH COMMANDS
.TP
\fBactivate\fR
Initializes mise in the current shell session
.TP
\fBtool\-alias\fR
Manage tool version aliases.
.TP
\fBtool\-alias get\fR
Show an alias for a plugin
.TP
\fBtool\-alias ls\fR
List tool version aliases
.RS
\fIAliases: \fRlist
.RE
.TP
\fBtool\-alias set\fR
Add/update an alias for a backend/plugin
.RS
\fIAliases: \fRadd, create
.RE
.TP
\fBtool\-alias unset\fR
Clears an alias for a backend/plugin
.RS
\fIAliases: \fRrm, remove, delete, del
.RE
.TP
\fBbackends\fR
Manage backends
.RS
\fIAliases: \fRb
.RE
.TP
\fBbackends ls\fR
List built\-in backends
.RS
\fIAliases: \fRlist
.RE
.TP
\fBbin\-paths\fR
List all the active runtime bin paths
.TP
\fBcache\fR
Manage the mise cache
.TP
\fBcache clear\fR
Deletes all cache files in mise
.RS
\fIAliases: \fRc
.RE
.TP
\fBcache path\fR
Show the cache directory path
.RS
\fIAliases: \fRdir
.RE
.TP
\fBcache prune\fR
Removes stale mise cache files
.RS
\fIAliases: \fRp
.RE
.TP
\fBcompletion\fR
Generate shell completions
.TP
\fBconfig\fR
Manage config files
.RS
\fIAliases: \fRcfg
.RE
.TP
\fBconfig generate\fR
Generate a mise.toml file
.RS
\fIAliases: \fRg
.RE
.TP
\fBconfig get\fR
Display the value of a setting in a mise.toml file
.TP
\fBconfig ls\fR
List config files currently in use
.RS
\fIAliases: \fRlist
.RE
.TP
\fBconfig set\fR
Set the value of a setting in a mise.toml file
.TP
\fBdeactivate\fR
Disable mise for current shell session
.TP
\fBdoctor\fR
Check mise installation for possible problems
.RS
\fIAliases: \fRdr
.RE
.TP
\fBdoctor path\fR
Print the current PATH entries mise is providing
.TP
\fBen\fR
Starts a new shell with the mise environment built from the current configuration
.TP
\fBenv\fR
Exports env vars to activate mise a single time
.RS
\fIAliases: \fRe
.RE
.TP
\fBexec\fR
Execute a command with tool(s) set
.RS
\fIAliases: \fRx
.RE
.TP
\fBfmt\fR
Formats mise.toml
.TP
\fBgenerate\fR
Generate files for various tools/services
.RS
\fIAliases: \fRgen
.RE
.TP
\fBgenerate bootstrap\fR
Generate a script to download+execute mise
.TP
\fBgenerate config\fR
[experimental] Generate a mise.toml file
.RS
\fIAliases: \fRg
.RE
.TP
\fBgenerate devcontainer\fR
Generate a devcontainer to execute mise
.TP
\fBgenerate git\-pre\-commit\fR
Generate a git pre\-commit hook
.RS
\fIAliases: \fRpre\-commit
.RE
.TP
\fBgenerate github\-action\fR
Generate a GitHub Action workflow file
.TP
\fBgenerate task\-docs\fR
Generate documentation for tasks in a project
.TP
\fBgenerate task\-stubs\fR
Generates shims to run mise tasks
.TP
\fBgenerate tool\-stub\fR
Generate a tool stub for HTTP\-based tools
.TP
\fBimplode\fR
Removes mise CLI and all related data
.TP
\fBinstall\fR
Install a tool version
.RS
\fIAliases: \fRi
.RE
.TP
\fBinstall\-into\fR
Install a tool version to a specific path
.TP
\fBlatest\fR
Gets the latest available version for a plugin
.TP
\fBlink\fR
Symlinks a tool version into mise
.RS
\fIAliases: \fRln
.RE
.TP
\fBlock\fR
Update lockfile checksums and URLs for all specified platforms
.TP
\fBls\fR
List installed and active tool versions
.RS
\fIAliases: \fRlist
.RE
.TP
\fBls\-remote\fR
List runtime versions available for install.
.TP
\fBmcp\fR
[experimental] Run Model Context Protocol (MCP) server
.TP
\fBoutdated\fR
Shows outdated tool versions
.TP
\fBplugins\fR
Manage plugins
.RS
\fIAliases: \fRp
.RE
.TP
\fBplugins install\fR
Install a plugin
.RS
\fIAliases: \fRi, a, add
.RE
.TP
\fBplugins link\fR
Symlinks a plugin into mise
.RS
\fIAliases: \fRln
.RE
.TP
\fBplugins ls\fR
List installed plugins
.RS
\fIAliases: \fRlist
.RE
.TP
\fBplugins ls\-remote\fR

.RS
\fIAliases: \fRlist\-remote, list\-all
.RE
.TP
\fBplugins uninstall\fR
Removes a plugin
.RS
\fIAliases: \fRremove, rm
.RE
.TP
\fBplugins update\fR
Updates a plugin to the latest version
.RS
\fIAliases: \fRup, upgrade
.RE
.TP
\fBprepare\fR
[experimental] Ensure project dependencies are ready
.RS
\fIAliases: \fRprep
.RE
.TP
\fBprune\fR
Delete unused versions of tools
.TP
\fBregistry\fR
List available tools to install
.TP
\fBreshim\fR
Creates new shims based on bin paths from currently installed tools.
.TP
\fBrun\fR
Run task(s)
.RS
\fIAliases: \fRr
.RE
.TP
\fBsearch\fR
Search for tools in the registry
.TP
\fBself\-update\fR
Updates mise itself.
.TP
\fBset\fR
Set environment variables in mise.toml
.TP
\fBsettings\fR
Show current settings
.TP
\fBsettings add\fR
Adds a setting to the configuration file
.TP
\fBsettings get\fR
Show a current setting
.TP
\fBsettings ls\fR
Show current settings
.RS
\fIAliases: \fRlist
.RE
.TP
\fBsettings set\fR
Add/update a setting
.RS
\fIAliases: \fRcreate
.RE
.TP
\fBsettings unset\fR
Clears a setting
.RS
\fIAliases: \fRrm, remove, delete, del
.RE
.TP
\fBshell\fR
Sets a tool version for the current session.
.RS
\fIAliases: \fRsh
.RE
.TP
\fBshell\-alias\fR
Manage shell aliases.
.TP
\fBshell\-alias get\fR
Show the command for a shell alias
.TP
\fBshell\-alias ls\fR
List shell aliases
.RS
\fIAliases: \fRlist
.RE
.TP
\fBshell\-alias set\fR
Add/update a shell alias
.RS
\fIAliases: \fRadd, create
.RE
.TP
\fBshell\-alias unset\fR
Removes a shell alias
.RS
\fIAliases: \fRrm, remove, delete, del
.RE
.TP
\fBsync\fR
Synchronize tools from other version managers with mise
.TP
\fBsync node\fR
Symlinks all tool versions from an external tool into mise
.TP
\fBsync python\fR
Symlinks all tool versions from an external tool into mise
.TP
\fBsync ruby\fR
Symlinks all ruby tool versions from an external tool into mise
.TP
\fBtasks\fR
Manage tasks
.RS
\fIAliases: \fRt
.RE
.TP
\fBtasks add\fR
Create a new task
.TP
\fBtasks deps\fR
Display a tree visualization of a dependency graph
.TP
\fBtasks edit\fR
Edit a task with $EDITOR
.TP
\fBtasks info\fR
Get information about a task
.TP
\fBtasks ls\fR
List available tasks to execute
.TP
\fBtasks run\fR
Run task(s)
.RS
\fIAliases: \fRr
.RE
.TP
\fBtasks validate\fR
Validate tasks for common errors and issues
.TP
\fBtest\-tool\fR
Test a tool installs and executes
.TP
\fBtool\fR
Gets information about a tool
.TP
\fBtool\-stub\fR
Execute a tool stub
.TP
\fBtrust\fR
Marks a config file as trusted
.TP
\fBuninstall\fR
Removes installed tool versions
.TP
\fBunset\fR
Remove environment variable(s) from the config file.
.TP
\fBunuse\fR
Removes installed tool versions from mise.toml
.RS
\fIAliases: \fRrm, remove
.RE
.TP
\fBupgrade\fR
Upgrades outdated tools
.RS
\fIAliases: \fRup
.RE
.TP
\fBuse\fR
Installs a tool and adds the version to mise.toml.
.RS
\fIAliases: \fRu
.RE
.TP
\fBversion\fR
Display the version of mise
.RS
\fIAliases: \fRv
.RE
.TP
\fBwatch\fR
Run task(s) and watch for changes to rerun it
.RS
\fIAliases: \fRw
.RE
.TP
\fBwhere\fR
Display the installation path for a tool
.TP
\fBwhich\fR
Shows the path that a tool's bin points to.
.SH "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.
.PP
\fBUsage:\fR mise activate [OPTIONS] [<SHELL_TYPE>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-q, \-\-quiet\fR
Suppress non\-error messages
.TP
\fB\-s, \-\-shell\fR \fI<SHELL>\fR
Shell type to generate the script for
.TP
\fB\-\-no\-hook\-env\fR
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.
.TP
\fB\-\-shims\fR
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.jdx.dev/dev\-tools/shims.html#shims\-vs\-path for more information
.TP
\fB\-\-status\fR
Show "mise: <PLUGIN>@<VERSION>" message when changing directories
\fBArguments:\fR
.PP
.TP
\fB<SHELL_TYPE>\fR
Shell type to generate the script for
.SH "MISE TOOL-ALIAS"
Manage tool version aliases.
.PP
\fBUsage:\fR mise tool\-alias [OPTIONS] [COMMAND]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-p, \-\-plugin\fR \fI<PLUGIN>\fR
filter aliases by plugin
.TP
\fB\-\-no\-header\fR
Don't show table header
.SH "MISE TOOL-ALIAS GET"
Show an alias for a plugin

This is the contents of a tool_alias.<PLUGIN> entry in ~/.config/mise/config.toml
.PP
\fBUsage:\fR mise tool\-alias get <PLUGIN> <ALIAS>
.PP
\fBArguments:\fR
.PP
.TP
\fB<PLUGIN>\fR
The plugin to show the alias for
.TP
\fB<ALIAS>\fR
The alias to show
.SH "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"
.PP
\fBUsage:\fR mise tool\-alias ls [OPTIONS] [<TOOL>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-no\-header\fR
Don't show table header
\fBArguments:\fR
.PP
.TP
\fB<TOOL>\fR
Show aliases for <TOOL>
.SH "MISE TOOL-ALIAS SET"
Add/update an alias for a backend/plugin

This modifies the contents of ~/.config/mise/config.toml
.PP
\fBUsage:\fR mise tool\-alias set <PLUGIN> <ALIAS> [<VALUE>]
.PP
\fBArguments:\fR
.PP
.TP
\fB<PLUGIN>\fR
The backend/plugin to set the alias for
.TP
\fB<ALIAS>\fR
The alias to set
.TP
\fB<VALUE>\fR
The value to set the alias to
.SH "MISE TOOL-ALIAS UNSET"
Clears an alias for a backend/plugin

This modifies the contents of ~/.config/mise/config.toml
.PP
\fBUsage:\fR mise tool\-alias unset <PLUGIN> [<ALIAS>]
.PP
\fBArguments:\fR
.PP
.TP
\fB<PLUGIN>\fR
The backend/plugin to remove the alias from
.TP
\fB<ALIAS>\fR
The alias to remove
.SH "MISE BIN-PATHS"
List all the active runtime bin paths
.PP
\fBUsage:\fR mise bin\-paths [<TOOL@VERSION>] ...
.PP
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool(s) to look up
e.g.: ruby@3
.SH "MISE CACHE CLEAR"
Deletes all cache files in mise
.PP
\fBUsage:\fR mise cache clear [OPTIONS] [<PLUGIN>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-outdate\fR
Mark all cache files as old
\fBArguments:\fR
.PP
.TP
\fB<PLUGIN>\fR
Plugin(s) to clear cache for e.g.: node, python
.SH "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.
.PP
\fBUsage:\fR mise cache prune [OPTIONS] [<PLUGIN>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-v, \-\-verbose\fR
Show pruned files
.TP
\fB\-\-dry\-run\fR
Just show what would be pruned
\fBArguments:\fR
.PP
.TP
\fB<PLUGIN>\fR
Plugin(s) to clear cache for e.g.: node, python
.SH "MISE COMPLETION"
Generate shell completions
.PP
\fBUsage:\fR mise completion [OPTIONS] [<SHELL>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-s, \-\-shell\fR \fI<SHELL_TYPE>\fR
Shell type to generate completions for
.TP
\fB\-\-include\-bash\-completion\-lib\fR
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.
.TP
\fB\-\-usage\fR
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
\fBArguments:\fR
.PP
.TP
\fB<SHELL>\fR
Shell type to generate completions for
.SH "MISE CONFIG"
Manage config files
.PP
\fBUsage:\fR mise config [OPTIONS] [COMMAND]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-\-no\-header\fR
Do not print table header
.TP
\fB\-\-tracked\-configs\fR
List all tracked config files
.SH "MISE CONFIG GENERATE"
Generate a mise.toml file
.PP
\fBUsage:\fR mise config generate [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-o, \-\-output\fR \fI<OUTPUT>\fR
Output to file instead of stdout
.TP
\fB\-t, \-\-tool\-versions\fR \fI<TOOL_VERSIONS>\fR
Path to a .tool\-versions file to import tools from
.SH "MISE CONFIG GET"
Display the value of a setting in a mise.toml file
.PP
\fBUsage:\fR mise config get [OPTIONS] [<KEY>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-file\fR \fI<FILE>\fR
The path to the mise.toml file to edit

If not provided, the nearest mise.toml file will be used
\fBArguments:\fR
.PP
.TP
\fB<KEY>\fR
The path of the config to display
.SH "MISE CONFIG LS"
List config files currently in use
.PP
\fBUsage:\fR mise config ls [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-\-no\-header\fR
Do not print table header
.TP
\fB\-\-tracked\-configs\fR
List all tracked config files
.SH "MISE CONFIG SET"
Set the value of a setting in a mise.toml file
.PP
\fBUsage:\fR mise config set [OPTIONS] <KEY> <VALUE>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-file\fR \fI<FILE>\fR
The path to the mise.toml file to edit

If not provided, the nearest mise.toml file will be used
.TP
\fB\-t, \-\-type\fR \fI<TYPE>\fR
.RS
\fIDefault: \fRinfer
.RE
\fBArguments:\fR
.PP
.TP
\fB<KEY>\fR
The path of the config to display
.TP
\fB<VALUE>\fR
The value to set the key to
.SH "MISE DOCTOR"
Check mise installation for possible problems
.PP
\fBUsage:\fR mise doctor [OPTIONS] [COMMAND]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-J, \-\-json\fR
.SH "MISE DOCTOR PATH"
Print the current PATH entries mise is providing
.PP
\fBUsage:\fR mise doctor path [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-full\fR
Print all entries including those not provided by mise
.SH "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.
.PP
\fBUsage:\fR mise en [OPTIONS] [<DIR>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-s, \-\-shell\fR \fI<SHELL>\fR
Shell to start

Defaults to $SHELL
\fBArguments:\fR
.PP
.TP
\fB<DIR>\fR
Directory to start the shell in
.RS
\fIDefault: \fR.
.RE
.SH "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.
.PP
\fBUsage:\fR mise env [OPTIONS] [<TOOL@VERSION>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-D, \-\-dotenv\fR
Output in dotenv format
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-s, \-\-shell\fR \fI<SHELL>\fR
Shell type to generate environment variables for
.TP
\fB\-\-json\-extended\fR
Output in JSON format with additional information (source, tool)
.TP
\fB\-\-redacted\fR
Only show redacted environment variables
.TP
\fB\-\-values\fR
Only show values of environment variables
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool(s) to use
.SH "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.
.PP
\fBUsage:\fR mise exec [OPTIONS] [<TOOL@VERSION>] ... [<COMMAND>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-c, \-\-command\fR \fI<C>\fR
Command string to execute
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
[default: 4]
.TP
\fB\-\-fresh\-env\fR
Bypass the environment cache and recompute the environment
.TP
\fB\-\-no\-prepare\fR
Skip automatic dependency preparation
.TP
\fB\-\-raw\fR
Directly pipe stdin/stdout/stderr from plugin to user Sets \-\-jobs=1
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool(s) to start e.g.: node@20 python@3.10
.TP
\fB<COMMAND>\fR
Command string to execute (same as \-\-command)
.SH "MISE FMT"
Formats mise.toml

Sorts keys and cleans up whitespace in mise.toml
.PP
\fBUsage:\fR mise fmt [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
Format all files from the current directory
.TP
\fB\-c, \-\-check\fR
Check if the configs are formatted, no formatting is done
.TP
\fB\-s, \-\-stdin\fR
Read config from stdin and write its formatted version into stdout
.SH "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.
.PP
\fBUsage:\fR mise generate bootstrap [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-l, \-\-localize\fR
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.
.TP
\fB\-V, \-\-version\fR \fI<VERSION>\fR
Specify mise version to fetch
.TP
\fB\-w, \-\-write\fR \fI<WRITE>\fR
instead of outputting the script to stdout, write to a file and make it executable
.TP
\fB\-\-localized\-dir\fR \fI<LOCALIZED_DIR>\fR
Directory to put localized data into
.RS
\fIDefault: \fR.mise
.RE
.SH "MISE GENERATE CONFIG"
[experimental] Generate a mise.toml file
.PP
\fBUsage:\fR mise generate config [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-o, \-\-output\fR \fI<OUTPUT>\fR
Output to file instead of stdout
.TP
\fB\-t, \-\-tool\-versions\fR \fI<TOOL_VERSIONS>\fR
Path to a .tool\-versions file to import tools from
.SH "MISE GENERATE DEVCONTAINER"
Generate a devcontainer to execute mise
.PP
\fBUsage:\fR mise generate devcontainer [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-i, \-\-image\fR \fI<IMAGE>\fR
The image to use for the devcontainer
.TP
\fB\-m, \-\-mount\-mise\-data\fR
Bind the mise\-data\-volume to the devcontainer
.TP
\fB\-n, \-\-name\fR \fI<NAME>\fR
The name of the devcontainer
.TP
\fB\-w, \-\-write\fR
write to .devcontainer/devcontainer.json
.SH "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/
.PP
\fBUsage:\fR mise generate git\-pre\-commit [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-t, \-\-task\fR \fI<TASK>\fR
The task to run when the pre\-commit hook is triggered
.RS
\fIDefault: \fRpre\-commit
.RE
.TP
\fB\-w, \-\-write\fR
write to .git/hooks/pre\-commit and make it executable
.TP
\fB\-\-hook\fR \fI<HOOK>\fR
Which hook to generate (saves to .git/hooks/$hook)
.RS
\fIDefault: \fRpre\-commit
.RE
.SH "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.
.PP
\fBUsage:\fR mise generate github\-action [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-t, \-\-task\fR \fI<TASK>\fR
The task to run when the workflow is triggered
.RS
\fIDefault: \fRci
.RE
.TP
\fB\-w, \-\-write\fR
write to .github/workflows/$name.yml
.TP
\fB\-\-name\fR \fI<NAME>\fR
the name of the workflow to generate
.RS
\fIDefault: \fRci
.RE
.SH "MISE GENERATE TASK-DOCS"
Generate documentation for tasks in a project
.PP
\fBUsage:\fR mise generate task\-docs [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-i, \-\-inject\fR
inserts the documentation into an existing file

This will look for a special comment, `<!\-\- mise\-tasks \-\->`, and replace it with the generated documentation.
It will replace everything between the comment and the next comment, `<!\-\- /mise\-tasks \-\->` so it can be
run multiple times on the same file to update the documentation.
.TP
\fB\-I, \-\-index\fR
write only an index of tasks, intended for use with `\-\-multi`
.TP
\fB\-m, \-\-multi\fR
render each task as a separate document, requires `\-\-output` to be a directory
.TP
\fB\-o, \-\-output\fR \fI<OUTPUT>\fR
writes the generated docs to a file/directory
.TP
\fB\-r, \-\-root\fR \fI<ROOT>\fR
root directory to search for tasks
.TP
\fB\-s, \-\-style\fR \fI<STYLE>\fR
.RS
\fIDefault: \fRsimple
.RE
.SH "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.
.PP
\fBUsage:\fR mise generate task\-stubs [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-d, \-\-dir\fR \fI<DIR>\fR
Directory to create task stubs inside of
.RS
\fIDefault: \fRbin
.RE
.TP
\fB\-m, \-\-mise\-bin\fR \fI<MISE_BIN>\fR
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`
.RS
\fIDefault: \fRmise
.RE
.SH "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.
.PP
\fBUsage:\fR mise generate tool\-stub [OPTIONS] <OUTPUT>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-b, \-\-bin\fR \fI<BIN>\fR
Binary path within the extracted archive

If not specified and the archive is downloaded, will auto\-detect the most likely binary
.TP
\fB\-\-bootstrap\fR
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
.TP
\fB\-\-bootstrap\-version\fR \fI<BOOTSTRAP_VERSION>\fR
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").
.TP
\fB\-\-fetch\fR
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.
.TP
\fB\-\-http\fR \fI<HTTP>\fR
HTTP backend type to use
.RS
\fIDefault: \fRhttp
.RE
.TP
\fB\-\-platform\-bin\fR \fI<PLATFORM_BIN>\fR
Platform\-specific binary paths in the format platform:path

Examples: \-\-platform\-bin windows\-x64:tool.exe \-\-platform\-bin linux\-x64:bin/tool
.TP
\fB\-\-platform\-url\fR \fI<PLATFORM_URL>\fR
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
.TP
\fB\-\-skip\-download\fR
Skip downloading for checksum and binary path detection (faster but less informative)
.TP
\fB\-u, \-\-url\fR \fI<URL>\fR
URL for downloading the tool

Example: https://github.com/owner/repo/releases/download/v2.0.0/tool\-linux\-x64.tar.gz
.TP
\fB\-\-version\fR \fI<VERSION>\fR
Version of the tool
.RS
\fIDefault: \fRlatest
.RE
\fBArguments:\fR
.PP
.TP
\fB<OUTPUT>\fR
Output file path for the tool stub
.SH "MISE IMPLODE"
Removes mise CLI and all related data

Skips config directory by default.
.PP
\fBUsage:\fR mise implode [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-n, \-\-dry\-run\fR
List directories that would be removed without actually removing them
.TP
\fB\-\-config\fR
Also remove config directory
.SH "MISE INSTALL"
Install a tool version

Installs a tool version to `~/.local/share/mise/installs/<PLUGIN>/<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`
.PP
\fBUsage:\fR mise install [OPTIONS] [<TOOL@VERSION>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-force\fR
Force reinstall even if already installed
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
[default: 4]
.TP
\fB\-n, \-\-dry\-run\fR
Show what would be installed without actually installing
.TP
\fB\-v, \-\-verbose\fR
Show installation output

This argument will print plugin output such as download, configuration, and compilation output.
.TP
\fB\-\-before\fR \fI<BEFORE>\fR
Only install versions released before this date

Supports absolute dates like "2024\-06\-01" and relative durations like "90d" or "1y".
.TP
\fB\-\-raw\fR
Directly pipe stdin/stdout/stderr from plugin to user Sets \-\-jobs=1
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool(s) to install e.g.: node@20
.SH "MISE INSTALL-INTO"
Install a tool version to a specific path

Used for building a tool to a directory for use outside of mise
.PP
\fBUsage:\fR mise install\-into <TOOL@VERSION> <PATH>
.PP
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool to install e.g.: node@20
.TP
\fB<PATH>\fR
Path to install the tool into
.SH "MISE LATEST"
Gets the latest available version for a plugin

Supports prefixes such as `node@20` to get the latest version of node 20.
.PP
\fBUsage:\fR mise latest [OPTIONS] <TOOL@VERSION> [<ASDF_VERSION>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-i, \-\-installed\fR
Show latest installed instead of available version
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool to get the latest version of
.TP
\fB<ASDF_VERSION>\fR
The version prefix to use when querying the latest version same as the first argument after the "@" used for asdf compatibility
.SH "MISE LINK"
Symlinks a tool version into mise

Use this for adding installs either custom compiled outside mise or built with a different tool.
.PP
\fBUsage:\fR mise link [OPTIONS] <TOOL@VERSION> <PATH>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-force\fR
Overwrite an existing tool version if it exists
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool name and version to create a symlink for
.TP
\fB<PATH>\fR
The local path to the tool version
e.g.: ~/.nvm/versions/node/v20.0.0
.SH "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.
.PP
\fBUsage:\fR mise lock [OPTIONS] [<TOOL>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
.TP
\fB\-n, \-\-dry\-run\fR
Show what would be updated without making changes
.TP
\fB\-p, \-\-platform\fR \fI<PLATFORM>\fR
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
.TP
\fB\-\-local\fR
Update mise.local.lock instead of mise.lock
Use for tools defined in .local.toml configs
\fBArguments:\fR
.PP
.TP
\fB<TOOL>\fR
Tool(s) to update in lockfile
e.g.: node python
If not specified, all tools in lockfile will be updated
.SH "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.
.PP
\fBUsage:\fR mise ls [OPTIONS] [<INSTALLED_TOOL>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-c, \-\-current\fR
Only show tool versions currently specified in a mise.toml
.TP
\fB\-g, \-\-global\fR
Only show tool versions currently specified in the global mise.toml
.TP
\fB\-i, \-\-installed\fR
Only show tool versions that are installed (Hides tools defined in mise.toml but not installed)
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-l, \-\-local\fR
Only show tool versions currently specified in the local mise.toml
.TP
\fB\-m, \-\-missing\fR
Display missing tool versions
.TP
\fB\-o, \-\-offline\fR
Don't fetch information such as outdated versions
.TP
\fB\-p, \-\-plugin\fR \fI<TOOL_FLAG>\fR
.TP
\fB\-\-no\-header\fR
Don't display headers
.TP
\fB\-\-outdated\fR
Display whether a version is outdated
.TP
\fB\-\-prefix\fR \fI<PREFIX>\fR
Display versions matching this prefix
.TP
\fB\-\-prunable\fR
List only tools that can be pruned with `mise prune`
\fBArguments:\fR
.PP
.TP
\fB<INSTALLED_TOOL>\fR
Only show tool versions from [TOOL]
.SH "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.
.PP
\fBUsage:\fR mise ls\-remote [OPTIONS] [<TOOL@VERSION>] [<PREFIX>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-all\fR
Show all installed plugins and versions
.TP
\fB\-J, \-\-json\fR
Output in JSON format (includes version metadata like created_at timestamps when available)
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool to get versions for
.TP
\fB<PREFIX>\fR
The version prefix to use when querying the latest version
same as the first argument after the "@"
.SH "MISE OUTDATED"
Shows outdated tool versions

See `mise upgrade` to upgrade these versions.
.PP
\fBUsage:\fR mise outdated [OPTIONS] [<TOOL@VERSION>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-l, \-\-bump\fR
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.
.TP
\fB\-\-no\-header\fR
Don't show table header
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
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
.SH "MISE PLUGINS"
Manage plugins
.PP
\fBUsage:\fR mise plugins [OPTIONS] [COMMAND]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
list all available remote plugins

same as `mise plugins ls\-remote`
.TP
\fB\-c, \-\-core\fR
The built\-in plugins only
Normally these are not shown
.TP
\fB\-u, \-\-urls\fR
Show the git url for each plugin
e.g.: https://github.com/asdf\-vm/asdf\-nodejs.git
.TP
\fB\-\-refs\fR
Show the git refs for each plugin
e.g.: main 1234abc
.TP
\fB\-\-user\fR
List installed plugins

This is the default behavior but can be used with \-\-core
to show core and user plugins
.SH "MISE PLUGINS INSTALL"
Install a plugin

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

This behavior can be modified in ~/.config/mise/config.toml
.PP
\fBUsage:\fR mise plugins install [OPTIONS] [<NEW_PLUGIN>] [<GIT_URL>] [<REST>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
Install all missing plugins
This will only install plugins that have matching shorthands.
i.e.: they don't need the full git repo url
.TP
\fB\-f, \-\-force\fR
Reinstall even if plugin exists
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
.TP
\fB\-v, \-\-verbose\fR
Show installation output
\fBArguments:\fR
.PP
.TP
\fB<NEW_PLUGIN>\fR
The name of the plugin to install
e.g.: node, ruby
Can specify multiple plugins: `mise plugins install node ruby python`
.TP
\fB<GIT_URL>\fR
The git url of the plugin
.SH "MISE PLUGINS LINK"
Symlinks a plugin into mise

This is used for developing a plugin.
.PP
\fBUsage:\fR mise plugins link [OPTIONS] <NAME> [<DIR>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-force\fR
Overwrite existing plugin
\fBArguments:\fR
.PP
.TP
\fB<NAME>\fR
The name of the plugin
e.g.: node, ruby
.TP
\fB<DIR>\fR
The local path to the plugin
e.g.: ./mise\-node
.SH "MISE PLUGINS LS"
List installed plugins

Can also show remotely available plugins to install.
.PP
\fBUsage:\fR mise plugins ls [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
List all available remote plugins
Same as `mise plugins ls\-remote`
.TP
\fB\-c, \-\-core\fR
The built\-in plugins only
Normally these are not shown
.TP
\fB\-u, \-\-urls\fR
Show the git url for each plugin
e.g.: https://github.com/asdf\-vm/asdf\-nodejs.git
.TP
\fB\-\-refs\fR
Show the git refs for each plugin
e.g.: main 1234abc
.TP
\fB\-\-user\fR
List installed plugins
.SH "MISE PLUGINS LS-REMOTE"

List all available remote plugins

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

Examples:

    $ mise plugins ls\-remote

.PP
\fBUsage:\fR mise plugins ls\-remote [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-u, \-\-urls\fR
Show the git url for each plugin e.g.: https://github.com/mise\-plugins/mise\-poetry.git
.TP
\fB\-\-only\-names\fR
Only show the name of each plugin by default it will show a "*" next to installed plugins
.SH "MISE PLUGINS UNINSTALL"
Removes a plugin
.PP
\fBUsage:\fR mise plugins uninstall [OPTIONS] [<PLUGIN>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
Remove all plugins
.TP
\fB\-p, \-\-purge\fR
Also remove the plugin's installs, downloads, and cache
\fBArguments:\fR
.PP
.TP
\fB<PLUGIN>\fR
Plugin(s) to remove
.SH "MISE PLUGINS UPDATE"
Updates a plugin to the latest version

note: this updates the plugin itself, not the runtime versions
.PP
\fBUsage:\fR mise plugins update [OPTIONS] [<PLUGIN>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
Default: 4
\fBArguments:\fR
.PP
.TP
\fB<PLUGIN>\fR
Plugin(s) to update
.SH "MISE PREPARE"
[experimental] Ensure project dependencies are ready

Runs all applicable prepare 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\-prepare flag.
.PP
\fBUsage:\fR mise prepare [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-force\fR
Force run all prepare steps even if outputs are fresh
.TP
\fB\-\-list\fR
Show what prepare steps are available
.TP
\fB\-n, \-\-dry\-run\fR
Only check if prepare is needed, don't run commands
.TP
\fB\-\-only\fR \fI<ONLY>\fR
Run specific prepare rule(s) only
.TP
\fB\-\-skip\fR \fI<SKIP>\fR
Skip specific prepare rule(s)
.SH "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_<PLUGIN>_VERSION` will be deleted,
as will versions only referenced on the command line `mise exec <PLUGIN>@<VERSION>`.

You can list prunable tools with `mise ls \-\-prunable`
.PP
\fBUsage:\fR mise prune [OPTIONS] [<INSTALLED_TOOL>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-n, \-\-dry\-run\fR
Do not actually delete anything
.TP
\fB\-\-configs\fR
Prune only tracked and trusted configuration links that point to non\-existent configurations
.TP
\fB\-\-tools\fR
Prune only unused versions of tools
\fBArguments:\fR
.PP
.TP
\fB<INSTALLED_TOOL>\fR
Prune only these tools
.SH "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`.
.PP
\fBUsage:\fR mise registry [OPTIONS] [<NAME>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-b, \-\-backend\fR \fI<BACKEND>\fR
Show only tools for this backend
.TP
\fB\-\-complete\fR
Print all tools with descriptions for shell completions
.TP
\fB\-\-hide\-aliased\fR
Hide aliased tools
.TP
\fB\-J, \-\-json\fR
Output in JSON format
\fBArguments:\fR
.PP
.TP
\fB<NAME>\fR
Show only the specified tool's full name
.SH "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 setup 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.
.PP
\fBUsage:\fR mise reshim [OPTIONS] [<PLUGIN>] [<VERSION>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-force\fR
Removes all shims before reshimming
.SH "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
.PP
\fBUsage:\fR mise run [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-c, \-\-continue\-on\-error\fR
Continue running tasks even if one fails
.TP
\fB\-C, \-\-cd\fR \fI<CD>\fR
Change to this directory before executing the command
.TP
\fB\-f, \-\-force\fR
Force the tasks to run even if outputs are up to date
.TP
\fB\-i, \-\-interleave\fR
Print directly to stdout/stderr instead of by line
Defaults to true if \-\-jobs == 1
Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of tasks to run in parallel
[default: 4]
Configure with `jobs` config or `MISE_JOBS` env var
.TP
\fB\-n, \-\-dry\-run\fR
Don't actually run the task(s), just print them in order of execution
.TP
\fB\-o, \-\-output\fR \fI<OUTPUT>\fR
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
.TP
\fB\-p, \-\-prefix\fR
Print stdout/stderr by line, prefixed with the task's label
Defaults to true if \-\-jobs > 1
Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
.TP
\fB\-q, \-\-quiet\fR
Don't show extra output
.TP
\fB\-r, \-\-raw\fR
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
.TP
\fB\-s, \-\-shell\fR \fI<SHELL>\fR
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.
.TP
\fB\-S, \-\-silent\fR
Don't show any output except for errors
.TP
\fB\-t, \-\-tool\fR \fI<TOOL@VERSION>\fR
Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10
.TP
\fB\-\-fresh\-env\fR
Bypass the environment cache and recompute the environment
.TP
\fB\-\-no\-cache\fR
Do not use cache on remote tasks
.TP
\fB\-\-no\-prepare\fR
Skip automatic dependency preparation
.TP
\fB\-\-no\-timings\fR
Hides elapsed time after each task completes

Default to always hide with `MISE_TASK_TIMINGS=0`
.TP
\fB\-\-skip\-deps\fR
Run only the specified tasks skipping all dependencies
.TP
\fB\-\-timeout\fR \fI<TIMEOUT>\fR
Timeout for the task to complete
e.g.: 30s, 5m
.TP
\fB\-\-timings\fR
Shows elapsed time after each task completes

Default to always show with `MISE_TASK_TIMINGS=1`
.SH "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.
.PP
\fBUsage:\fR mise search [OPTIONS] [<NAME>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-i, \-\-interactive\fR
Show interactive search
.TP
\fB\-m, \-\-match\-type\fR \fI<MATCH_TYPE>\fR
Match type: equal, contains, or fuzzy
.RS
\fIDefault: \fRfuzzy
.RE
.TP
\fB\-\-no\-header\fR
Don't display headers
\fBArguments:\fR
.PP
.TP
\fB<NAME>\fR
The tool to search for
.SH "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 the `GITHUB_API_TOKEN` environment variable if set for higher rate limits.

This command is not available if mise is installed via a package manager.
.PP
\fBUsage:\fR mise self\-update [OPTIONS] [<VERSION>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-force\fR
Update even if already up to date
.TP
\fB\-y, \-\-yes\fR
Skip confirmation prompt
.TP
\fB\-\-no\-plugins\fR
Disable auto\-updating plugins
\fBArguments:\fR
.PP
.TP
\fB<VERSION>\fR
Update to a specific version
.SH "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.jdx.dev/configuration.html#target\-file\-for\-write\-operations

Use `\-E <env>` to create/modify environment\-specific config files like `mise.<env>.toml`.
.PP
\fBUsage:\fR mise set [OPTIONS] [<ENV_VAR>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-E, \-\-env\fR \fI<ENV>\fR
Create/modify an environment\-specific config file like .mise.<env>.toml
.TP
\fB\-g, \-\-global\fR
Set the environment variable in the global config file
.TP
\fB\-\-age\-encrypt\fR
[experimental] Encrypt the value with age before storing
.TP
\fB\-\-age\-key\-file\fR \fI<PATH>\fR
[experimental] Age identity file for encryption

Defaults to ~/.config/mise/age.txt if it exists
.TP
\fB\-\-age\-recipient\fR \fI<RECIPIENT>\fR
[experimental] Age recipient (x25519 public key) for encryption

Can be used multiple times. Requires \-\-age\-encrypt.
.TP
\fB\-\-age\-ssh\-recipient\fR \fI<PATH_OR_PUBKEY>\fR
[experimental] SSH recipient (public key or path) for age encryption

Can be used multiple times. Requires \-\-age\-encrypt.
.TP
\fB\-\-complete\fR
Render completions
.TP
\fB\-\-file\fR \fI<FILE>\fR
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 environment variable, or `mise.toml`.
.TP
\fB\-\-prompt\fR
Prompt for environment variable values
.TP
\fB\-\-remove, \-\-rm, \-\-unset\fR \fI<ENV_KEY>\fR
Remove the environment variable from config file

Can be used multiple times.
\fBArguments:\fR
.PP
.TP
\fB<ENV_VAR>\fR
Environment variable(s) to set
e.g.: NODE_ENV=production
.SH "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`
.PP
\fBUsage:\fR mise settings [OPTIONS] [<SETTING>] [<VALUE>] [COMMAND]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
List all settings
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-l, \-\-local\fR
Use the local config file instead of the global one
.TP
\fB\-T, \-\-toml\fR
Output in TOML format
.TP
\fB\-\-complete\fR
Print all settings with descriptions for shell completions
.TP
\fB\-\-json\-extended\fR
Output in JSON format with sources
\fBArguments:\fR
.PP
.TP
\fB<SETTING>\fR
Name of setting
.TP
\fB<VALUE>\fR
Setting value to set
.SH "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
.PP
\fBUsage:\fR mise settings add [OPTIONS] <SETTING> <VALUE>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-l, \-\-local\fR
Use the local config file instead of the global one
\fBArguments:\fR
.PP
.TP
\fB<SETTING>\fR
The setting to set
.TP
\fB<VALUE>\fR
The value to set
.SH "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`
.PP
\fBUsage:\fR mise settings get [OPTIONS] <SETTING>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-l, \-\-local\fR
Use the local config file instead of the global one
\fBArguments:\fR
.PP
.TP
\fB<SETTING>\fR
The setting to show
.SH "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`
.PP
\fBUsage:\fR mise settings ls [OPTIONS] [<SETTING>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
List all settings
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-l, \-\-local\fR
Use the local config file instead of the global one
.TP
\fB\-T, \-\-toml\fR
Output in TOML format
.TP
\fB\-\-complete\fR
Print all settings with descriptions for shell completions
.TP
\fB\-\-json\-extended\fR
Output in JSON format with sources
\fBArguments:\fR
.PP
.TP
\fB<SETTING>\fR
Name of setting
.SH "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.jdx.dev/configuration.html#target\-file\-for\-write\-operations
.PP
\fBUsage:\fR mise settings set [OPTIONS] <SETTING> <VALUE>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-l, \-\-local\fR
Use the local config file instead of the global one
\fBArguments:\fR
.PP
.TP
\fB<SETTING>\fR
The setting to set
.TP
\fB<VALUE>\fR
The value to set
.SH "MISE SETTINGS UNSET"
Clears a setting

This modifies the contents of ~/.config/mise/config.toml
.PP
\fBUsage:\fR mise settings unset [OPTIONS] <KEY>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-l, \-\-local\fR
Use the local config file instead of the global one
\fBArguments:\fR
.PP
.TP
\fB<KEY>\fR
The setting to remove
.SH "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`.
.PP
\fBUsage:\fR mise shell [OPTIONS] <TOOL@VERSION> ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
[default: 4]
.TP
\fB\-u, \-\-unset\fR
Removes a previously set version
.TP
\fB\-\-raw\fR
Directly pipe stdin/stdout/stderr from plugin to user Sets \-\-jobs=1
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
Tool(s) to use
.SH "MISE SHELL-ALIAS"
Manage shell aliases.
.PP
\fBUsage:\fR mise shell\-alias [OPTIONS] [COMMAND]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-no\-header\fR
Don't show table header
.SH "MISE SHELL-ALIAS GET"
Show the command for a shell alias
.PP
\fBUsage:\fR mise shell\-alias get <shell_alias>
.PP
\fBArguments:\fR
.PP
.TP
\fB<shell_alias>\fR
The alias to show
.SH "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.
.PP
\fBUsage:\fR mise shell\-alias ls [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-no\-header\fR
Don't show table header
.SH "MISE SHELL-ALIAS SET"
Add/update a shell alias

This modifies the contents of ~/.config/mise/config.toml
.PP
\fBUsage:\fR mise shell\-alias set <shell_alias> <COMMAND>
.PP
\fBArguments:\fR
.PP
.TP
\fB<shell_alias>\fR
The alias name
.TP
\fB<COMMAND>\fR
The command to run
.SH "MISE SHELL-ALIAS UNSET"
Removes a shell alias

This modifies the contents of ~/.config/mise/config.toml
.PP
\fBUsage:\fR mise shell\-alias unset <shell_alias>
.PP
\fBArguments:\fR
.PP
.TP
\fB<shell_alias>\fR
The alias to remove
.SH "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
.PP
\fBUsage:\fR mise sync node [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-brew\fR
Get tool versions from Homebrew
.TP
\fB\-\-nodenv\fR
Get tool versions from nodenv
.TP
\fB\-\-nvm\fR
Get tool versions from nvm
.SH "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
.PP
\fBUsage:\fR mise sync python [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-pyenv\fR
Get tool versions from pyenv
.TP
\fB\-\-uv\fR
Sync tool versions with uv (2\-way sync)
.SH "MISE SYNC RUBY"
Symlinks all ruby tool versions from an external tool into mise
.PP
\fBUsage:\fR mise sync ruby [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-brew\fR
Get tool versions from Homebrew
.SH "MISE TASKS"
Manage tasks
.PP
\fBUsage:\fR mise tasks [OPTIONS] [<TASK>] [COMMAND]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-g, \-\-global\fR
Only show global tasks
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-l, \-\-local\fR
Only show non\-global tasks
.TP
\fB\-x, \-\-extended\fR
Show all columns
.TP
\fB\-\-all\fR
Load all tasks from the entire monorepo, including sibling directories.
By default, only tasks from the current directory hierarchy are loaded.
.TP
\fB\-\-complete\fR
Display tasks for usage completion
.TP
\fB\-\-hidden\fR
Show hidden tasks
.TP
\fB\-\-no\-header\fR
Do not print table header
.TP
\fB\-\-sort\fR \fI<COLUMN>\fR
Sort by column. Default is name.
.TP
\fB\-\-sort\-order\fR \fI<SORT_ORDER>\fR
Sort order. Default is asc.
.TP
\fB\-\-usage\fR
\fBArguments:\fR
.PP
.TP
\fB<TASK>\fR
Task name to get info of
.SH "MISE TASKS ADD"
Create a new task

Adds a task to the local mise.toml file.
See https://mise.jdx.dev/configuration.html#target\-file\-for\-write\-operations
.PP
\fBUsage:\fR mise tasks add [OPTIONS] <TASK> [<RUN>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-alias\fR \fI<ALIAS>\fR
Other names for the task
.TP
\fB\-d, \-\-depends\fR \fI<DEPENDS>\fR
Add dependencies to the task
.TP
\fB\-D, \-\-dir\fR \fI<DIR>\fR
Run the task in a specific directory
.TP
\fB\-f, \-\-file\fR
Create a file task instead of a toml task
.TP
\fB\-H, \-\-hide\fR
Hide the task from `mise tasks` and completions
.TP
\fB\-q, \-\-quiet\fR
Do not print the command before running
.TP
\fB\-r, \-\-raw\fR
Directly connect stdin/stdout/stderr
.TP
\fB\-s, \-\-sources\fR \fI<SOURCES>\fR
Glob patterns of files this task uses as input
.TP
\fB\-w, \-\-wait\-for\fR \fI<WAIT_FOR>\fR
Wait for these tasks to complete if they are to run
.TP
\fB\-\-depends\-post\fR \fI<DEPENDS_POST>\fR
Dependencies to run after the task runs
.TP
\fB\-\-description\fR \fI<DESCRIPTION>\fR
Description of the task
.TP
\fB\-\-outputs\fR \fI<OUTPUTS>\fR
Glob patterns of files this task creates, to skip if they are not modified
.TP
\fB\-\-run\-windows\fR \fI<RUN_WINDOWS>\fR
Command to run on windows
.TP
\fB\-\-shell\fR \fI<SHELL>\fR
Run the task in a specific shell
.TP
\fB\-\-silent\fR
Do not print the command or its output
\fBArguments:\fR
.PP
.TP
\fB<TASK>\fR
Tasks name to add
.SH "MISE TASKS DEPS"
Display a tree visualization of a dependency graph
.PP
\fBUsage:\fR mise tasks deps [OPTIONS] [<TASKS>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-dot\fR
Display dependencies in DOT format
.TP
\fB\-\-hidden\fR
Show hidden tasks
\fBArguments:\fR
.PP
.TP
\fB<TASKS>\fR
Tasks to show dependencies for
Can specify multiple tasks by separating with spaces
e.g.: mise tasks deps lint test check
.SH "MISE TASKS EDIT"
Edit a task with $EDITOR

The task will be created as a standalone script if it does not already exist.
.PP
\fBUsage:\fR mise tasks edit [OPTIONS] <TASK>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-p, \-\-path\fR
Display the path to the task instead of editing it
\fBArguments:\fR
.PP
.TP
\fB<TASK>\fR
Task to edit
.SH "MISE TASKS INFO"
Get information about a task
.PP
\fBUsage:\fR mise tasks info [OPTIONS] <TASK>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-J, \-\-json\fR
Output in JSON format
\fBArguments:\fR
.PP
.TP
\fB<TASK>\fR
Name of the task to get information about
.SH "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.
.PP
\fBUsage:\fR mise tasks ls [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-g, \-\-global\fR
Only show global tasks
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-l, \-\-local\fR
Only show non\-global tasks
.TP
\fB\-x, \-\-extended\fR
Show all columns
.TP
\fB\-\-all\fR
Load all tasks from the entire monorepo, including sibling directories.
By default, only tasks from the current directory hierarchy are loaded.
.TP
\fB\-\-complete\fR
Display tasks for usage completion
.TP
\fB\-\-hidden\fR
Show hidden tasks
.TP
\fB\-\-no\-header\fR
Do not print table header
.TP
\fB\-\-sort\fR \fI<COLUMN>\fR
Sort by column. Default is name.
.TP
\fB\-\-sort\-order\fR \fI<SORT_ORDER>\fR
Sort order. Default is asc.
.TP
\fB\-\-usage\fR
.SH "MISE TASKS 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
.PP
\fBUsage:\fR mise tasks run [OPTIONS] [<TASK>] [<ARGS>] ... [<ARGS_LAST>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-c, \-\-continue\-on\-error\fR
Continue running tasks even if one fails
.TP
\fB\-C, \-\-cd\fR \fI<CD>\fR
Change to this directory before executing the command
.TP
\fB\-f, \-\-force\fR
Force the tasks to run even if outputs are up to date
.TP
\fB\-i, \-\-interleave\fR
Print directly to stdout/stderr instead of by line
Defaults to true if \-\-jobs == 1
Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of tasks to run in parallel
[default: 4]
Configure with `jobs` config or `MISE_JOBS` env var
.TP
\fB\-n, \-\-dry\-run\fR
Don't actually run the task(s), just print them in order of execution
.TP
\fB\-o, \-\-output\fR \fI<OUTPUT>\fR
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
.TP
\fB\-p, \-\-prefix\fR
Print stdout/stderr by line, prefixed with the task's label
Defaults to true if \-\-jobs > 1
Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
.TP
\fB\-q, \-\-quiet\fR
Don't show extra output
.TP
\fB\-r, \-\-raw\fR
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
.TP
\fB\-s, \-\-shell\fR \fI<SHELL>\fR
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.
.TP
\fB\-S, \-\-silent\fR
Don't show any output except for errors
.TP
\fB\-t, \-\-tool\fR \fI<TOOL@VERSION>\fR
Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10
.TP
\fB\-\-fresh\-env\fR
Bypass the environment cache and recompute the environment
.TP
\fB\-\-no\-cache\fR
Do not use cache on remote tasks
.TP
\fB\-\-no\-prepare\fR
Skip automatic dependency preparation
.TP
\fB\-\-no\-timings\fR
Hides elapsed time after each task completes

Default to always hide with `MISE_TASK_TIMINGS=0`
.TP
\fB\-\-skip\-deps\fR
Run only the specified tasks skipping all dependencies
.TP
\fB\-\-timeout\fR \fI<TIMEOUT>\fR
Timeout for the task to complete
e.g.: 30s, 5m
.TP
\fB\-\-timings\fR
Shows elapsed time after each task completes

Default to always show with `MISE_TASK_TIMINGS=1`
\fBArguments:\fR
.PP
.TP
\fB<TASK>\fR
Tasks to run
Can specify multiple tasks by separating with `:::`
e.g.: mise run task1 arg1 arg2 ::: task2 arg1 arg2
.RS
\fIDefault: \fRdefault
.RE
.TP
\fB<ARGS>\fR
Arguments to pass to the tasks. Use ":::" to separate tasks
.TP
\fB<ARGS_LAST>\fR
Arguments to pass to the tasks. Use ":::" to separate tasks
.SH "MISE TASKS VALIDATE"
Validate tasks for common errors and issues
.PP
\fBUsage:\fR mise tasks validate [OPTIONS] [<TASKS>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-\-errors\-only\fR
Only show errors (skip warnings)
.TP
\fB\-\-json\fR
Output validation results in JSON format
\fBArguments:\fR
.PP
.TP
\fB<TASKS>\fR
Tasks to validate
If not specified, validates all tasks
.SH "MISE TEST-TOOL"
Test a tool installs and executes
.PP
\fBUsage:\fR mise test\-tool [OPTIONS] [<TOOLS>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
Test every tool specified in registry.toml
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
[default: 4]
.TP
\fB\-\-all\-config\fR
Test all tools specified in config files
.TP
\fB\-\-include\-non\-defined\fR
Also test tools not defined in registry.toml, guessing how to test it
.TP
\fB\-\-raw\fR
Directly pipe stdin/stdout/stderr from plugin to user Sets \-\-jobs=1
\fBArguments:\fR
.PP
.TP
\fB<TOOLS>\fR
Tool(s) to test
.SH "MISE TOOL"
Gets information about a tool
.PP
\fBUsage:\fR mise tool [OPTIONS] <TOOL>
.PP
\fBOptions:\fR
.PP
.TP
\fB\-J, \-\-json\fR
Output in JSON format
.TP
\fB\-\-active\fR
Only show active versions
.TP
\fB\-\-backend\fR
Only show backend field
.TP
\fB\-\-config\-source\fR
Only show config source
.TP
\fB\-\-description\fR
Only show description field
.TP
\fB\-\-installed\fR
Only show installed versions
.TP
\fB\-\-requested\fR
Only show requested versions
.TP
\fB\-\-tool\-options\fR
Only show tool options
\fBArguments:\fR
.PP
.TP
\fB<TOOL>\fR
Tool name to get information about
.SH "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.jdx.dev/dev\-tools/tool\-stubs.html
.PP
\fBUsage:\fR mise tool\-stub <FILE> [<ARGS>] ...
.PP
\fBArguments:\fR
.PP
.TP
\fB<FILE>\fR
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.
.TP
\fB<ARGS>\fR
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.
.SH "MISE TRUST"
Marks a config file as trusted

This means mise will parse the file with potentially dangerous
features enabled.

This includes:
\- environment variables
\- templates
\- `path:` plugin versions
.PP
\fBUsage:\fR mise trust [OPTIONS] [<CONFIG_FILE>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
Trust all config files in the current directory and its parents
.TP
\fB\-\-ignore\fR
Do not trust this config and ignore it in the future
.TP
\fB\-\-show\fR
Show the trusted status of config files from the current directory and its parents.
Does not trust or untrust any files.
.TP
\fB\-\-untrust\fR
No longer trust this config, will prompt in the future
\fBArguments:\fR
.PP
.TP
\fB<CONFIG_FILE>\fR
The config file to trust
.SH "MISE UNINSTALL"
Removes installed tool versions

This only removes the installed version, it does not modify mise.toml.
.PP
\fBUsage:\fR mise uninstall [OPTIONS] [<INSTALLED_TOOL@VERSION>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-a, \-\-all\fR
Delete all installed versions
.TP
\fB\-n, \-\-dry\-run\fR
Do not actually delete anything
\fBArguments:\fR
.PP
.TP
\fB<INSTALLED_TOOL@VERSION>\fR
Tool(s) to remove
.SH "MISE UNSET"
Remove environment variable(s) from the config file.

By default, this command modifies `mise.toml` in the current directory.
.PP
\fBUsage:\fR mise unset [OPTIONS] [<ENV_KEY>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-f, \-\-file\fR \fI<FILE>\fR
Specify a file to use instead of `mise.toml`
.TP
\fB\-g, \-\-global\fR
Use the global config file
\fBArguments:\fR
.PP
.TP
\fB<ENV_KEY>\fR
Environment variable(s) to remove
e.g.: NODE_ENV
.SH "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.jdx.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` 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.

Will also prune the installed version if no other configurations are using it.
.PP
\fBUsage:\fR mise unuse [OPTIONS] <INSTALLED_TOOL@VERSION> ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-e, \-\-env\fR \fI<ENV>\fR
Create/modify an environment\-specific config file like .mise.<env>.toml
.TP
\fB\-g, \-\-global\fR
Use the global config file (`~/.config/mise/config.toml`) instead of the local one
.TP
\fB\-p, \-\-path\fR \fI<PATH>\fR
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.
.TP
\fB\-\-no\-prune\fR
Do not also prune the installed version
\fBArguments:\fR
.PP
.TP
\fB<INSTALLED_TOOL@VERSION>\fR
Tool(s) to remove
.SH "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.jdx.dev/configuration/settings.html#lockfile
.PP
\fBUsage:\fR mise upgrade [OPTIONS] [<INSTALLED_TOOL@VERSION>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-i, \-\-interactive\fR
Display multiselect menu to choose which tools to upgrade
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
[default: 4]
.TP
\fB\-l, \-\-bump\fR
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"`.
.TP
\fB\-n, \-\-dry\-run\fR
Just print what would be done, don't actually do it
.TP
\fB\-x, \-\-exclude\fR \fI<INSTALLED_TOOL>\fR
Tool(s) to exclude from upgrading
e.g.: go python
.TP
\fB\-\-before\fR \fI<BEFORE>\fR
Only upgrade to versions released before this date

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.
.TP
\fB\-\-raw\fR
Directly pipe stdin/stdout/stderr from plugin to user Sets \-\-jobs=1
\fBArguments:\fR
.PP
.TP
\fB<INSTALLED_TOOL@VERSION>\fR
Tool(s) to upgrade
e.g.: node@20 python@3.10
If not specified, all current tools will be upgraded
.SH "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.jdx.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` 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 the `\-\-global` flag to use the global config file instead.
.PP
\fBUsage:\fR mise use [OPTIONS] [<TOOL@VERSION>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-e, \-\-env\fR \fI<ENV>\fR
Create/modify an environment\-specific config file like .mise.<env>.toml
.TP
\fB\-f, \-\-force\fR
Force reinstall even if already installed
.TP
\fB\-g, \-\-global\fR
Use the global config file (`~/.config/mise/config.toml`) instead of the local one
.TP
\fB\-j, \-\-jobs\fR \fI<JOBS>\fR
Number of jobs to run in parallel
[default: 4]
.TP
\fB\-n, \-\-dry\-run\fR
Perform a dry run, showing what would be installed and modified without making changes
.TP
\fB\-p, \-\-path\fR \fI<PATH>\fR
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.
.TP
\fB\-\-before\fR \fI<BEFORE>\fR
Only install versions released before this date

Supports absolute dates like "2024\-06\-01" and relative durations like "90d" or "1y".
.TP
\fB\-\-fuzzy\fR
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`
.TP
\fB\-\-pin\fR
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.jdx.dev/configuration/settings.html#lockfile
.TP
\fB\-\-raw\fR
Directly pipe stdin/stdout/stderr from plugin to user Sets `\-\-jobs=1`
.TP
\fB\-\-remove\fR \fI<PLUGIN>\fR
Remove the plugin(s) from config file
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
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]
.SH "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.
.PP
\fBUsage:\fR mise version [OPTIONS]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-J, \-\-json\fR
Print the version information in JSON format
.SH "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
.PP
\fBUsage:\fR mise watch [OPTIONS] [<TASK>] [<ARGS>] ...
.PP
\fBOptions:\fR
.PP
.TP
\fB\-t, \-\-task\-flag\fR \fI<TASK_FLAG>\fR
Tasks to run
.TP
\fB\-g, \-\-glob\fR \fI<GLOB>\fR
Files to watch
Defaults to sources from the task(s)
.TP
\fB\-\-skip\-deps\fR
Run only the specified tasks skipping all dependencies
.TP
\fB\-w, \-\-watch\fR \fI<PATH>\fR
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.
.TP
\fB\-W, \-\-watch\-non\-recursive\fR \fI<PATH>\fR
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.
.TP
\fB\-F, \-\-watch\-file\fR \fI<PATH>\fR
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'.
.TP
\fB\-c, \-\-clear\fR \fI<MODE>\fR
Clear screen before running command

If this doesn't completely clear the screen, try '\-\-clear=reset'.
.TP
\fB\-o, \-\-on\-busy\-update\fR \fI<MODE>\fR
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.
.RS
\fIDefault: \fRdo\-nothing
.RE
.TP
\fB\-r, \-\-restart\fR
Restart the process if it's still running

This is a shorthand for '\-\-on\-busy\-update=restart'.
.TP
\fB\-s, \-\-signal\fR \fI<SIGNAL>\fR
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".
.TP
\fB\-\-stop\-signal\fR \fI<SIGNAL>\fR
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.
.TP
\fB\-\-stop\-timeout\fR \fI<TIMEOUT>\fR
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.
.RS
\fIDefault: \fR10s
.RE
.TP
\fB\-\-map\-signal\fR \fI<SIGNAL:SIGNAL>\fR
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.
.TP
\fB\-d, \-\-debounce\fR \fI<TIMEOUT>\fR
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.
.RS
\fIDefault: \fR50ms
.RE
.TP
\fB\-\-stdin\-quit\fR
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.
.TP
\fB\-\-no\-vcs\-ignore\fR
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.
.TP
\fB\-\-no\-project\-ignore\fR
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.
.TP
\fB\-\-no\-global\-ignore\fR
Don't load global ignores

This disables loading of global or user ignore files, like '~/.gitignore',
\&'~/.config/watchexec/ignore', or '%APPDATA%\\Bazzar\\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%/Bazzar/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.
.TP
\fB\-\-no\-default\-ignore\fR
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.
.TP
\fB\-\-no\-discover\-ignore\fR
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'.
.TP
\fB\-\-ignore\-nothing\fR
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.
.TP
\fB\-p, \-\-postpone\fR
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.
.TP
\fB\-\-delay\-run\fR \fI<DURATION>\fR
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.
.TP
\fB\-\-poll\fR \fI<INTERVAL>\fR
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'.
.TP
\fB\-\-shell\fR \fI<SHELL>\fR
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
.TP
\fB\-n\fR
Shorthand for '\-\-shell=none'
.TP
\fB\-\-emit\-events\-to\fR \fI<MODE>\fR
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.
.RS
\fIDefault: \fRnone
.RE
.TP
\fB\-\-only\-emit\-events\fR
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.
.TP
\fB\-E, \-\-env\fR \fI<KEY=VALUE>\fR
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.
.TP
\fB\-\-wrap\-process\fR \fI<MODE>\fR
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.
.RS
\fIDefault: \fRgroup
.RE
.TP
\fB\-N, \-\-notify\fR
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.
.TP
\fB\-\-color\fR \fI<MODE>\fR
When to use terminal colours

Setting the environment variable `NO_COLOR` to any value is equivalent to `\-\-color=never`.
.RS
\fIDefault: \fRauto
.RE
.TP
\fB\-\-timings\fR
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.
.TP
\fB\-q, \-\-quiet\fR
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.
.TP
\fB\-\-bell\fR
Ring the terminal bell on command completion
.TP
\fB\-\-project\-origin\fR \fI<DIRECTORY>\fR
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.
.TP
\fB\-\-workdir\fR \fI<DIRECTORY>\fR
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.
.TP
\fB\-e, \-\-exts\fR \fI<EXTENSIONS>\fR
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.
.TP
\fB\-f, \-\-filter\fR \fI<PATTERN>\fR
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.
.TP
\fB\-\-filter\-file\fR \fI<PATH>\fR
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.
.TP
\fB\-J, \-\-filter\-prog\fR \fI<EXPRESSION>\fR
[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'
.TP
\fB\-i, \-\-ignore\fR \fI<PATTERN>\fR
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.
.TP
\fB\-\-ignore\-file\fR \fI<PATH>\fR
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.
.TP
\fB\-\-fs\-events\fR \fI<EVENTS>\fR
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.
.RS
\fIDefault: \fRcreate,remove,rename,modify,metadata
.RE
.TP
\fB\-\-no\-meta\fR
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.
.TP
\fB\-\-print\-events\fR
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.
.TP
\fB\-\-manual\fR
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).
\fBArguments:\fR
.PP
.TP
\fB<TASK>\fR
Tasks to run
Can specify multiple tasks by separating with `:::`
e.g.: `mise run task1 arg1 arg2 ::: task2 arg1 arg2`
.TP
\fB<ARGS>\fR
Task and arguments to run
.SH "MISE WHERE"
Display the installation path for a tool

The tool must be installed for this to work.
.PP
\fBUsage:\fR mise where <TOOL@VERSION> [<ASDF_VERSION>]
.PP
\fBArguments:\fR
.PP
.TP
\fB<TOOL@VERSION>\fR
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
.TP
\fB<ASDF_VERSION>\fR
the version prefix to use when querying the latest version
same as the first argument after the "@"
used for asdf compatibility
.SH "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.
.PP
\fBUsage:\fR mise which [OPTIONS] [<BIN_NAME>]
.PP
\fBOptions:\fR
.PP
.TP
\fB\-t, \-\-tool\fR \fI<TOOL@VERSION>\fR
Use a specific tool@version
e.g.: `mise which npm \-\-tool=node@20`
.TP
\fB\-\-complete\fR
.TP
\fB\-\-plugin\fR
Show the plugin name instead of the path
.TP
\fB\-\-version\fR
Show the version instead of the path
\fBArguments:\fR
.PP
.TP
\fB<BIN_NAME>\fR
The bin to look up