mise (SchemaStore) JSON Schema

Type	object
File match	`.mise.toml` `.mise..toml` `mise.toml` `mise..toml` `/.mise/config.toml` `/.mise/config..toml` `/.mise/conf.d/.toml` `/mise/config.toml` `/mise/config..toml` `/mise/conf.d/.toml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/mise/latest.json
Source	https://mise.jdx.dev/schema/mise.json

Validate with Lintel

npx @lintel/lintel check

Type: object

config file for mise version manager (mise.toml)

Properties

alias Record<string, string | object>

custom shorthands

tool_alias Record<string, string | object>

Tool version aliases

shell_alias Record<string, string>

shell aliases

env env | env[]

environment variables to set

experimental_monorepo_root boolean

Marks this config as a monorepo root, enabling target path syntax for tasks. Requires MISE_EXPERIMENTAL=1. When enabled, tasks can be referenced with paths like //projects/frontend:build

monorepo object

Configuration for monorepo task discovery

1 nested properties

config_roots string[]

Explicit list of config root paths for monorepo task discovery. Supports single-level glob patterns (*). When set, skips filesystem walking for better performance.

min_version string | object

minimum version of mise required to use this config

redactions string[]

env or vars keys to redact from logs

plugins Record<string, string>

plugins to use

prepare Record<string, object>

configure prepare providers

11 nested properties

disable string[]

Disable specific prepare providers

npm object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

yarn object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

pnpm object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

bun object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

go object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

pip object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

poetry object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

uv object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

bundler object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

composer object

Prepare provider configuration

9 nested properties

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

settings object

126 nested properties

activate_aggressive boolean

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

age object

4 nested properties

identity_files string[]

[experimental] List of age identity files to use for decryption.

key_file string

[experimental] Path to the age private key file to use for encryption/decryption.

ssh_identity_files string[]

[experimental] List of SSH identity files to use for age decryption.

strict boolean

If true, fail when age decryption fails (including when age is not available, the key is missing, or the key is invalid). If false, skip decryption and continue in these cases.

Default: true

all_compile boolean

do not use precompiled binaries for any tool

always_keep_download boolean

should mise keep downloaded files after installation

always_keep_install boolean

should mise keep install files after installation even if the installation fails

aqua object

7 nested properties

baked_registry boolean

Use baked-in aqua registry.

Default: true

cosign boolean

Use cosign to verify aqua tool signatures.

Default: true

cosign_extra_args string[]

Extra arguments to pass to cosign when verifying aqua tool signatures.

github_attestations boolean

Enable GitHub Artifact Attestations verification for aqua tools.

Default: true

minisign boolean

Use minisign to verify aqua tool signatures.

Default: true

registry_url string

URL to fetch aqua registry from.

slsa boolean

Use SLSA to verify aqua tool signatures.

Default: true

arch string

Architecture to use for precompiled binaries.

asdf_compat boolean

set to true to ensure .tool-versions will be compatible with asdf

auto_install boolean

Automatically install missing tools when running mise x, mise run, or as part of the 'not found' handler.

Default: true

auto_install_disable_tools string[]

List of tools to skip automatically installing when running mise x, mise run, or as part of the 'not found' handler.

cache_prune_age string

Delete files in cache that have not been accessed in this duration

Default: "30d"

cargo object

3 nested properties

binstall boolean

Use cargo-binstall instead of cargo install if available

Default: true

binstall_only boolean

Only use cargo-binstall for installation, fail if not available.

Default: false

registry_name string

Name of the cargo registry to use.

cd string

Path to change to after launching mise

ceiling_paths string[]

Directories where mise stops searching for config files.

Default:

[]

ci boolean

Set to true if running in a CI environment

Default: "false"

color boolean

Use color in mise terminal output

Default: true

color_theme string

Theme for interactive prompts (default/charm, base16, catppuccin, dracula)

Default: "default"

Values: "default" "charm" "base16" "catppuccin" "dracula"

conda object

1 nested properties

channel string

Default channel for conda packages.

Default: "conda-forge"

debug boolean

Sets log level to debug

default_config_filename string

The default config filename read. mise use and other commands that create new config files will use this value. This must be an env var.

Default: "mise.toml"

default_tool_versions_filename string

The default .tool-versions filename read. This will not ignore .tool-versions—use override_tool_versions_filename for that. This must be an env var.

Default: ".tool-versions"

disable_backends string[]

Backends to disable such as asdf or pipx

Default:

[]

disable_default_registry boolean

Disable the default mapping of short tool names like php -> asdf:mise-plugins/asdf-php. This parameter disables only for the backends vfox and asdf.

disable_hints string[]

Turns off helpful hints when using different mise features

Default:

[]

disable_tools string[]

Tools defined in mise.toml that should be ignored

Default:

[]

dotnet object

5 nested properties

cli_telemetry_optout boolean

Set DOTNET_CLI_TELEMETRY_OPTOUT to opt out of .NET CLI telemetry.

dotnet_root string

Path to the shared .NET SDK root directory.

isolated boolean

Install each .NET SDK version in its own isolated directory.

Default: false

package_flags string[]

Extends dotnet search and install abilities.

Default:

[]

registry_url string

URL to fetch dotnet tools from.

Default: "https://api.nuget.org/v3/index.json"

enable_tools string[]

Tools defined in mise.toml that should be used - all other tools are ignored

Default:

[]

env string[]

Env to use for mise.<MISE_ENV>.toml files.

Default:

[]

env_cache boolean

[experimental] Enable environment caching for nested mise invocations

Default: false

env_cache_ttl string

TTL for cached environments

Default: "1h"

env_file string

Path to a file containing environment variables to automatically load.

env_shell_expand boolean

Enable shell-style variable expansion in env values (e.g., $FOO, ${BAR:-default})

erlang object

1 nested properties

compile boolean

If true, compile erlang from source. If false, use precompiled binaries. If not set, use precompiled binaries if available.

exec_auto_install boolean

Automatically install missing tools when running mise x.

Default: true

experimental boolean

Enable experimental mise features which are incomplete or unstable—breakings changes may occur

fetch_remote_versions_cache string

How long to cache remote versions for tools.

Default: "1h"

fetch_remote_versions_timeout string

Timeout in seconds for HTTP requests to fetch new tool versions in mise.

Default: "20s"

forgejo object

3 nested properties

credential_command string

Shell command to run to obtain a Forgejo token for mise.

Default: ""

fj_cli_tokens boolean

Read Forgejo tokens from the fj CLI config.

Default: true

use_git_credentials boolean

Use git credential helpers to obtain Forgejo tokens.

Default: false

github object

5 nested properties

credential_command string

Shell command to run to obtain a GitHub token for mise.

Default: ""

gh_cli_tokens boolean

Read GitHub tokens from the gh CLI's hosts.yml config.

Default: true

github_attestations boolean

Enable GitHub Artifact Attestations verification for github backend tools.

Default: true

slsa boolean

Enable SLSA provenance verification for github backend tools.

Default: true

use_git_credentials boolean

Use git credential helpers to obtain GitHub tokens.

Default: false

github_attestations boolean

Enable GitHub Artifact Attestations verification for supported tools.

Default: true

gitlab object

3 nested properties

credential_command string

Shell command to run to obtain a GitLab token for mise.

Default: ""

glab_cli_tokens boolean

Read GitLab tokens from the glab CLI config.

Default: true

use_git_credentials boolean

Use git credential helpers to obtain GitLab tokens.

Default: false

gix boolean

Use gix for git operations, set to false to shell out to git.

Default: true

global_config_file string

Path to the global mise config file. Default is ~/.config/mise/config.toml. This must be an env var.

global_config_root string

Path which is used as {{config_root}} for the global config file. Default is $HOME. This must be an env var.

go object

7 nested properties

default_packages_file string

Path to a file containing default go packages to install when installing go.

Default: "~/.default-go-packages"

download_mirror string

Mirror to download go sdk tarballs from.

Default: "https://dl.google.com/go"

repo string

URL to fetch go from.

Default: "https://github.com/golang/go"

set_gobin boolean

Changes where go install installs binaries to.

set_gopath boolean

[deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages.

set_goroot boolean

Sets GOROOT=~/.local/share/mise/installs/go/.../.

Default: true

skip_checksum boolean

Set to true to skip checksum verification when downloading go sdk tarballs.

go_default_packages_file string

Path to a file containing default go packages to install when installing go.

go_download_mirror string

Mirror to download go sdk tarballs from.

go_repo string

URL to fetch go from.

go_set_gobin boolean

Changes where go install installs binaries to.

go_set_gopath boolean

[deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages.

go_set_goroot boolean

Sets GOROOT=~/.local/share/mise/installs/go/.../.

go_skip_checksum boolean

Set to true to skip checksum verification when downloading go sdk tarballs.

gpg_verify boolean

Use gpg to verify all tool signatures.

hook_env object

2 nested properties

cache_ttl string

Cache hook-env directory checks for this duration. Useful for slow filesystems like NFS.

Default: "0s"

chpwd_only boolean

Only run hook-env checks on directory change, not on every prompt.

Default: false

http_retries number

Number of retries for HTTP requests in mise.

Default: 0

http_timeout string

Timeout in seconds for all HTTP requests in mise.

Default: "30s"

idiomatic_version_file boolean

Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc.

idiomatic_version_file_disable_tools string[]

Specific tools to disable idiomatic version files for.

Default:

[]

idiomatic_version_file_enable_tools string[]

Specific tools to enable idiomatic version files for like .node-version, .ruby-version, etc.

Default:

[]

ignored_config_paths string[]

This is a list of config paths that mise will ignore.

Default:

[]

install_before string

Minimum release age / supply chain protection — only install versions released before this date

java object

1 nested properties

shorthand_vendor string

Shorthand for Java. Used when installing Java without a vendor prefix.

Default: "openjdk"

jobs number

How many jobs to run concurrently such as tool installs.

Default: 8

legacy_version_file boolean

Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc.

Default: true

legacy_version_file_disable_tools string[]

Specific tools to disable idiomatic version files for.

Default:

[]

libgit2 boolean

Use libgit2 for git operations, set to false to shell out to git.

Default: true

locked boolean

Require lockfile URLs to be present during installation.

Default: false

locked_verify_provenance boolean

Re-verify provenance at install time even when the lockfile already has provenance.

Default: false

lockfile boolean

Create and read lockfiles for tool versions.

log_level string

Show more/less output.

Default: "info"

Values: "trace" "debug" "info" "warn" "error"

netrc boolean

Use a netrc file for HTTP Basic authentication.

Default: true

netrc_file string

Path to the netrc file to use for HTTP Basic authentication.

no_env boolean

Do not load environment variables from config files.

no_hooks boolean

Do not execute hooks from config files.

node object

16 nested properties

cflags string

Additional CFLAGS options (e.g., to override -O3).

compile boolean

Compile node from source.

concurrency number

How many jobs should be used in compilation.

configure_opts string

Additional ./configure options.

corepack boolean

Installs the default corepack shims after installing any node version.

default_packages_file string

Path to a file containing default npm packages to install.

flavor string

Install a specific node flavor like glibc-217 or musl. Use with unofficial node build repo.

gpg_verify boolean

Use gpg to verify node tool signatures.

make string

Make command to use.

make_install_opts string

Additional make install options.

make_opts string

Additional make options.

mirror_url string

Mirror to download node tarballs from.

ninja boolean

Use ninja instead of make to compile node.

nodenv_root string

Directory for nodenv.

Default: "~/.nodenv"

nvm_dir string

Directory for nvm.

Default: "~/.nvm"

verify boolean

Verify the downloaded assets using GPG.

Default: true

not_found_auto_install boolean

Set to false to disable the "command not found" handler to autoinstall missing tool versions.

Default: true

npm object

2 nested properties

bun boolean

Use bun instead of npm if bun is installed and on PATH.

package_manager string

Package manager to use for installing npm packages.

Default: "npm"

Values: "npm" "bun" "pnpm"

offline boolean

Disable all HTTP requests. Tools will only use locally cached data.

os string

OS to use for precompiled binaries.

override_config_filenames string[]

If set, mise will ignore default config files like mise.toml and use these filenames instead.

Default:

[]

override_tool_versions_filenames string[]

If set, mise will ignore .tool-versions files and use these filenames instead. Can be set to none to disable .tool-versions.

Default:

[]

paranoid boolean

Enables extra-secure behavior.

pin boolean

Default to pinning versions when running mise use in mise.toml files.

pipx object

2 nested properties

registry_url string

URL to use for pipx registry.

Default: "https://pypi.org/pypi/{}/json"

uvx boolean

Use uvx instead of pipx if uv is installed and on PATH.

plugin_autoupdate_last_check_duration string

How long to wait before updating plugins automatically (note this isn't currently implemented).

Default: "7d"

prefer_offline boolean

Prefer locally cached data over remote fetches when possible.

profile string

Profile to use for mise.${MISE_PROFILE}.toml files.

python object

13 nested properties

compile boolean

If true, compile python from source. If false, use precompiled binaries. If not set, use precompiled binaries if available.

default_packages_file string

Path to a file containing default python packages to install when installing a python version.

github_attestations boolean

Enable GitHub Artifact Attestations verification for precompiled Python binaries.

patch_url string

URL to fetch python patches from to pass to python-build.

patches_directory string

Directory to fetch python patches from.

precompiled_arch string

Specify the architecture to use for precompiled binaries.

precompiled_flavor string

Specify the flavor to use for precompiled binaries.

precompiled_os string

Specify the OS to use for precompiled binaries.

pyenv_repo string

URL to fetch pyenv from for compiling python with python-build.

Default: "https://github.com/pyenv/pyenv.git"

uv_venv_auto boolean | string

Integrate with uv to manage project venvs when uv.lock is present.

Default: false

Values: false "source" "create|source" true

uv_venv_create_args string[]

Arguments to pass to uv when creating a venv.

venv_create_args string[]

Arguments to pass to python when creating a venv. (not used for uv venv creation)

venv_stdlib boolean

Prefer to use venv from Python's standard library.

quiet boolean

Suppress all output except errors.

raw boolean

Connect stdin/stdout/stderr to child processes.

ruby object

13 nested properties

apply_patches string

A list of patch files or URLs to apply to ruby source.

compile boolean

Set to true to compile ruby from source, false to use precompiled binaries.

default_packages_file string

Path to a file containing default ruby gems to install when installing ruby.

Default: "~/.default-gems"

github_attestations boolean

Enable GitHub Artifact Attestations verification for precompiled Ruby binaries.

precompiled_arch string

Override architecture identifier for precompiled Ruby binaries.

precompiled_os string

Override OS identifier for precompiled Ruby binaries.

precompiled_url string

URL template or GitHub repo for precompiled Ruby binaries.

Default: "jdx/ruby"

ruby_build_opts string

Options to pass to ruby-build.

ruby_build_repo string

The URL used to fetch ruby-build. This accepts either a Git repository or a ZIP archive.

Default: "https://github.com/rbenv/ruby-build.git"

ruby_install boolean

Use ruby-install instead of ruby-build.

ruby_install_opts string

Options to pass to ruby-install.

ruby_install_repo string

The URL used to fetch ruby-install. This accepts either a Git repository or a ZIP archive.

Default: "https://github.com/postmodern/ruby-install.git"

verbose_install boolean

Set to true to enable verbose output during ruby installation.

rust object

3 nested properties

cargo_home string

Path to the cargo home directory. Defaults to ~/.cargo or %USERPROFILE%\.cargo

default_host string

Default host triple to pass to rustup init via --default-host.

rustup_home string

Path to the rustup home directory. Defaults to ~/.rustup or %USERPROFILE%\.rustup

shared_install_dirs string[]

[experimental] Additional read-only directories to search for installed tool versions.

shorthands_file string

Path to a file containing custom tool shorthands.

silent boolean

Suppress all mise run|watch output except errors—including what tasks output.

slsa boolean

Enable SLSA provenance verification globally.

Default: true

sops object

5 nested properties

age_key string

The age private key to use for sops secret decryption. Takes precedence over standard SOPS_AGE_KEY environment variable.

age_key_file string

Path to the age private key file for sops secret decryption. Takes precedence over standard SOPS_AGE_KEY_FILE environment variable.

age_recipients string

The age public keys to use for sops secret encryption.

rops boolean

Use rops to decrypt sops files. Disable to shell out to sops which will slow down mise but sops may offer features not available in rops.

Default: true

strict boolean

If true, fail when sops decryption fails (including when sops is not available, the key is missing, or the key is invalid). If false, skip decryption and continue in these cases.

Default: true

status object

5 nested properties

missing_tools string

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

Default: "if_other_versions_installed"

show_env boolean

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

show_prepare_stale boolean

Show warning when prepare providers have stale dependencies.

Default: true

show_tools boolean

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

truncate boolean

Truncate status messages.

Default: true

swift object

2 nested properties

gpg_verify boolean

Use gpg to verify swift tool signatures.

platform string

Override the platform to use for precompiled binaries.

system_config_file string

Path to the system mise config file. Default is /etc/mise/config.toml. This must be an env var.

task object

15 nested properties

disable_paths string[]

Paths that mise will not look for tasks in.

Default:

[]

disable_spec_from_run_scripts boolean

Opt out of parsing task run scripts to infer the usage spec (arguments and flags). When enabled, mise will derive the usage spec only from the usage field, ignoring any arg(), option(), or flag() templates used in run scripts. This can restore previous behavior and avoid the extra template pass over run scripts when collecting specs.

Default: false

monorepo_depth number

Maximum depth to search for task files in monorepo subdirectories.

Default: 5

monorepo_exclude_dirs string[]

Directory patterns to exclude when discovering monorepo subdirectories.

Default:

[]

monorepo_respect_gitignore boolean

Whether to respect .gitignore files when discovering monorepo subdirectories.

Default: true

output string

Change output style when executing tasks.

Values: "prefix" "interleave" "keep-order" "replacing" "timed" "quiet" "silent"

remote_no_cache boolean

Mise will always fetch the latest tasks from the remote, by default the cache is used.

run_auto_install boolean

Automatically install missing tools when executing tasks.

Default: true

show_full_cmd boolean

Disable truncation of command lines in task execution output. When true, the full command line will be shown.

skip string[]

Tasks to skip when running mise run.

Default:

[]

skip_depends boolean

Run only specified tasks skipping all dependencies.

source_freshness_equal_mtime_is_fresh boolean

When source mtime equals output mtime, consider sources fresh (use <=). Default false uses strict < comparison.

Default: false

source_freshness_hash_contents boolean

Use content hashing (blake3) instead of metadata for source freshness. More accurate but slower.

Default: false

timeout string

Default timeout for tasks.

timings boolean

Show completion message with elapsed time for each task on mise run. Default shows when output type is prefix.

task_disable_paths string[]

Paths that mise will not look for tasks in.

task_output string

Change output style when executing tasks.

task_remote_no_cache boolean

Mise will always fetch the latest tasks from the remote, by default the cache is used.

task_run_auto_install boolean

Automatically install missing tools when executing tasks.

task_show_full_cmd boolean

Disable truncation of command lines in task execution output. When true, the full command line will be shown.

task_skip string[]

Tasks to skip when running mise run.

task_skip_depends boolean

Run only specified tasks skipping all dependencies.

task_timeout string

Default timeout for tasks. Can be overridden by individual tasks.

task_timings boolean

Show completion message with elapsed time for each task on mise run. Default shows when output type is prefix.

terminal_progress boolean

Enable terminal progress indicators (OSC 9;4) for compatible terminals.

Default: true

trace boolean

Sets log level to trace

trusted_config_paths string[]

This is a list of config paths that mise will automatically mark as trusted. Any config files under these paths will be trusted without prompting. Set to ["/"] to trust all config files, effectively disabling the trust mechanism.

Default:

[]

unix_default_file_shell_args string

Default shell arguments for Unix to be used for file commands. For example, sh for sh.

Default: "sh"

unix_default_inline_shell_args string

Default shell arguments for Unix to be used for inline commands. For example, sh -c for sh.

Default: "sh -c -o errexit"

url_replacements Record<string, string>

Map of URL patterns to replacement URLs applied to all requests.

use_file_shell_for_executable_tasks boolean

Determines whether to use a specified shell for executing tasks in the tasks directory. When set to true, the shell defined in the file will be used, or the default shell specified by windows_default_file_shell_args or unix_default_file_shell_args will be applied. If set to false, tasks will be executed directly as programs.

Default: false

use_versions_host boolean

Set to false to disable using the mise-versions API as a quick way for mise to query for new versions.

Default: true

use_versions_host_track boolean

Send anonymous download statistics when installing tools.

Default: true

verbose boolean

Shows more verbose output such as installation logs when installing tools.

windows_default_file_shell_args string

Default shell arguments for Windows to be used for file commands. For example, cmd /c for cmd.exe.

Default: "cmd /c"

windows_default_inline_shell_args string

Default shell arguments for Windows to be used for inline commands. For example, cmd /c for cmd.exe.

Default: "cmd /c"

windows_executable_extensions string[]

List of executable extensions for Windows. For example, exe for .exe files, bat for .bat files, and so on.

Default:

[
  "exe",
  "bat",
  "cmd",
  "com",
  "ps1",
  "vbs"
]

windows_shim_mode string

Shim file mode for Windows. Options: exe, file, hardlink, symlink.

Default: "exe"

yes boolean

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

zig object

1 nested properties

use_community_mirrors boolean

Download Zig from community-maintained mirrors

Default: true

task_config object

configuration for task execution/management

2 nested properties

dir string

default directory to run tasks in defined in this file

includes string[]

files/directories to include searching for tasks. Can be local paths or git repository URLs using git:: prefix (e.g., git::https://github.com/org/repo.git//path?ref=branch)

tasks Record<string, string | string[] | object>

task runner tasks

task_templates Record<string, object>

task templates that can be extended by tasks via extends

tools Record<string, tool[] | tool>

dev tools to use

hooks to run

vars Record<string, string>

variables to set

1 nested properties

_ object

vars modules

2 nested properties

file string | string[]

source string | string[]

watch_files object[]

files to watch for changes

_ object

Definitions

task_dependency_item string | string[] | object

task name and args

env_directive object

path string | string[]

paths string[]

tools boolean

load tools before resolving

redact boolean

redact the value from logs

required boolean | string

require this environment variable to be defined before mise runs or in a later config file. Cannot be used with empty string values or value=false. Can be a boolean or a help string.

env Record<string, object | object | string | number | boolean>

environment variables

_ object

environment modules

4 nested properties

file env_directive | string | string | env_directive[]

path object | string | string | object[]

python object

python environment

1 nested properties

venv string | object

source env_directive | string | string | env_directive[]

settings object

activate_aggressive boolean

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

age object

4 nested properties

identity_files string[]

[experimental] List of age identity files to use for decryption.

key_file string

[experimental] Path to the age private key file to use for encryption/decryption.

ssh_identity_files string[]

[experimental] List of SSH identity files to use for age decryption.

strict boolean

If true, fail when age decryption fails (including when age is not available, the key is missing, or the key is invalid). If false, skip decryption and continue in these cases.

Default: true

all_compile boolean

do not use precompiled binaries for any tool

always_keep_download boolean

should mise keep downloaded files after installation

always_keep_install boolean

should mise keep install files after installation even if the installation fails

aqua object

7 nested properties

baked_registry boolean

Use baked-in aqua registry.

Default: true

cosign boolean

Use cosign to verify aqua tool signatures.

Default: true

cosign_extra_args string[]

Extra arguments to pass to cosign when verifying aqua tool signatures.

github_attestations boolean

Enable GitHub Artifact Attestations verification for aqua tools.

Default: true

minisign boolean

Use minisign to verify aqua tool signatures.

Default: true

registry_url string

URL to fetch aqua registry from.

slsa boolean

Use SLSA to verify aqua tool signatures.

Default: true

arch string

Architecture to use for precompiled binaries.

asdf_compat boolean

set to true to ensure .tool-versions will be compatible with asdf

auto_install boolean

Automatically install missing tools when running mise x, mise run, or as part of the 'not found' handler.

Default: true

auto_install_disable_tools string[]

List of tools to skip automatically installing when running mise x, mise run, or as part of the 'not found' handler.

cache_prune_age string

Delete files in cache that have not been accessed in this duration

Default: "30d"

cargo object

3 nested properties

binstall boolean

Use cargo-binstall instead of cargo install if available

Default: true

binstall_only boolean

Only use cargo-binstall for installation, fail if not available.

Default: false

registry_name string

Name of the cargo registry to use.

cd string

Path to change to after launching mise

ceiling_paths string[]

Directories where mise stops searching for config files.

Default:

[]

ci boolean

Set to true if running in a CI environment

Default: "false"

color boolean

Use color in mise terminal output

Default: true

color_theme string

Theme for interactive prompts (default/charm, base16, catppuccin, dracula)

Default: "default"

Values: "default" "charm" "base16" "catppuccin" "dracula"

conda object

1 nested properties

channel string

Default channel for conda packages.

Default: "conda-forge"

debug boolean

Sets log level to debug

default_config_filename string

The default config filename read. mise use and other commands that create new config files will use this value. This must be an env var.

Default: "mise.toml"

default_tool_versions_filename string

The default .tool-versions filename read. This will not ignore .tool-versions—use override_tool_versions_filename for that. This must be an env var.

Default: ".tool-versions"

disable_backends string[]

Backends to disable such as asdf or pipx

Default:

[]

disable_default_registry boolean

Disable the default mapping of short tool names like php -> asdf:mise-plugins/asdf-php. This parameter disables only for the backends vfox and asdf.

disable_hints string[]

Turns off helpful hints when using different mise features

Default:

[]

disable_tools string[]

Tools defined in mise.toml that should be ignored

Default:

[]

dotnet object

5 nested properties

cli_telemetry_optout boolean

Set DOTNET_CLI_TELEMETRY_OPTOUT to opt out of .NET CLI telemetry.

dotnet_root string

Path to the shared .NET SDK root directory.

isolated boolean

Install each .NET SDK version in its own isolated directory.

Default: false

package_flags string[]

Extends dotnet search and install abilities.

Default:

[]

registry_url string

URL to fetch dotnet tools from.

Default: "https://api.nuget.org/v3/index.json"

enable_tools string[]

Tools defined in mise.toml that should be used - all other tools are ignored

Default:

[]

env string[]

Env to use for mise.<MISE_ENV>.toml files.

Default:

[]

env_cache boolean

[experimental] Enable environment caching for nested mise invocations

Default: false

env_cache_ttl string

TTL for cached environments

Default: "1h"

env_file string

Path to a file containing environment variables to automatically load.

env_shell_expand boolean

Enable shell-style variable expansion in env values (e.g., $FOO, ${BAR:-default})

erlang object

1 nested properties

compile boolean

If true, compile erlang from source. If false, use precompiled binaries. If not set, use precompiled binaries if available.

exec_auto_install boolean

Automatically install missing tools when running mise x.

Default: true

experimental boolean

Enable experimental mise features which are incomplete or unstable—breakings changes may occur

fetch_remote_versions_cache string

How long to cache remote versions for tools.

Default: "1h"

fetch_remote_versions_timeout string

Timeout in seconds for HTTP requests to fetch new tool versions in mise.

Default: "20s"

forgejo object

3 nested properties

credential_command string

Shell command to run to obtain a Forgejo token for mise.

Default: ""

fj_cli_tokens boolean

Read Forgejo tokens from the fj CLI config.

Default: true

use_git_credentials boolean

Use git credential helpers to obtain Forgejo tokens.

Default: false

github object

5 nested properties

credential_command string

Shell command to run to obtain a GitHub token for mise.

Default: ""

gh_cli_tokens boolean

Read GitHub tokens from the gh CLI's hosts.yml config.

Default: true

github_attestations boolean

Enable GitHub Artifact Attestations verification for github backend tools.

Default: true

slsa boolean

Enable SLSA provenance verification for github backend tools.

Default: true

use_git_credentials boolean

Use git credential helpers to obtain GitHub tokens.

Default: false

github_attestations boolean

Enable GitHub Artifact Attestations verification for supported tools.

Default: true

gitlab object

3 nested properties

credential_command string

Shell command to run to obtain a GitLab token for mise.

Default: ""

glab_cli_tokens boolean

Read GitLab tokens from the glab CLI config.

Default: true

use_git_credentials boolean

Use git credential helpers to obtain GitLab tokens.

Default: false

gix boolean

Use gix for git operations, set to false to shell out to git.

Default: true

global_config_file string

Path to the global mise config file. Default is ~/.config/mise/config.toml. This must be an env var.

global_config_root string

Path which is used as {{config_root}} for the global config file. Default is $HOME. This must be an env var.

go object

7 nested properties

default_packages_file string

Path to a file containing default go packages to install when installing go.

Default: "~/.default-go-packages"

download_mirror string

Mirror to download go sdk tarballs from.

Default: "https://dl.google.com/go"

repo string

URL to fetch go from.

Default: "https://github.com/golang/go"

set_gobin boolean

Changes where go install installs binaries to.

set_gopath boolean

[deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages.

set_goroot boolean

Sets GOROOT=~/.local/share/mise/installs/go/.../.

Default: true

skip_checksum boolean

Set to true to skip checksum verification when downloading go sdk tarballs.

go_default_packages_file string

Path to a file containing default go packages to install when installing go.

go_download_mirror string

Mirror to download go sdk tarballs from.

go_repo string

URL to fetch go from.

go_set_gobin boolean

Changes where go install installs binaries to.

go_set_gopath boolean

[deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages.

go_set_goroot boolean

Sets GOROOT=~/.local/share/mise/installs/go/.../.

go_skip_checksum boolean

Set to true to skip checksum verification when downloading go sdk tarballs.

gpg_verify boolean

Use gpg to verify all tool signatures.

hook_env object

2 nested properties

cache_ttl string

Cache hook-env directory checks for this duration. Useful for slow filesystems like NFS.

Default: "0s"

chpwd_only boolean

Only run hook-env checks on directory change, not on every prompt.

Default: false

http_retries number

Number of retries for HTTP requests in mise.

Default: 0

http_timeout string

Timeout in seconds for all HTTP requests in mise.

Default: "30s"

idiomatic_version_file boolean

Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc.

idiomatic_version_file_disable_tools string[]

Specific tools to disable idiomatic version files for.

Default:

[]

idiomatic_version_file_enable_tools string[]

Specific tools to enable idiomatic version files for like .node-version, .ruby-version, etc.

Default:

[]

ignored_config_paths string[]

This is a list of config paths that mise will ignore.

Default:

[]

install_before string

Minimum release age / supply chain protection — only install versions released before this date

java object

1 nested properties

shorthand_vendor string

Shorthand for Java. Used when installing Java without a vendor prefix.

Default: "openjdk"

jobs number

How many jobs to run concurrently such as tool installs.

Default: 8

legacy_version_file boolean

Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc.

Default: true

legacy_version_file_disable_tools string[]

Specific tools to disable idiomatic version files for.

Default:

[]

libgit2 boolean

Use libgit2 for git operations, set to false to shell out to git.

Default: true

locked boolean

Require lockfile URLs to be present during installation.

Default: false

locked_verify_provenance boolean

Re-verify provenance at install time even when the lockfile already has provenance.

Default: false

lockfile boolean

Create and read lockfiles for tool versions.

log_level string

Show more/less output.

Default: "info"

Values: "trace" "debug" "info" "warn" "error"

netrc boolean

Use a netrc file for HTTP Basic authentication.

Default: true

netrc_file string

Path to the netrc file to use for HTTP Basic authentication.

no_env boolean

Do not load environment variables from config files.

no_hooks boolean

Do not execute hooks from config files.

node object

16 nested properties

cflags string

Additional CFLAGS options (e.g., to override -O3).

compile boolean

Compile node from source.

concurrency number

How many jobs should be used in compilation.

configure_opts string

Additional ./configure options.

corepack boolean

Installs the default corepack shims after installing any node version.

default_packages_file string

Path to a file containing default npm packages to install.

flavor string

Install a specific node flavor like glibc-217 or musl. Use with unofficial node build repo.

gpg_verify boolean

Use gpg to verify node tool signatures.

make string

Make command to use.

make_install_opts string

Additional make install options.

make_opts string

Additional make options.

mirror_url string

Mirror to download node tarballs from.

ninja boolean

Use ninja instead of make to compile node.

nodenv_root string

Directory for nodenv.

Default: "~/.nodenv"

nvm_dir string

Directory for nvm.

Default: "~/.nvm"

verify boolean

Verify the downloaded assets using GPG.

Default: true

not_found_auto_install boolean

Set to false to disable the "command not found" handler to autoinstall missing tool versions.

Default: true

npm object

2 nested properties

bun boolean

Use bun instead of npm if bun is installed and on PATH.

package_manager string

Package manager to use for installing npm packages.

Default: "npm"

Values: "npm" "bun" "pnpm"

offline boolean

Disable all HTTP requests. Tools will only use locally cached data.

os string

OS to use for precompiled binaries.

override_config_filenames string[]

If set, mise will ignore default config files like mise.toml and use these filenames instead.

Default:

[]

override_tool_versions_filenames string[]

If set, mise will ignore .tool-versions files and use these filenames instead. Can be set to none to disable .tool-versions.

Default:

[]

paranoid boolean

Enables extra-secure behavior.

pin boolean

Default to pinning versions when running mise use in mise.toml files.

pipx object

2 nested properties

registry_url string

URL to use for pipx registry.

Default: "https://pypi.org/pypi/{}/json"

uvx boolean

Use uvx instead of pipx if uv is installed and on PATH.

plugin_autoupdate_last_check_duration string

How long to wait before updating plugins automatically (note this isn't currently implemented).

Default: "7d"

prefer_offline boolean

Prefer locally cached data over remote fetches when possible.

profile string

Profile to use for mise.${MISE_PROFILE}.toml files.

python object

13 nested properties

compile boolean

If true, compile python from source. If false, use precompiled binaries. If not set, use precompiled binaries if available.

default_packages_file string

Path to a file containing default python packages to install when installing a python version.

github_attestations boolean

Enable GitHub Artifact Attestations verification for precompiled Python binaries.

patch_url string

URL to fetch python patches from to pass to python-build.

patches_directory string

Directory to fetch python patches from.

precompiled_arch string

Specify the architecture to use for precompiled binaries.

precompiled_flavor string

Specify the flavor to use for precompiled binaries.

precompiled_os string

Specify the OS to use for precompiled binaries.

pyenv_repo string

URL to fetch pyenv from for compiling python with python-build.

Default: "https://github.com/pyenv/pyenv.git"

uv_venv_auto boolean | string

Integrate with uv to manage project venvs when uv.lock is present.

Default: false

Values: false "source" "create|source" true

uv_venv_create_args string[]

Arguments to pass to uv when creating a venv.

venv_create_args string[]

Arguments to pass to python when creating a venv. (not used for uv venv creation)

venv_stdlib boolean

Prefer to use venv from Python's standard library.

quiet boolean

Suppress all output except errors.

raw boolean

Connect stdin/stdout/stderr to child processes.

ruby object

13 nested properties

apply_patches string

A list of patch files or URLs to apply to ruby source.

compile boolean

Set to true to compile ruby from source, false to use precompiled binaries.

default_packages_file string

Path to a file containing default ruby gems to install when installing ruby.

Default: "~/.default-gems"

github_attestations boolean

Enable GitHub Artifact Attestations verification for precompiled Ruby binaries.

precompiled_arch string

Override architecture identifier for precompiled Ruby binaries.

precompiled_os string

Override OS identifier for precompiled Ruby binaries.

precompiled_url string

URL template or GitHub repo for precompiled Ruby binaries.

Default: "jdx/ruby"

ruby_build_opts string

Options to pass to ruby-build.

ruby_build_repo string

The URL used to fetch ruby-build. This accepts either a Git repository or a ZIP archive.

Default: "https://github.com/rbenv/ruby-build.git"

ruby_install boolean

Use ruby-install instead of ruby-build.

ruby_install_opts string

Options to pass to ruby-install.

ruby_install_repo string

The URL used to fetch ruby-install. This accepts either a Git repository or a ZIP archive.

Default: "https://github.com/postmodern/ruby-install.git"

verbose_install boolean

Set to true to enable verbose output during ruby installation.

rust object

3 nested properties

cargo_home string

Path to the cargo home directory. Defaults to ~/.cargo or %USERPROFILE%\.cargo

default_host string

Default host triple to pass to rustup init via --default-host.

rustup_home string

Path to the rustup home directory. Defaults to ~/.rustup or %USERPROFILE%\.rustup

shared_install_dirs string[]

[experimental] Additional read-only directories to search for installed tool versions.

shorthands_file string

Path to a file containing custom tool shorthands.

silent boolean

Suppress all mise run|watch output except errors—including what tasks output.

slsa boolean

Enable SLSA provenance verification globally.

Default: true

sops object

5 nested properties

age_key string

The age private key to use for sops secret decryption. Takes precedence over standard SOPS_AGE_KEY environment variable.

age_key_file string

Path to the age private key file for sops secret decryption. Takes precedence over standard SOPS_AGE_KEY_FILE environment variable.

age_recipients string

The age public keys to use for sops secret encryption.

rops boolean

Use rops to decrypt sops files. Disable to shell out to sops which will slow down mise but sops may offer features not available in rops.

Default: true

strict boolean

If true, fail when sops decryption fails (including when sops is not available, the key is missing, or the key is invalid). If false, skip decryption and continue in these cases.

Default: true

status object

5 nested properties

missing_tools string

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

Default: "if_other_versions_installed"

show_env boolean

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

show_prepare_stale boolean

Show warning when prepare providers have stale dependencies.

Default: true

show_tools boolean

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

truncate boolean

Truncate status messages.

Default: true

swift object

2 nested properties

gpg_verify boolean

Use gpg to verify swift tool signatures.

platform string

Override the platform to use for precompiled binaries.

system_config_file string

Path to the system mise config file. Default is /etc/mise/config.toml. This must be an env var.

task object

15 nested properties

disable_paths string[]

Paths that mise will not look for tasks in.

Default:

[]

disable_spec_from_run_scripts boolean

Default: false

monorepo_depth number

Maximum depth to search for task files in monorepo subdirectories.

Default: 5

monorepo_exclude_dirs string[]

Directory patterns to exclude when discovering monorepo subdirectories.

Default:

[]

monorepo_respect_gitignore boolean

Whether to respect .gitignore files when discovering monorepo subdirectories.

Default: true

output string

Change output style when executing tasks.

Values: "prefix" "interleave" "keep-order" "replacing" "timed" "quiet" "silent"

remote_no_cache boolean

Mise will always fetch the latest tasks from the remote, by default the cache is used.

run_auto_install boolean

Automatically install missing tools when executing tasks.

Default: true

show_full_cmd boolean

Disable truncation of command lines in task execution output. When true, the full command line will be shown.

skip string[]

Tasks to skip when running mise run.

Default:

[]

skip_depends boolean

Run only specified tasks skipping all dependencies.

source_freshness_equal_mtime_is_fresh boolean

When source mtime equals output mtime, consider sources fresh (use <=). Default false uses strict < comparison.

Default: false

source_freshness_hash_contents boolean

Use content hashing (blake3) instead of metadata for source freshness. More accurate but slower.

Default: false

timeout string

Default timeout for tasks.

timings boolean

Show completion message with elapsed time for each task on mise run. Default shows when output type is prefix.

task_disable_paths string[]

Paths that mise will not look for tasks in.

task_output string

Change output style when executing tasks.

task_remote_no_cache boolean

Mise will always fetch the latest tasks from the remote, by default the cache is used.

task_run_auto_install boolean

Automatically install missing tools when executing tasks.

task_show_full_cmd boolean

Disable truncation of command lines in task execution output. When true, the full command line will be shown.

task_skip string[]

Tasks to skip when running mise run.

task_skip_depends boolean

Run only specified tasks skipping all dependencies.

task_timeout string

Default timeout for tasks. Can be overridden by individual tasks.

task_timings boolean

Show completion message with elapsed time for each task on mise run. Default shows when output type is prefix.

terminal_progress boolean

Enable terminal progress indicators (OSC 9;4) for compatible terminals.

Default: true

trace boolean

Sets log level to trace

trusted_config_paths string[]

Default:

[]

unix_default_file_shell_args string

Default shell arguments for Unix to be used for file commands. For example, sh for sh.

Default: "sh"

unix_default_inline_shell_args string

Default shell arguments for Unix to be used for inline commands. For example, sh -c for sh.

Default: "sh -c -o errexit"

url_replacements Record<string, string>

Map of URL patterns to replacement URLs applied to all requests.

use_file_shell_for_executable_tasks boolean

Default: false

use_versions_host boolean

Set to false to disable using the mise-versions API as a quick way for mise to query for new versions.

Default: true

use_versions_host_track boolean

Send anonymous download statistics when installing tools.

Default: true

verbose boolean

Shows more verbose output such as installation logs when installing tools.

windows_default_file_shell_args string

Default shell arguments for Windows to be used for file commands. For example, cmd /c for cmd.exe.

Default: "cmd /c"

windows_default_inline_shell_args string

Default shell arguments for Windows to be used for inline commands. For example, cmd /c for cmd.exe.

Default: "cmd /c"

windows_executable_extensions string[]

List of executable extensions for Windows. For example, exe for .exe files, bat for .bat files, and so on.

Default:

[
  "exe",
  "bat",
  "cmd",
  "com",
  "ps1",
  "vbs"
]

windows_shim_mode string

Shim file mode for Windows. Options: exe, file, hardlink, symlink.

Default: "exe"

yes boolean

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

zig object

1 nested properties

use_community_mirrors boolean

Download Zig from community-maintained mirrors

Default: true

task_run_entry string | object | object

task string | string[] | object

vars Record<string, string>

variables to set

_ object

vars modules

2 nested properties

file string | string[]

source string | string[]

task_config object

configuration for task execution/management

dir string

default directory to run tasks in defined in this file

includes string[]

files/directories to include searching for tasks. Can be local paths or git repository URLs using git:: prefix (e.g., git::https://github.com/org/repo.git//path?ref=branch)

experimental_monorepo_root boolean

Marks this config as a monorepo root, enabling target path syntax for tasks. Requires MISE_EXPERIMENTAL=1. When enabled, tasks can be referenced with paths like //projects/frontend:build

monorepo object

Configuration for monorepo task discovery

config_roots string[]

Explicit list of config root paths for monorepo task discovery. Supports single-level glob patterns (*). When set, skips filesystem walking for better performance.

tool string | object

hooks to run

watch_files object[]

files to watch for changes

prepare_provider object

Prepare provider configuration

auto boolean

Auto-run before mise x and mise run

Default: false

sources string | string[]

Files/patterns to check for changes

outputs string | string[]

Files/directories that should be newer than sources

run string

Command to run when stale

env Record<string, string>

Environment variables to set

dir string

Working directory for the command

description string

Description shown in output

depends string[]

Other prepare providers that must complete before this one runs

timeout string

Timeout for the run command (e.g., "30s", "5m", "1h")

task_props object

common task properties

alias string | string[]

confirm string

confirmation message before running this task

depends string | task_dependency_item[]

depends_post string | task_dependency_item[]

wait_for string | task_dependency_item[]

description string

description of task

dir string

directory to run script in, default is the project's base directory

Default: "{{ config_root }}"

env Record<string, object | object | string | number | boolean>

environment variables

1 nested properties

_ object

environment modules

4 nested properties

file env_directive | string | string | env_directive[]

path object | string | string | object[]

python object

python environment

source env_directive | string | string | env_directive[]

vars Record<string, string>

variables to set

1 nested properties

_ object

vars modules

2 nested properties

file string | string[]

source string | string[]

tools Record<string, string | object>

tools to install/activate before running this task

hide boolean

do not display this task

Default: false

outputs string[] | string | object

quiet boolean

do not display mise information for this task

Default: false

silent boolean | string

suppress all output for this task

Default: false

interactive boolean

mark task as interactive, acquiring exclusive terminal access while allowing other non-interactive tasks to run in parallel

Default: false

raw boolean

directly connect task to stdin/stdout/stderr

Default: false

run task_run_entry | task_run_entry[]

run_windows task_run_entry | task_run_entry[]

file string

Execute an external script

sources string[] | string

shell string

specify a shell command to run the script with

usage string

Specify usage (https://usage.jdx.dev/) specs for the task

timeout string

timeout for this task

task_template object

task template that can be extended by tasks

alias string | string[]

confirm string

confirmation message before running this task

depends string | task_dependency_item[]

depends_post string | task_dependency_item[]

wait_for string | task_dependency_item[]

description string

description of task

dir string

directory to run script in, default is the project's base directory

Default: "{{ config_root }}"

env Record<string, object | object | string | number | boolean>

environment variables

1 nested properties

_ object

environment modules

4 nested properties

file env_directive | string | string | env_directive[]

path object | string | string | object[]

python object

python environment

source env_directive | string | string | env_directive[]

vars Record<string, string>

variables to set

1 nested properties

_ object

vars modules

2 nested properties

file string | string[]

source string | string[]

tools Record<string, string | object>

tools to install/activate before running this task

hide boolean

do not display this task

Default: false

outputs string[] | string | object

quiet boolean

do not display mise information for this task

Default: false

silent boolean | string

suppress all output for this task

Default: false

interactive boolean

mark task as interactive, acquiring exclusive terminal access while allowing other non-interactive tasks to run in parallel

Default: false

raw boolean

directly connect task to stdin/stdout/stderr

Default: false

run task_run_entry | task_run_entry[]

run_windows task_run_entry | task_run_entry[]

file string

Execute an external script

sources string[] | string

shell string

specify a shell command to run the script with

usage string

Specify usage (https://usage.jdx.dev/) specs for the task

timeout string

timeout for this task