MISE(1)

NAME
mise - The front-end to your dev env

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

DESCRIPTION
mise manages dev tools, env vars, and runs tasks. https://github.com/jdx/mise

OPTIONS

-c, --continue-on-error
    Continue running tasks even if one fails

-C, --cd <DIR>
    Change directory before running command

-E, --env <ENV>
    Set the environment for loading `mise.<ENV>.toml`

-f, --force
    Force the operation

-i, --interleave
    Set the log output verbosity

-j, --jobs <JOBS>
    How many jobs to run in parallel [default: 8]

-n, --dry-run
    Dry run, don't actually do anything

-p, --prefix

-P, --profile <PROFILE>
    Set the profile (environment)

-q, --quiet
    Suppress non-error messages

-s, --shell <SHELL>

-t, --tool <TOOL@VERSION>
    Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10

-v, --verbose
    Show extra output (use -vv for even more)

-V, --version

-y, --yes
    Answer yes to all confirmation prompts

--debug
    Sets log level to debug

--log-level <LEVEL>

--no-config
    Do not load any config files Can also use `MISE_NO_CONFIG=1`

--no-timings
    Hides elapsed time after each task completes Default to always hide with `MISE_TASK_TIMINGS=0`

--output <OUTPUT>

--raw
    Read/write directly to stdin/stdout/stderr instead of by line

--silent
    Suppress all task output and mise non-error messages

--timings
    Shows elapsed time after each task completes Default to always show with `MISE_TASK_TIMINGS=1`

--trace
    Sets log level to trace

ARGUMENTS

<TASK>
    Task to run. Shorthand for `mise task run <TASK>`.

<TASK_ARGS>
    Task arguments

COMMANDS

activate
    Initializes mise in the current shell session

alias
    Manage version aliases.
    Aliases: a

alias get
    Show an alias for a plugin

alias ls
    List aliases
    Aliases: list

alias set
    Add/update an alias for a backend/plugin
    Aliases: add, create

alias unset
    Clears an alias for a backend/plugin
    Aliases: rm, remove, delete, del

backends
    Manage backends
    Aliases: b

backends ls
    List built-in backends
    Aliases: list

bin-paths
    List all the active runtime bin paths

cache
    Manage the mise cache

cache clear
    Deletes all cache files in mise
    Aliases: c

cache path
    Show the cache directory path
    Aliases: dir

cache prune
    Removes stale mise cache files
    Aliases: p

completion
    Generate shell completions

config
    Manage config files
    Aliases: cfg

config generate
    Generate a mise.toml file
    Aliases: g

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

config ls
    List config files currently in use
    Aliases: list

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

deactivate
    Disable mise for current shell session

doctor
    Check mise installation for possible problems
    Aliases: dr

doctor path
    Print the current PATH entries mise is providing

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

env Exports env vars to activate mise a single time
    Aliases: e

exec
    Execute a command with tool(s) set
    Aliases: x

fmt Formats mise.toml

generate
    Generate files for various tools/services
    Aliases: gen

generate bootstrap
    Generate a script to download+execute mise

generate config
    [experimental] Generate a mise.toml file
    Aliases: g

generate devcontainer
    Generate a devcontainer to execute mise

generate git-pre-commit
    Generate a git pre-commit hook
    Aliases: pre-commit

generate github-action
    Generate a GitHub Action workflow file

generate task-docs
    Generate documentation for tasks in a project

generate task-stubs
    Generates shims to run mise tasks

generate tool-stub
    Generate a tool stub for HTTP-based tools

implode
    Removes mise CLI and all related data

install
    Install a tool version
    Aliases: i

install-into
    Install a tool version to a specific path

latest
    Gets the latest available version for a plugin

link
    Symlinks a tool version into mise
    Aliases: ln

lock
    Update lockfile checksums and URLs for all specified platforms

ls  List installed and active tool versions
    Aliases: list

ls-remote
    List runtime versions available for install.

mcp [experimental] Run Model Context Protocol (MCP) server

outdated
    Shows outdated tool versions

plugins
    Manage plugins
    Aliases: p

plugins install
    Install a plugin
    Aliases: i, a, add

plugins link
    Symlinks a plugin into mise
    Aliases: ln

plugins ls
    List installed plugins
    Aliases: list

plugins ls-remote
    Aliases: list-remote, list-all

plugins uninstall
    Removes a plugin
    Aliases: remove, rm

plugins update
    Updates a plugin to the latest version
    Aliases: up, upgrade

prune
    Delete unused versions of tools

registry
    List available tools to install

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

run Run task(s)
    Aliases: r

search
    Search for tools in the registry

self-update
    Updates mise itself.

set Set environment variables in mise.toml

settings
    Show current settings

settings add
    Adds a setting to the configuration file

settings get
    Show a current setting

settings ls
    Show current settings
    Aliases: list

settings set
    Add/update a setting
    Aliases: create

settings unset
    Clears a setting
    Aliases: rm, remove, delete, del

shell
    Sets a tool version for the current session.
    Aliases: sh

sync
    Synchronize tools from other version managers with mise

sync node
    Symlinks all tool versions from an external tool into mise

sync python
    Symlinks all tool versions from an external tool into mise

sync ruby
    Symlinks all ruby tool versions from an external tool into mise

tasks
    Manage tasks
    Aliases: t

tasks add
    Create a new task

tasks deps
    Display a tree visualization of a dependency graph

tasks edit
    Edit a tasks with $EDITOR

tasks info
    Get information about a task

tasks ls
    List available tasks to execute

tasks run
    Run task(s)
    Aliases: r

test-tool
    Test a tool installs and executes

tool
    Gets information about a tool

tool-stub
    Execute a tool stub

trust
    Marks a config file as trusted

uninstall
    Removes installed tool versions

unset
    Remove environment variable(s) from the config file.

unuse
    Removes installed tool versions from mise.toml
    Aliases: rm, remove

upgrade
    Upgrades outdated tools
    Aliases: up

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

version
    Display the version of mise
    Aliases: v

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

where
    Display the installation path for a tool

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

MISE ACTIVATE
Initializes mise in the current shell session This should go into your shell's rc file or login shell. Otherwise, it will only take effect in the current session. (e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish, or $PROFILE for powershell) Typically, this can be added with something like the following:
    echo 'eval "$(mise activate zsh)"' >> ~/.zshrc However, this requires that "mise" is in your PATH. If it is not, you need to specify the full path like this:
    echo 'eval "$(/path/to/mise activate zsh)"' >> ~/.zshrc Customize status output with `status` settings.

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

Options:

-q, --quiet
    Suppress non-error messages

-s, --shell <SHELL>
    Shell type to generate the script for

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

--shims
    Use shims instead of modifying PATH Effectively the same as:
        PATH="$HOME/.local/share/mise/shims:$PATH" `mise activate --shims` does not support all the features of `mise activate`. See https://mise.jdx.dev/dev-tools/shims.html#shims-vs-path for more information

--status
    Show "mise: <PLUGIN>@<VERSION>" message when changing directories Arguments:

<SHELL_TYPE>
    Shell type to generate the script for

MISE ALIAS
Manage version aliases.

Usage: mise alias [OPTIONS] [COMMAND]

Options:

-p, --plugin <PLUGIN>
    filter aliases by plugin

--no-header
    Don't show table header

MISE ALIAS GET
Show an alias for a plugin This is the contents of an alias.<PLUGIN> entry in ~/.config/mise/config.toml

Usage: mise alias get <PLUGIN> <ALIAS>

Arguments:

<PLUGIN>
    The plugin to show the alias for

<ALIAS>
    The alias to show

MISE ALIAS LS
List 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`:
    [alias.node.versions]
    lts = "22.0.0"

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

Options:

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

<TOOL>
    Show aliases for <TOOL>

MISE ALIAS SET
Add/update an alias for a backend/plugin This modifies the contents of ~/.config/mise/config.toml

Usage: mise alias set <PLUGIN> <ALIAS> [<VALUE>]

Arguments:

<PLUGIN>
    The backend/plugin to set the alias for

<ALIAS>
    The alias to set

<VALUE>
    The value to set the alias to

MISE ALIAS UNSET
Clears an alias for a backend/plugin This modifies the contents of ~/.config/mise/config.toml

Usage: mise alias unset <PLUGIN> [<ALIAS>]

Arguments:

<PLUGIN>
    The backend/plugin to remove the alias from

<ALIAS>
    The alias to remove

MISE BIN-PATHS
List all the active runtime bin paths

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

Arguments:

<TOOL@VERSION>
    Tool(s) to look up e.g.: ruby@3

MISE CACHE CLEAR
Deletes all cache files in mise

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

Options:

--outdate
    Mark all cache files as old Arguments:

<PLUGIN>
    Plugin(s) to clear cache for e.g.: node, python

MISE CACHE PRUNE
Removes stale mise cache files By default, this command will remove files that have not been accessed in 30 days. Change this with the MISE_CACHE_PRUNE_AGE environment variable.

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

Options:

-v, --verbose
    Show pruned files

--dry-run
    Just show what would be pruned Arguments:

<PLUGIN>
    Plugin(s) to clear cache for e.g.: node, python

MISE COMPLETION
Generate shell completions

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

Options:

-s, --shell <SHELL_TYPE>
    Shell type to generate completions for

--include-bash-completion-lib
    Include the bash completion library in the bash completion script This is required for completions to work in bash, but it is not included by default you may source it separately or enable this flag to enable it in the script.

--usage
    Always use usage for completions. Currently, usage is the default for fish and bash but not zsh since it has a few quirks to work out first. This requires the `usage` CLI to be installed. https://usage.jdx.dev Arguments:

<SHELL>
    Shell type to generate completions for

MISE CONFIG
Manage config files

Usage: mise config [OPTIONS] [COMMAND]

Options:

-J, --json
    Output in JSON format

--no-header
    Do not print table header

--tracked-configs
    List all tracked config files

MISE CONFIG GENERATE
Generate a mise.toml file

Usage: mise config generate [OPTIONS]

Options:

-o, --output <OUTPUT>
    Output to file instead of stdout

-t, --tool-versions <TOOL_VERSIONS>
    Path to a .tool-versions file to import tools from

MISE CONFIG GET
Display the value of a setting in a mise.toml file

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

Options:

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

<KEY>
    The path of the config to display

MISE CONFIG LS
List config files currently in use

Usage: mise config ls [OPTIONS]

Options:

-J, --json
    Output in JSON format

--no-header
    Do not print table header

--tracked-configs
    List all tracked config files

MISE CONFIG SET
Set the value of a setting in a mise.toml file

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

Options:

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

-t, --type <TYPE>
    Arguments:

<KEY>
    The path of the config to display

<VALUE>
    The value to set the key to

MISE DOCTOR
Check mise installation for possible problems

Usage: mise doctor [OPTIONS] [COMMAND]

Options:

-J, --json

MISE DOCTOR PATH
Print the current PATH entries mise is providing

Usage: mise doctor path [OPTIONS]

Options:

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

MISE EN
Starts a new shell with the mise environment built from the current configuration This is an alternative to `mise activate` that allows you to explicitly start a mise session. It will have the tools and environment variables in the configs loaded. Note that changing directories will not update the mise environment.

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

Options:

-s, --shell <SHELL>
    Shell to start Defaults to $SHELL Arguments:

<DIR>
    Directory to start the shell in
    Default: .

MISE ENV
Exports env vars to activate mise a single time Use this if you don't want to permanently install mise. It's not necessary to use this if you have `mise activate` in your shell rc file.

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

Options:

-D, --dotenv
    Output in dotenv format

-J, --json
    Output in JSON format

-s, --shell <SHELL>
    Shell type to generate environment variables for

--json-extended
    Output in JSON format with additional information (source, tool)

--redacted
    Only show redacted environment variables

--values
    Only show values of environment variables Arguments:

<TOOL@VERSION>
    Tool(s) to use

MISE EXEC
Execute a command with tool(s) set use this to avoid modifying the shell session or running ad-hoc commands with mise tools set. Tools will be loaded from mise.toml, though they can be overridden with <RUNTIME> args Note that only the plugin specified will be overridden, so if a `mise.toml` file includes "node 20" but you run `mise exec python@3.11`; it will still load node@20. The "--" separates runtimes from the commands to pass along to the subprocess.

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

Options:

-c, --command <C>
    Command string to execute

-j, --jobs <JOBS>
    Number of jobs to run in parallel [default: 4]

--raw
    Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1 Arguments:

<TOOL@VERSION>
    Tool(s) to start e.g.: node@20 python@3.10

<COMMAND>
    Command string to execute (same as --command)

MISE FMT
Formats mise.toml Sorts keys and cleans up whitespace in mise.toml

Usage: mise fmt [OPTIONS]

Options:

-a, --all
    Format all files from the current directory

-c, --check
    Check if the configs are formatted, no formatting is done

-s, --stdin
    Read config from stdin and write its formatted version into stdout

MISE GENERATE BOOTSTRAP
Generate a script to download+execute mise This is designed to be used in a project where contributors may not have mise installed.

Usage: mise generate bootstrap [OPTIONS]

Options:

-l, --localize
    Sandboxes mise internal directories like MISE_DATA_DIR and MISE_CACHE_DIR into a `.mise` directory in the project This is necessary if users may use a different version of mise outside the project.

-V, --version <VERSION>
    Specify mise version to fetch

-w, --write <WRITE>
    instead of outputting the script to stdout, write to a file and make it executable

--localized-dir <LOCALIZED_DIR>
    Directory to put localized data into

MISE GENERATE CONFIG
[experimental] Generate a mise.toml file

Usage: mise generate config [OPTIONS]

Options:

-o, --output <OUTPUT>
    Output to file instead of stdout

-t, --tool-versions <TOOL_VERSIONS>
    Path to a .tool-versions file to import tools from

MISE GENERATE DEVCONTAINER
Generate a devcontainer to execute mise

Usage: mise generate devcontainer [OPTIONS]

Options:

-i, --image <IMAGE>
    The image to use for the devcontainer

-m, --mount-mise-data
    Bind the mise-data-volume to the devcontainer

-n, --name <NAME>
    The name of the devcontainer

-w, --write
    write to .devcontainer/devcontainer.json

MISE GENERATE GIT-PRE-COMMIT
Generate a git pre-commit hook This command generates a git pre-commit hook that runs a mise task like `mise run pre-commit` when you commit changes to your repository. Staged files are passed to the task as `STAGED`. For more advanced pre-commit functionality, see mise's sister project: https://hk.jdx.dev/

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

Options:

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

-w, --write
    write to .git/hooks/pre-commit and make it executable

--hook <HOOK>
    Which hook to generate (saves to .git/hooks/$hook)

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

Usage: mise generate github-action [OPTIONS]

Options:

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

-w, --write
    write to .github/workflows/$name.yml

--name <NAME>
    the name of the workflow to generate

MISE GENERATE TASK-DOCS
Generate documentation for tasks in a project

Usage: mise generate task-docs [OPTIONS]

Options:

-i, --inject
    inserts the documentation into an existing file This will look for a special comment, `<!-- 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.

-I, --index
    write only an index of tasks, intended for use with `--multi`

-m, --multi
    render each task as a separate document, requires `--output` to be a directory

-o, --output <OUTPUT>
    writes the generated docs to a file/directory

-r, --root <ROOT>
    root directory to search for tasks

-s, --style <STYLE>

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

Usage: mise generate task-stubs [OPTIONS]

Options:

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

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

MISE GENERATE TOOL-STUB
Generate a tool stub for HTTP-based tools This command generates tool stubs that can automatically download and execute tools from HTTP URLs. It can detect checksums, file sizes, and binary paths automatically by downloading and analyzing the tool. When generating stubs with platform-specific URLs, the command will append new platforms to existing stub files rather than overwriting them. This allows you to incrementally build cross-platform tool stubs.

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

Options:

-b, --bin <BIN>
    Binary path within the extracted archive If not specified and the archive is downloaded, will auto-detect the most likely binary

-u, --url <URL>
    URL for downloading the tool Example: https://github.com/owner/repo/releases/download/v2.0.0/tool-linux-x64.tar.gz

--fetch
    Fetch checksums and sizes for an existing tool stub file This reads an existing stub file and fills in any missing checksum/size fields by downloading the files. URLs must already be present in the stub.

--http <HTTP>
    HTTP backend type to use

--platform-bin <PLATFORM_BIN>
    Platform-specific binary paths in the format platform:path Examples: --platform-bin windows-x64:tool.exe --platform-bin linux-x64:bin/tool

--platform-url <PLATFORM_URL>
    Platform-specific URLs in the format platform:url or just url (auto-detect platform) When the output file already exists, new platforms will be appended to the existing platforms table. Existing platform URLs will be updated if specified again. If only a URL is provided (without platform:), the platform will be automatically detected from the URL filename. Examples: --platform-url linux-x64:https://... --platform-url https://nodejs.org/dist/v22.17.1/node-v22.17.1-darwin-arm64.tar.gz

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

--version <VERSION>
    Version of the tool Arguments:

<OUTPUT>
    Output file path for the tool stub

MISE IMPLODE
Removes mise CLI and all related data Skips config directory by default.

Usage: mise implode [OPTIONS]

Options:

-n, --dry-run
    List directories that would be removed without actually removing them

--config
    Also remove config directory

MISE 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`

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

Options:

-f, --force
    Force reinstall even if already installed

-j, --jobs <JOBS>
    Number of jobs to run in parallel [default: 4]

-n, --dry-run
    Show what would be installed without actually installing

-v, --verbose
    Show installation output This argument will print plugin output such as download, configuration, and compilation output.

--raw
    Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1 Arguments:

<TOOL@VERSION>
    Tool(s) to install e.g.: node@20

MISE INSTALL-INTO
Install a tool version to a specific path Used for building a tool to a directory for use outside of mise

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

Arguments:

<TOOL@VERSION>
    Tool to install e.g.: node@20

<PATH>
    Path to install the tool into

MISE LATEST
Gets the latest available version for a plugin Supports prefixes such as `node@20` to get the latest version of node 20.

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

Options:

-i, --installed
    Show latest installed instead of available version Arguments:

<TOOL@VERSION>
    Tool to get the latest version of

<ASDF_VERSION>
    The version prefix to use when querying the latest version same as the first argument after the "@" used for asdf compatibility

MISE LINK
Symlinks a tool version into mise Use this for adding installs either custom compiled outside mise or built with a different tool.

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

Options:

-f, --force
    Overwrite an existing tool version if it exists Arguments:

<TOOL@VERSION>
    Tool name and version to create a symlink for

<PATH>
    The local path to the tool version e.g.: ~/.nvm/versions/node/v20.0.0

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

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

Options:

-f, --force
    Update all tools even if lockfile data already exists

-j, --jobs <JOBS>
    Number of jobs to run in parallel [default: 4]

-n, --dry-run
    Show what would be updated without making changes

-p, --platform <PLATFORM>
    Comma-separated list of platforms to target e.g.: linux-x64,macos-arm64,windows-x64 If not specified, all platforms already in lockfile will be updated Arguments:

<TOOL>
    Tool(s) to update in lockfile e.g.: node python If not specified, all tools in lockfile will be updated

MISE LS
List installed and active tool versions This command lists tools that mise "knows about". These may be tools that are currently installed, or those that are in a config file (active) but may or may not be installed. It's a useful command to get the current state of your tools.

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

Options:

-c, --current
    Only show tool versions currently specified in a mise.toml

-g, --global
    Only show tool versions currently specified in the global mise.toml

-i, --installed
    Only show tool versions that are installed (Hides tools defined in mise.toml but not installed)

-J, --json
    Output in JSON format

-l, --local
    Only show tool versions currently specified in the local mise.toml

-m, --missing
    Display missing tool versions

-o, --offline
    Don't fetch information such as outdated versions

-p, --plugin <TOOL_FLAG>

--no-header
    Don't display headers

--outdated
    Display whether a version is outdated

--prefix <PREFIX>
    Display versions matching this prefix

--prunable
    List only tools that can be pruned with `mise prune` Arguments:

<INSTALLED_TOOL>
    Only show tool versions from [TOOL]

MISE LS-REMOTE
List runtime versions available for install. Note that the results may be cached, run `mise cache clean` to clear the cache and get fresh results.

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

Options:

--all
    Show all installed plugins and versions Arguments:

<TOOL@VERSION>
    Tool to get versions for

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

MISE OUTDATED
Shows outdated tool versions See `mise upgrade` to upgrade these versions.

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

Options:

-J, --json
    Output in JSON format

-l, --bump
    Compares against the latest versions available, not what matches the current config For example, if you have `node = "20"` in your config by default `mise outdated` will only show other 20.x versions, not 21.x or 22.x versions. Using this flag, if there are 21.x or newer versions it will display those instead of 20.x.

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

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

MISE PLUGINS
Manage plugins

Usage: mise plugins [OPTIONS] [COMMAND]

Options:

-a, --all
    list all available remote plugins same as `mise plugins ls-remote`

-c, --core
    The built-in plugins only Normally these are not shown

-u, --urls
    Show the git url for each plugin e.g.: https://github.com/asdf-vm/asdf-nodejs.git

--refs
    Show the git refs for each plugin e.g.: main 1234abc

--user
    List installed plugins This is the default behavior but can be used with --core to show core and user plugins

MISE PLUGINS INSTALL
Install a plugin note that mise 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

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

Options:

-a, --all
    Install all missing plugins This will only install plugins that have matching shorthands. i.e.: they don't need the full git repo url

-f, --force
    Reinstall even if plugin exists

-j, --jobs <JOBS>
    Number of jobs to run in parallel

-v, --verbose
    Show installation output Arguments:

<NEW_PLUGIN>
    The name of the plugin to install e.g.: node, ruby Can specify multiple plugins: `mise plugins install node ruby python`

<GIT_URL>
    The git url of the plugin

MISE PLUGINS LINK
Symlinks a plugin into mise This is used for developing a plugin.

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

Options:

-f, --force
    Overwrite existing plugin Arguments:

<NAME>
    The name of the plugin e.g.: node, ruby

<DIR>
    The local path to the plugin e.g.: ./mise-node

MISE PLUGINS LS
List installed plugins Can also show remotely available plugins to install.

Usage: mise plugins ls [OPTIONS]

Options:

-a, --all
    List all available remote plugins Same as `mise plugins ls-remote`

-c, --core
    The built-in plugins only Normally these are not shown

-u, --urls
    Show the git url for each plugin e.g.: https://github.com/asdf-vm/asdf-nodejs.git

--refs
    Show the git refs for each plugin e.g.: main 1234abc

--user
    List installed plugins

MISE PLUGINS LS-REMOTE
List all available remote plugins The full list is here: https://github.com/jdx/mise/blob/main/registry.toml Examples:
    $ mise plugins ls-remote

Usage: mise plugins ls-remote [OPTIONS]

Options:

-u, --urls
    Show the git url for each plugin e.g.: https://github.com/mise-plugins/mise-poetry.git

--only-names
    Only show the name of each plugin by default it will show a "*" next to installed plugins

MISE PLUGINS UNINSTALL
Removes a plugin

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

Options:

-a, --all
    Remove all plugins

-p, --purge
    Also remove the plugin's installs, downloads, and cache Arguments:

<PLUGIN>
    Plugin(s) to remove

MISE PLUGINS UPDATE
Updates a plugin to the latest version note: this updates the plugin itself, not the runtime versions

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

Options:

-j, --jobs <JOBS>
    Number of jobs to run in parallel Default: 4 Arguments:

<PLUGIN>
    Plugin(s) to update

MISE 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`

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

Options:

-n, --dry-run
    Do not actually delete anything

--configs
    Prune only tracked and trusted configuration links that point to non-existent configurations

--tools
    Prune only unused versions of tools Arguments:

<INSTALLED_TOOL>
    Prune only these tools

MISE REGISTRY
List available tools to install This command lists the tools available in the registry as shorthand names. For example, `poetry` is shorthand for `asdf:mise-plugins/mise-poetry`.

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

Options:

-b, --backend <BACKEND>
    Show only tools for this backend

--complete
    Print all tools with descriptions for shell completions

--hide-aliased
    Hide aliased tools Arguments:

<NAME>
    Show only the specified tool's full name

MISE RESHIM
Creates new shims based on bin paths from currently installed tools. This creates new shims in ~/.local/share/mise/shims for CLIs that have been added. mise will try to do this automatically for commands like `npm i -g` but there are other ways to install things (like using yarn or pnpm for node) that mise does not know about and so it will be necessary to call this explicitly. If you think mise should automatically call this for a particular command, please open an issue on the mise repo. You can also 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.

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

Options:

-f, --force
    Removes all shims before reshimming

MISE RUN
Run task(s) This command will run a tasks, or multiple tasks in parallel. Tasks may have dependencies on other tasks or on source files. If source is configured on a tasks, it will only run if the source files have changed. Tasks can be defined in mise.toml or as standalone scripts. In mise.toml, tasks take this form:
    [tasks.build]
    run = "npm run build"
    sources = ["src/**/*.ts"]
    outputs = ["dist/**/*.js"] Alternatively, tasks can be defined as standalone scripts. These must be located in `mise-tasks`, `.mise-tasks`, `.mise/tasks`, `mise/tasks` or `.config/mise/tasks`. The name of the script will be the name of the tasks.
    $ cat .mise/tasks/build<<EOF
    #!/usr/bin/env bash
    npm run build
    EOF
    $ mise run build

Usage: mise run [OPTIONS]

Options:

-c, --continue-on-error
    Continue running tasks even if one fails

-C, --cd <CD>
    Change to this directory before executing the command

-f, --force
    Force the tasks to run even if outputs are up to date

-i, --interleave
    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

-j, --jobs <JOBS>
    Number of tasks to run in parallel [default: 4] Configure with `jobs` config or `MISE_JOBS` env var

-n, --dry-run
    Don't actually run the tasks(s), just print them in order of execution

-o, --output <OUTPUT>
    Change how tasks information is output when running tasks - `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `replacing` - Stdout is replaced each time, stderr is printed as is - `timed` - Only show stdout lines if they are displayed for more than 1 second - `keep-order` - Print stdout/stderr by line, prefixed with the task's label, but keep the order of the output - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors

-p, --prefix
    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

-q, --quiet
    Don't show extra output

-r, --raw
    Read/write directly to stdin/stdout/stderr instead of by line Redactions are not applied with this option Configure with `raw` config or `MISE_RAW` env var

-s, --shell <SHELL>
    Shell to use to run toml tasks Defaults to `sh -c -o errexit -o pipefail` on unix, and `cmd /c` on Windows Can also be set with the setting `MISE_UNIX_DEFAULT_INLINE_SHELL_ARGS` or `MISE_WINDOWS_DEFAULT_INLINE_SHELL_ARGS` Or it can be overridden with the `shell` property on a task.

-S, --silent
    Don't show any output except for errors

-t, --tool <TOOL@VERSION>
    Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10

--no-cache
    Do not use cache on remote tasks

--no-timings
    Hides elapsed time after each task completes Default to always hide with `MISE_TASK_TIMINGS=0`

--timeout <TIMEOUT>
    Timeout for the task to complete e.g.: 30s, 5m

--timings
    Shows elapsed time after each task completes Default to always show with `MISE_TASK_TIMINGS=1`

MISE SEARCH
Search for tools in the registry This command searches a tool in the registry. By default, it will show all tools that fuzzy match the search term. For non-fuzzy matches, use the `--match-type` flag.

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

Options:

-i, --interactive
    Show interactive search

-m, --match-type <MATCH_TYPE>
    Match type: equal, contains, or fuzzy

--no-header
    Don't display headers Arguments:

<NAME>
    The tool to search for

MISE SELF-UPDATE
Updates mise itself. Uses the GitHub Releases API to find the latest release and binary. By default, this will also update any installed plugins. Uses 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.

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

Options:

-f, --force
    Update even if already up to date

-y, --yes
    Skip confirmation prompt

--no-plugins
    Disable auto-updating plugins Arguments:

<VERSION>
    Update to a specific version

MISE SET
Set environment variables in mise.toml By default, this command modifies `mise.toml` in the current directory. Use `-E <env>` to create/modify environment-specific config files like `mise.<env>.toml`.

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

Options:

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

-g, --global
    Set the environment variable in the global config file

--age-encrypt
    [experimental] Encrypt the value with age before storing

--age-key-file <PATH>
    [experimental] Age identity file for encryption Defaults to ~/.config/mise/age.txt if it exists

--age-recipient <RECIPIENT>
    [experimental] Age recipient (x25519 public key) for encryption Can be used multiple times. Requires --age-encrypt.

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

--complete
    Render completions

--file <FILE>
    The TOML file to update Can be a file path or directory. If a directory is provided, will create/use mise.toml in that directory. Defaults to MISE_DEFAULT_CONFIG_FILENAME environment variable, or `mise.toml`.

--prompt
    Prompt for environment variable values

--remove, --rm, --unset <ENV_KEY>
    Remove the environment variable from config file Can be used multiple times. Arguments:

<ENV_VAR>
    Environment variable(s) to set e.g.: NODE_ENV=production

MISE SETTINGS
Show current settings This is the contents of ~/.config/mise/config.toml Note that aliases are also stored in this file but managed separately with `mise aliases`

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

Options:

-a, --all
    List all settings

-J, --json
    Output in JSON format

-l, --local
    Use the local config file instead of the global one

-T, --toml
    Output in TOML format

--complete
    Print all settings with descriptions for shell completions

--json-extended
    Output in JSON format with sources Arguments:

<SETTING>
    Name of setting

<VALUE>
    Setting value to set

MISE SETTINGS ADD
Adds a setting to the configuration file Used with an array setting, this will append the value to the array. This modifies the contents of ~/.config/mise/config.toml

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

Options:

-l, --local
    Use the local config file instead of the global one Arguments:

<SETTING>
    The setting to set

<VALUE>
    The value to set

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 aliases get`

Usage: mise settings get [OPTIONS] <SETTING>

Options:

-l, --local
    Use the local config file instead of the global one Arguments:

<SETTING>
    The setting to show

MISE SETTINGS LS
Show current settings This is the contents of ~/.config/mise/config.toml Note that aliases are also stored in this file but managed separately with `mise aliases`

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

Options:

-a, --all
    List all settings

-J, --json
    Output in JSON format

-l, --local
    Use the local config file instead of the global one

-T, --toml
    Output in TOML format

--complete
    Print all settings with descriptions for shell completions

--json-extended
    Output in JSON format with sources Arguments:

<SETTING>
    Name of setting

MISE SETTINGS SET
Add/update a setting This modifies the contents of ~/.config/mise/config.toml

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

Options:

-l, --local
    Use the local config file instead of the global one Arguments:

<SETTING>
    The setting to set

<VALUE>
    The value to set

MISE SETTINGS UNSET
Clears a setting This modifies the contents of ~/.config/mise/config.toml

Usage: mise settings unset [OPTIONS] <KEY>

Options:

-l, --local
    Use the local config file instead of the global one Arguments:

<KEY>
    The setting to remove

MISE SHELL
Sets a tool version for the current session. Only works in a session where mise is already activated. This works by setting environment variables for the current shell session such as `MISE_NODE_VERSION=20` which is "eval"ed as a shell function created by `mise activate`.

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

Options:

-j, --jobs <JOBS>
    Number of jobs to run in parallel [default: 4]

-u, --unset
    Removes a previously set version

--raw
    Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1 Arguments:

<TOOL@VERSION>
    Tool(s) to use

MISE SYNC NODE
Symlinks all tool versions from an external tool into mise For example, use this to import all Homebrew node installs into mise This won't overwrite any existing installs but will overwrite any existing symlinks

Usage: mise sync node [OPTIONS]

Options:

--brew
    Get tool versions from Homebrew

--nodenv
    Get tool versions from nodenv

--nvm
    Get tool versions from nvm

MISE SYNC PYTHON
Symlinks all tool versions from an external tool into mise For example, use this to import all pyenv installs into mise This won't overwrite any existing installs but will overwrite any existing symlinks

Usage: mise sync python [OPTIONS]

Options:

--pyenv
    Get tool versions from pyenv

--uv
    Sync tool versions with uv (2-way sync)

MISE SYNC RUBY
Symlinks all ruby tool versions from an external tool into mise

Usage: mise sync ruby [OPTIONS]

Options:

--brew
    Get tool versions from Homebrew

MISE TASKS
Manage tasks

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

Options:

-g, --global
    Only show global tasks

-J, --json
    Output in JSON format

-l, --local
    Only show non-global tasks

-x, --extended
    Show all columns

--all
    Load all tasks from the entire monorepo, including sibling directories. By default, only tasks from the current directory hierarchy are loaded.

--complete
    Display tasks for usage completion

--hidden
    Show hidden tasks

--no-header
    Do not print table header

--sort <COLUMN>
    Sort by column. Default is name.

--sort-order <SORT_ORDER>
    Sort order. Default is asc.

--usage
    Arguments:

<TASK>
    Task name to get info of

MISE TASKS ADD
Create a new task

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

Options:

-a, --alias <ALIAS>
    Other names for the task

-d, --depends <DEPENDS>
    Add dependencies to the task

-D, --dir <DIR>
    Run the task in a specific directory

-f, --file
    Create a file task instead of a toml task

-H, --hide
    Hide the task from `mise task` and completions

-q, --quiet
    Do not print the command before running

-r, --raw
    Directly connect stdin/stdout/stderr

-s, --sources <SOURCES>
    Glob patterns of files this task uses as input

-w, --wait-for <WAIT_FOR>
    Wait for these tasks to complete if they are to run

--depends-post <DEPENDS_POST>
    Dependencies to run after the task runs

--description <DESCRIPTION>
    Description of the task

--outputs <OUTPUTS>
    Glob patterns of files this task creates, to skip if they are not modified

--run-windows <RUN_WINDOWS>
    Command to run on windows

--shell <SHELL>
    Run the task in a specific shell

--silent
    Do not print the command or its output Arguments:

<TASK>
    Tasks name to add

MISE TASKS DEPS
Display a tree visualization of a dependency graph

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

Options:

--dot
    Display dependencies in DOT format

--hidden
    Show hidden tasks Arguments:

<TASKS>
    Tasks to show dependencies for Can specify multiple tasks by separating with spaces e.g.: mise tasks deps lint test check

MISE TASKS EDIT
Edit a tasks with $EDITOR The tasks will be created as a standalone script if it does not already exist.

Usage: mise tasks edit [OPTIONS] <TASK>

Options:

-p, --path
    Display the path to the tasks instead of editing it Arguments:

<TASK>
    Tasks to edit

MISE TASKS INFO
Get information about a task

Usage: mise tasks info [OPTIONS] <TASK>

Options:

-J, --json
    Output in JSON format Arguments:

<TASK>
    Name of the task to get information about

MISE TASKS LS
List available tasks to execute These may be included from the config file or from the project's .mise/tasks directory mise will merge all tasks from all parent directories into this list. So if you have global tasks in `~/.config/mise/tasks/*` and project-specific tasks in ~/myproject/.mise/tasks/*, then they'll both be available but the project-specific tasks will override the global ones if they have the same name.

Usage: mise tasks ls [OPTIONS]

Options:

-g, --global
    Only show global tasks

-J, --json
    Output in JSON format

-l, --local
    Only show non-global tasks

-x, --extended
    Show all columns

--all
    Load all tasks from the entire monorepo, including sibling directories. By default, only tasks from the current directory hierarchy are loaded.

--complete
    Display tasks for usage completion

--hidden
    Show hidden tasks

--no-header
    Do not print table header

--sort <COLUMN>
    Sort by column. Default is name.

--sort-order <SORT_ORDER>
    Sort order. Default is asc.

--usage

MISE TASKS RUN
Run task(s) This command will run a tasks, or multiple tasks in parallel. Tasks may have dependencies on other tasks or on source files. If source is configured on a tasks, it will only run if the source files have changed. Tasks can be defined in mise.toml or as standalone scripts. In mise.toml, tasks take this form:
    [tasks.build]
    run = "npm run build"
    sources = ["src/**/*.ts"]
    outputs = ["dist/**/*.js"] Alternatively, tasks can be defined as standalone scripts. These must be located in `mise-tasks`, `.mise-tasks`, `.mise/tasks`, `mise/tasks` or `.config/mise/tasks`. The name of the script will be the name of the tasks.
    $ cat .mise/tasks/build<<EOF
    #!/usr/bin/env bash
    npm run build
    EOF
    $ mise run build

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

Options:

-c, --continue-on-error
    Continue running tasks even if one fails

-C, --cd <CD>
    Change to this directory before executing the command

-f, --force
    Force the tasks to run even if outputs are up to date

-i, --interleave
    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

-j, --jobs <JOBS>
    Number of tasks to run in parallel [default: 4] Configure with `jobs` config or `MISE_JOBS` env var

-n, --dry-run
    Don't actually run the tasks(s), just print them in order of execution

-o, --output <OUTPUT>
    Change how tasks information is output when running tasks - `prefix` - Print stdout/stderr by line, prefixed with the task's label - `interleave` - Print directly to stdout/stderr instead of by line - `replacing` - Stdout is replaced each time, stderr is printed as is - `timed` - Only show stdout lines if they are displayed for more than 1 second - `keep-order` - Print stdout/stderr by line, prefixed with the task's label, but keep the order of the output - `quiet` - Don't show extra output - `silent` - Don't show any output including stdout and stderr from the task except for errors

-p, --prefix
    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

-q, --quiet
    Don't show extra output

-r, --raw
    Read/write directly to stdin/stdout/stderr instead of by line Redactions are not applied with this option Configure with `raw` config or `MISE_RAW` env var

-s, --shell <SHELL>
    Shell to use to run toml tasks Defaults to `sh -c -o errexit -o pipefail` on unix, and `cmd /c` on Windows Can also be set with the setting `MISE_UNIX_DEFAULT_INLINE_SHELL_ARGS` or `MISE_WINDOWS_DEFAULT_INLINE_SHELL_ARGS` Or it can be overridden with the `shell` property on a task.

-S, --silent
    Don't show any output except for errors

-t, --tool <TOOL@VERSION>
    Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10

--no-cache
    Do not use cache on remote tasks

--no-timings
    Hides elapsed time after each task completes Default to always hide with `MISE_TASK_TIMINGS=0`

--timeout <TIMEOUT>
    Timeout for the task to complete e.g.: 30s, 5m

--timings
    Shows elapsed time after each task completes Default to always show with `MISE_TASK_TIMINGS=1` Arguments:

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

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

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

MISE TEST-TOOL
Test a tool installs and executes

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

Options:

-a, --all
    Test every tool specified in registry.toml

-j, --jobs <JOBS>
    Number of jobs to run in parallel [default: 4]

--all-config
    Test all tools specified in config files

--include-non-defined
    Also test tools not defined in registry.toml, guessing how to test it

--raw
    Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1 Arguments:

<TOOLS>
    Tool(s) to test

MISE TOOL
Gets information about a tool

Usage: mise tool [OPTIONS] <TOOL>

Options:

-J, --json
    Output in JSON format

--active
    Only show active versions

--backend
    Only show backend field

--config-source
    Only show config source

--description
    Only show description field

--installed
    Only show installed versions

--requested
    Only show requested versions

--tool-options
    Only show tool options Arguments:

<TOOL>
    Tool name to get information about

MISE TOOL-STUB
Execute a tool stub Tool stubs are executable files containing TOML configuration that specify which tool to run and how to run it. They provide a convenient way to create portable, self-contained executables that automatically manage tool installation and execution. A tool stub consists of: - A shebang line: #!/usr/bin/env -S mise tool-stub - TOML configuration specifying the tool, version, and options - Optional comments describing the tool's purpose Example stub file: #!/usr/bin/env -S mise tool-stub # Node.js v20 development environment tool = "node" version = "20.0.0" bin = "node" The stub will automatically install the specified tool version if missing and execute it with any arguments passed to the stub. For more information, see: https://mise.jdx.dev/dev-tools/tool-stubs.html

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

Arguments:

<FILE>
    Path to the TOML tool stub file to execute The stub file must contain TOML configuration specifying the tool and version to run. At minimum, it should specify a 'version' field. Other common fields include 'tool', 'bin', and backend-specific options.

<ARGS>
    Arguments to pass to the tool All arguments after the stub file path will be forwarded to the underlying tool. Use '--' to separate mise arguments from tool arguments if needed.

MISE TRUST
Marks a config file as trusted This means mise will parse the file with potentially dangerous features enabled. This includes: - environment variables - templates - `path:` plugin versions

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

Options:

-a, --all
    Trust all config files in the current directory and its parents

--ignore
    Do not trust this config and ignore it in the future

--show
    Show the trusted status of config files from the current directory and its parents. Does not trust or untrust any files.

--untrust
    No longer trust this config, will prompt in the future Arguments:

<CONFIG_FILE>
    The config file to trust

MISE UNINSTALL
Removes installed tool versions This only removes the installed version, it does not modify mise.toml.

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

Options:

-a, --all
    Delete all installed versions

-n, --dry-run
    Do not actually delete anything Arguments:

<INSTALLED_TOOL@VERSION>
    Tool(s) to remove

MISE UNSET
Remove environment variable(s) from the config file. By default, this command modifies `mise.toml` in the current directory.

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

Options:

-f, --file <FILE>
    Specify a file to use instead of `mise.toml`

-g, --global
    Use the global config file Arguments:

<ENV_KEY>
    Environment variable(s) to remove e.g.: NODE_ENV

MISE UNUSE
Removes installed tool versions from mise.toml By default, this will use the `mise.toml` file that has the tool defined. 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.

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

Options:

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

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

-p, --path <PATH>
    Specify a path to a config file or directory If a directory is specified, it will look for a config file in that directory following the rules above.

--no-prune
    Do not also prune the installed version Arguments:

<INSTALLED_TOOL@VERSION>
    Tool(s) to remove

MISE UPGRADE
Upgrades outdated tools By default, this keeps the range specified in mise.toml. So if you have node@20 set, it will upgrade to the latest 20.x.x version available. See the `--bump` flag to use the latest version and bump the version in mise.toml. This will update mise.lock if it is enabled, see https://mise.jdx.dev/configuration/settings.html#lockfile

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

Options:

-i, --interactive
    Display multiselect menu to choose which tools to upgrade

-j, --jobs <JOBS>
    Number of jobs to run in parallel [default: 4]

-l, --bump
    Upgrades to the latest version available, bumping the version in mise.toml For example, if you have `node = "20.0.0"` in your mise.toml but 22.1.0 is the latest available, this will install 22.1.0 and set `node = "22.1.0"` in your config. It keeps the same precision as what was there before, so if you instead had `node = "20"`, it would change your config to `node = "22"`.

-n, --dry-run
    Just print what would be done, don't actually do it

--raw
    Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1 Arguments:

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

MISE USE
Installs a tool and adds the version to mise.toml. This will install the tool version if it is not already installed. By default, this will use a `mise.toml` file in the current directory. 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.

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

Options:

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

-f, --force
    Force reinstall even if already installed

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

-j, --jobs <JOBS>
    Number of jobs to run in parallel [default: 4]

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

-p, --path <PATH>
    Specify a path to a config file or directory If a directory is specified, it will look for a config file in that directory following the rules above.

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

--pin
    Save exact version to config file e.g.: `mise use --pin node@20` will save 20.0.0 as the version Set `MISE_PIN=1` to make this the default behavior Consider using mise.lock as a better alternative to pinning in mise.toml: https://mise.jdx.dev/configuration/settings.html#lockfile

--raw
    Directly pipe stdin/stdout/stderr from plugin to user Sets `--jobs=1`

--remove <PLUGIN>
    Remove the plugin(s) from config file Arguments:

<TOOL@VERSION>
    Tool(s) to add to config file e.g.: node@20, cargo:ripgrep@latest npm:prettier@3 If no version is specified, it will default to @latest Tool options can be set with this syntax:
        mise use ubi:BurntSushi/ripgrep[exe=rg]

MISE VERSION
Display the version of mise Displays the version, os, architecture, and the date of the build. If the version is out of date, it will display a warning.

Usage: mise version [OPTIONS]

Options:

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

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

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

Options:

-t, --task-flag <TASK_FLAG>
    Tasks to run

-g, --glob <GLOB>
    Files to watch Defaults to sources from the tasks(s)

-w, --watch <PATH>
    Watch a specific file or directory By default, Watchexec watches the current directory. When watching a single file, it's often better to watch the containing directory instead, and filter on the filename. Some editors may replace the file with a new one when saving, and some platforms may not detect that or further changes. Upon starting, Watchexec resolves a "project origin" from the watched paths. See the help for '--project-origin' for more information. This option can be specified multiple times to watch multiple files or directories. The special value '/dev/null', provided as the only path watched, will cause Watchexec to not watch any paths. Other event sources (like signals or key events) may still be used.

-W, --watch-non-recursive <PATH>
    Watch a specific directory, non-recursively Unlike '-w', folders watched with this option are not recursed into. This option can be specified multiple times to watch multiple directories non-recursively.

-F, --watch-file <PATH>
    Watch files and directories from a file Each line in the file will be interpreted as if given to '-w'. For more complex uses (like watching non-recursively), use the argfile capability: build a file containing command-line options and pass it to watchexec with `@path/to/argfile`. The special value '-' will read from STDIN; this in incompatible with '--stdin-quit'.

-c, --clear <MODE>
    Clear screen before running command If this doesn't completely clear the screen, try '--clear=reset'.

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

-r, --restart
    Restart the process if it's still running This is a shorthand for '--on-busy-update=restart'.

-s, --signal <SIGNAL>
    Send a signal to the process when it's still running Specify a signal to send to the process when it's still running. This implies '--on-busy-update=signal'; otherwise the signal used when that mode is 'restart' is controlled by '--stop-signal'. See the long documentation for '--stop-signal' for syntax. Signals are not supported on Windows at the moment, and will always be overridden to 'kill'. See '--stop-signal' for more on Windows "signals".

--stop-signal <SIGNAL>
    Signal to send to stop the command This is used by 'restart' and 'signal' modes of '--on-busy-update' (unless '--signal' is provided). The restart behaviour is to send the signal, wait for the command to exit, and if it hasn't exited after some time (see '--timeout-stop'), forcefully terminate it. The default on unix is "SIGTERM". Input is parsed as a full signal name (like "SIGTERM"), a short signal name (like "TERM"), or a signal number (like "15"). All input is case-insensitive. On Windows this option is technically supported but only supports the "KILL" event, as Watchexec cannot yet deliver other events. Windows doesn't have signals as such; instead it has termination (here called "KILL" or "STOP") and "CTRL+C", "CTRL+BREAK", and "CTRL+CLOSE" events. For portability the unix signals "SIGKILL", "SIGINT", "SIGTERM", and "SIGHUP" are respectively mapped to these.

--stop-timeout <TIMEOUT>
    Time to wait for the command to exit gracefully This is used by the 'restart' mode of '--on-busy-update'. After the graceful stop signal is sent, Watchexec will wait for the command to exit. If it hasn't exited after this time, it is forcefully terminated. Takes a unit-less value in seconds, or a time span value such as "5min 20s". Providing a unit-less value is deprecated and will warn; it will be an error in the future. The default is 10 seconds. Set to 0 to immediately force-kill the command. This has no practical effect on Windows as the command is always forcefully terminated; see '--stop-signal' for why.

--map-signal <SIGNAL:SIGNAL>
    Translate signals from the OS to signals to send to the command Takes a pair of signal names, separated by a colon, such as "TERM:INT" to map SIGTERM to SIGINT. The first signal is the one received by watchexec, and the second is the one sent to the command. The second can be omitted to discard the first signal, such as "TERM:" to not do anything on SIGTERM. If SIGINT or SIGTERM are mapped, then they no longer quit Watchexec. Besides making it hard to quit Watchexec itself, this is useful to send pass a Ctrl-C to the command without also terminating Watchexec and the underlying program with it, e.g. with "INT:INT". This option can be specified multiple times to map multiple signals. Signal syntax is case-insensitive for short names (like "TERM", "USR2") and long names (like "SIGKILL", "SIGHUP"). Signal numbers are also supported (like "15", "31"). On Windows, the forms "STOP", "CTRL+C", and "CTRL+BREAK" are also supported to receive, but Watchexec cannot yet deliver other "signals" than a STOP.

-d, --debounce <TIMEOUT>
    Time to wait for new events before taking action When an event is received, Watchexec will wait for up to this amount of time before handling it (such as running the command). This is essential as what you might perceive as a single change may actually emit many events, and without this behaviour, Watchexec would run much too often. Additionally, it's not infrequent that file writes are not atomic, and each write may emit an event, so this is a good way to avoid running a command while a file is partially written. An alternative use is to set a high value (like "30min" or longer), to save power or bandwidth on intensive tasks, like an ad-hoc backup script. In those use cases, note that every accumulated event will build up in memory. Takes a unit-less value in milliseconds, or a time span value such as "5sec 20ms". Providing a unit-less value is deprecated and will warn; it will be an error in the future. The default is 50 milliseconds. Setting to 0 is highly discouraged.

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

--no-vcs-ignore
    Don't load gitignores Among other VCS exclude files, like for Mercurial, Subversion, Bazaar, DARCS, Fossil. Note that Watchexec will detect which of these is in use, if any, and only load the relevant files. Both global (like '~/.gitignore') and local (like '.gitignore') files are considered. This option is useful if you want to watch files that are ignored by Git.

--no-project-ignore
    Don't load project-local ignores This disables loading of project-local ignore files, like '.gitignore' or '.ignore' in the watched project. This is contrasted with '--no-vcs-ignore', which disables loading of Git and other VCS ignore files, and with '--no-global-ignore', which disables loading of global or user ignore files, like '~/.gitignore' or '~/.config/watchexec/ignore'. Supported project ignore files:
      - Git: .gitignore at project root and child directories, .git/info/exclude, and the file pointed to by `core.excludesFile` in .git/config.
      - Mercurial: .hgignore at project root and child directories.
      - Bazaar: .bzrignore at project root.
      - Darcs: _darcs/prefs/boring
      - Fossil: .fossil-settings/ignore-glob
      - Ripgrep/Watchexec/generic: .ignore at project root and child directories. VCS ignore files (Git, Mercurial, Bazaar, Darcs, Fossil) are only used if the corresponding VCS is discovered to be in use for the project/origin. For example, a .bzrignore in a Git repository will be discarded.

--no-global-ignore
    Don't load global ignores This disables loading of global or user ignore files, like '~/.gitignore', '~/.config/watchexec/ignore', or '%APPDATA%\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.

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

--no-discover-ignore
    Don't discover ignore files at all This is a shorthand for '--no-global-ignore', '--no-vcs-ignore', '--no-project-ignore', but even more efficient as it will skip all the ignore discovery mechanisms from the get go. Note that default ignores are still loaded, see '--no-default-ignore'.

--ignore-nothing
    Don't ignore anything at all This is a shorthand for '--no-discover-ignore', '--no-default-ignore'. Note that ignores explicitly loaded via other command line options, such as '--ignore' or '--ignore-file', will still be used.

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

--delay-run <DURATION>
    Sleep before running the command This option will cause Watchexec to sleep for the specified amount of time before running the command, after an event is detected. This is like using "sleep 5 && command" in a shell, but portable and slightly more efficient. Takes a unit-less value in seconds, or a time span value such as "2min 5s". Providing a unit-less value is deprecated and will warn; it will be an error in the future.

--poll <INTERVAL>
    Poll for filesystem changes By default, and where available, Watchexec uses the operating system's native file system watching capabilities. This option disables that and instead uses a polling mechanism, which is less efficient but can work around issues with some file systems (like network shares) or edge cases. Optionally takes a unit-less value in milliseconds, or a time span value such as "2s 500ms", to use as the polling interval. If not specified, the default is 30 seconds. Providing a unit-less value is deprecated and will warn; it will be an error in the future. Aliased as '--force-poll'.

--shell <SHELL>
    Use a different shell By default, Watchexec will use '$SHELL' if it's defined or a default of 'sh' on Unix-likes, and either 'pwsh', 'powershell', or 'cmd' (CMD.EXE) on Windows, depending on what Watchexec detects is the running shell. With this option, you can override that and use a different shell, for example one with more features or one which has your custom aliases and functions. If the value has spaces, it is parsed as a command line, and the first word used as the shell program, with the rest as arguments to the shell. The command is run with the '-c' flag (except for 'cmd' on Windows, where it's '/C'). The special value 'none' can be used to disable shell use entirely. In that case, the command provided to Watchexec will be parsed, with the first word being the executable and the rest being the arguments, and executed directly. Note that this parsing is rudimentary, and may not work as expected in all cases. Using 'none' is a little more efficient and can enable a stricter interpretation of the input, but it also means that you can't use shell features like globbing, redirection, control flow, logic, or pipes. Examples: Use without shell: $ watchexec -n -- zsh -x -o shwordsplit scr Use with powershell core: $ watchexec --shell=pwsh -- Test-Connection localhost Use with CMD.exe: $ watchexec --shell=cmd -- dir Use with a different unix shell: $ watchexec --shell=bash -- 'echo $BASH_VERSION' Use with a unix shell and options: $ watchexec --shell='zsh -x -o shwordsplit' -- scr

-n  Shorthand for '--shell=none'

--emit-events-to <MODE>
    Configure event emission Watchexec can emit event information when running a command, which can be used by the child process to target specific changed files. One thing to take care with is assuming inherent behaviour where there is only chance. Notably, it could appear as if the `RENAMED` variable contains both the original and the new path being renamed. In previous versions, it would even appear on some platforms as if the original always came before the new. However, none of this was true. It's impossible to reliably and portably know which changed path is the old or new, "half" renames may appear (only the original, only the new), "unknown" renames may appear (change was a rename, but whether it was the old or new isn't known), rename events might split across two debouncing boundaries, and so on. This option controls where that information is emitted. It defaults to 'none', which doesn't emit event information at all. The other options are 'environment' (deprecated), 'stdio', 'file', 'json-stdio', and 'json-file'. The 'stdio' and 'file' modes are text-based: 'stdio' writes absolute paths to the stdin of the command, one per line, each prefixed with `create:`, `remove:`, `rename:`, `modify:`, or `other:`, then closes the handle; 'file' writes the same thing to a temporary file, and its path is given with the $WATCHEXEC_EVENTS_FILE environment variable. There are also two JSON modes, which are based on JSON objects and can represent the full set of events Watchexec handles. Here's an example of a folder being created on Linux: ```json
      {
        "tags": [
          {
            "kind": "path",
            "absolute": "/home/user/your/new-folder",
            "filetype": "dir"
          },
          {
            "kind": "fs",
            "simple": "create",
            "full": "Create(Folder)"
          },
          {
            "kind": "source",
            "source": "filesystem",
          }
        ],
        "metadata": {
          "notify-backend": "inotify"
        }
      } ``` The fields are as follows:
      - `tags`, structured event data.
      - `tags[].kind`, which can be:
        * 'path', along with:
          + `absolute`, an absolute path.
          + `filetype`, a file type if known ('dir', 'file', 'symlink', 'other').
        * 'fs':
          + `simple`, the "simple" event type ('access', 'create', 'modify', 'remove', or 'other').
          + `full`, the "full" event type, which is too complex to fully describe here, but looks like 'General(Precise(Specific))'.
        * 'source', along with:
          + `source`, the source of the event ('filesystem', 'keyboard', 'mouse', 'os', 'time', 'internal').
        * 'keyboard', along with:
          + `keycode`. Currently only the value 'eof' is supported.
        * 'process', for events caused by processes:
          + `pid`, the process ID.
        * 'signal', for signals sent to Watchexec:
          + `signal`, the normalised signal name ('hangup', 'interrupt', 'quit', 'terminate', 'user1', 'user2').
        * 'completion', for when a command ends:
          + `disposition`, the exit disposition ('success', 'error', 'signal', 'stop', 'exception', 'continued').
          + `code`, the exit, signal, stop, or exception code.
      - `metadata`, additional information about the event. The 'json-stdio' mode will emit JSON events to the standard input of the command, one per line, then close stdin. The 'json-file' mode will create a temporary file, write the events to it, and provide the path to the file with the $WATCHEXEC_EVENTS_FILE environment variable. Finally, the 'environment' mode was the default until 2.0. It sets environment variables with the paths of the affected files, for filesystem events: $WATCHEXEC_COMMON_PATH is set to the longest common path of all of the below variables, and so should be prepended to each path to obtain the full/real path. Then:
      - $WATCHEXEC_CREATED_PATH is set when files/folders were created
      - $WATCHEXEC_REMOVED_PATH is set when files/folders were removed
      - $WATCHEXEC_RENAMED_PATH is set when files/folders were renamed
      - $WATCHEXEC_WRITTEN_PATH is set when files/folders were modified
      - $WATCHEXEC_META_CHANGED_PATH is set when files/folders' metadata were modified
      - $WATCHEXEC_OTHERWISE_CHANGED_PATH is set for every other kind of pathed event Multiple paths are separated by the system path separator, ';' on Windows and ':' on unix. Within each variable, paths are deduplicated and sorted in binary order (i.e. neither Unicode nor locale aware). This is the legacy mode, is deprecated, and will be removed in the future. The environment is a very restricted space, while also limited in what it can usefully represent. Large numbers of files will either cause the environment to be truncated, or may error or crash the process entirely. The $WATCHEXEC_COMMON_PATH is also unintuitive, as demonstrated by the multiple confused queries that have landed in my inbox over the years.

--only-emit-events
    Only emit events to stdout, run no commands. This is a convenience option for using Watchexec as a file watcher, without running any commands. It is almost equivalent to using `cat` as the command, except that it will not spawn a new process for each event. This option requires `--emit-events-to` to be set, and restricts the available modes to `stdio` and `json-stdio`, modifying their behaviour to write to stdout instead of the stdin of the command.

-E, --env <KEY=VALUE>
    Add env vars to the command This is a convenience option for setting environment variables for the command, without setting them for the Watchexec process itself. Use key=value syntax. Multiple variables can be set by repeating the option.

--wrap-process <MODE>
    Configure how the process is wrapped By default, Watchexec will run the command in a process group in Unix, and in a Job Object in Windows. Some Unix programs prefer running in a session, while others do not work in a process group. Use 'group' to use a process group, 'session' to use a process session, and 'none' to run the command directly. On Windows, either of 'group' or 'session' will use a Job Object.

-N, --notify
    Alert when commands start and end With this, Watchexec will emit a desktop notification when a command starts and ends, on supported platforms. On unsupported platforms, it may silently do nothing, or log a warning.

--color <MODE>
    When to use terminal colours Setting the environment variable `NO_COLOR` to any value is equivalent to `--color=never`.

--timings
    Print how long the command took to run This may not be exactly accurate, as it includes some overhead from Watchexec itself. Use the `time` utility, high-precision timers, or benchmarking tools for more accurate results.

-q, --quiet
    Don't print starting and stopping messages By default Watchexec will print a message when the command starts and stops. This option disables this behaviour, so only the command's output, warnings, and errors will be printed.

--bell
    Ring the terminal bell on command completion

--project-origin <DIRECTORY>
    Set the project origin Watchexec will attempt to discover the project's "origin" (or "root") by searching for a variety of markers, like files or directory patterns. It does its best but sometimes gets it it wrong, and you can override that with this option. The project origin is used to determine the path of certain ignore files, which VCS is being used, the meaning of a leading '/' in filtering patterns, and maybe more in the future. When set, Watchexec will also not bother searching, which can be significantly faster.

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

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

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

--filter-file <PATH>
    Files to load filters from Provide a path to a file containing filters, one per line. Empty lines and lines starting with '#' are ignored. Uses the same pattern format as the '--filter' option. This can also be used via the $WATCHEXEC_FILTER_FILES environment variable.

-J, --filter-prog <EXPRESSION>
    [experimental] Filter programs. /!\ This option is EXPERIMENTAL and may change and/or vanish without notice. Provide your own custom filter programs in jaq (similar to jq) syntax. Programs are given an event in the same format as described in '--emit-events-to' and must return a boolean. Invalid programs will make watchexec fail to start; use '-v' to see program runtime errors. In addition to the jaq stdlib, watchexec adds some custom filter definitions: - 'path | file_meta' returns file metadata or null if the file does not exist. - 'path | file_size' returns the size of the file at path, or null if it does not exist. - 'path | file_read(bytes)' returns a string with the first n bytes of the file at path. If the file is smaller than n bytes, the whole file is returned. There is no filter to read the whole file at once to encourage limiting the amount of data read and processed. - 'string | hash', and 'path | file_hash' return the hash of the string or file at path. No guarantee is made about the algorithm used: treat it as an opaque value. - 'any | kv_store(key)', 'kv_fetch(key)', and 'kv_clear' provide a simple key-value store. Data is kept in memory only, there is no persistence. Consistency is not guaranteed. - 'any | printout', 'any | printerr', and 'any | log(level)' will print or log any given value to stdout, stderr, or the log (levels = error, warn, info, debug, trace), and pass the value through (so '[1] | log("debug") | .[]' will produce a '1' and log '[1]'). All filtering done with such programs, and especially those using kv or filesystem access, is much slower than the other filtering methods. If filtering is too slow, events will back up and stall watchexec. Take care when designing your filters. If the argument to this option starts with an '@', the rest of the argument is taken to be the path to a file containing a jaq program. Jaq programs are run in order, after all other filters, and short-circuit: if a filter (jaq or not) rejects an event, execution stops there, and no other filters are run. Additionally, they stop after outputting the first value, so you'll want to use 'any' or 'all' when iterating, otherwise only the first item will be processed, which can be quite confusing! Find user-contributed programs or submit your own useful ones at <https://github.com/watchexec/watchexec/discussions/592>. ## Examples: Regexp ignore filter on paths: 'all(.tags[] | select(.kind == "path"); .absolute | test("[.]test[.]js$")) | not' Pass any event that creates a file: 'any(.tags[] | select(.kind == "fs"); .simple == "create")' Pass events that touch executable files: 'any(.tags[] | select(.kind == "path" && .filetype == "file"); .absolute | metadata | .executable)' Ignore files that start with shebangs: 'any(.tags[] | select(.kind == "path" && .filetype == "file"); .absolute | read(2) == "#!") | not'

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

--ignore-file <PATH>
    Files to load ignores from Provide a path to a file containing ignores, one per line. Empty lines and lines starting with '#' are ignored. Uses the same pattern format as the '--ignore' option. This can also be used via the $WATCHEXEC_IGNORE_FILES environment variable.

--fs-events <EVENTS>
    Filesystem events to filter to This is a quick filter to only emit events for the given types of filesystem changes. Choose from 'access', 'create', 'remove', 'rename', 'modify', 'metadata'. Multiple types can be given by repeating the option or by separating them with commas. By default, this is all types except for 'access'. This may apply filtering at the kernel level when possible, which can be more efficient, but may be more confusing when reading the logs.

--no-meta
    Don't emit fs events for metadata changes This is a shorthand for '--fs-events create,remove,rename,modify'. Using it alongside the '--fs-events' option is non-sensical and not allowed.

--print-events
    Print events that trigger actions This prints the events that triggered the action when handling it (after debouncing), in a human readable form. This is useful for debugging filters. Use '-vvv' instead when you need more diagnostic information.

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

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

<ARGS>
    Task and arguments to run

MISE WHERE
Display the installation path for a tool The tool must be installed for this to work.

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

Arguments:

<TOOL@VERSION>
    Tool(s) to look up e.g.: ruby@3 if "@<PREFIX>" is specified, it will show the latest installed version that matches the prefix otherwise, it will show the current, active installed version

<ASDF_VERSION>
    the version prefix to use when querying the latest version same as the first argument after the "@" used for asdf compatibility

MISE WHICH
Shows the path that a tool's bin points to. Use this to figure out what version of a tool is currently active.

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

Options:

-t, --tool <TOOL@VERSION>
    Use a specific tool@version e.g.: `mise which npm --tool=node@20`

--complete

--plugin
    Show the plugin name instead of the path

--version
    Show the version instead of the path Arguments:

<BIN_NAME>
    The bin to look up