+
diff --git a/build.rs b/build.rs
new file mode 100644
index 000000000..d8f91cb91
--- /dev/null
+++ b/build.rs
@@ -0,0 +1,3 @@
+fn main() {
+ built::write_built_file().expect("Failed to acquire build-time information");
+}
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 000000000..019af83f7
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,131 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+ {% if previous.version %}\
+ ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
+ {% else %}\
+ ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+ {% endif %}\
+{% else %}\
+ ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+ ### {{ group | striptags | trim | upper_first }}
+
+ {% for commit in commits
+ | filter(attribute="scope")
+ | sort(attribute="scope") -%}
+ {% if commit.scope -%}
+ - {{self::commit(commit=commit)}}\
+ {% endif -%}
+ {% endfor -%}
+ {% for commit in commits -%}
+ {% if commit.scope -%}
+ {% else -%}
+ - {{self::commit(commit=commit)}}\
+ {% endif -%}
+ {% endfor -%}
+{% endfor %}
+{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 -%}
+### New Contributors
+{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
+ * @{{ contributor.username }} made their first contribution
+ {%- if contributor.pr_number %} in \
+ [#{{ contributor.pr_number }}]($REPO/pull/{{ contributor.pr_number }})\
+ {% endif %}\
+{% endfor %}
+
+{% endif -%}
+{% macro commit(commit) -%}
+{% if commit.scope %}**({{commit.scope}})** {% endif -%}
+{% if commit.breaking %}**breaking** {% endif -%}
+{{ commit.message | split(pat="\n") | first | trim }} by \
+{% if commit.github.username %}[@{{commit.github.username}}](https://github.com/{{commit.github.username}})\
+{% else %}{{commit.author.name}}{% endif %} in \
+{% if commit.github.pr_number %}[#{{ commit.github.pr_number }}]($REPO/pull/{{ commit.github.pr_number }})\
+{% else %}[{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})\
+{%- endif %}
+{% endmacro commit -%}
+"""
+# template for the changelog footer
+footer = """
+
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+postprocessors = [
+ { pattern = '\$REPO', replace = "https://github.com/jdx/mise" },
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = false
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+ # remove PR labels from commits
+ { pattern = '\(#([0-9]+)\)', replace = "" },
+ # Check spelling of the commit with https://github.com/crate-ci/typos
+ # If the spelling is incorrect, it will be automatically fixed.
+ #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+ { message = '^chore\(release\): prepare for', skip = true },
+ { message = '^chore\(pr\)', skip = true },
+ { message = '^chore\(pull\)', skip = true },
+ { message = '^chore: (release|Release)', skip = true },
+ { message = '^Release', skip = true },
+ { message = "^Merge commit", skip = true },
+ { body = '.*security', group = "🛡️ Security" },
+ { message = '^(chore|fix)\(deps\):', group = "📦️ Dependency Updates", scope = "" },
+ { message = '^feat', group = "🚀 Features" },
+ { message = '^fix', group = "🐛 Bug Fixes" },
+ { message = '^refactor', group = "🚜 Refactor" },
+ { message = '^doc', group = "📚 Documentation" },
+ { message = '^style', group = "🎨 Styling" },
+ { message = '^perf', group = "⚡ Performance" },
+ { message = '^test', group = "🧪 Testing" },
+ { message = '^revert', group = "◀️ Revert" },
+ { message = '.', group = "🔍 Other Changes" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+tag_pattern = '^v\d+\.\d+\.\d+$'
+# regex for skipping tags
+skip_tags = '^v(1|2023|2024\.0)\.'
+# regex for ignoring tags
+# ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42
+
+[bump]
+features_always_bump_minor = false
+breaking_always_bump_major = false
+
+[remote.github]
+owner = "jdx"
+repo = "mise"
diff --git a/completions/_mise b/completions/_mise
new file mode 100644
index 000000000..1771c9c99
--- /dev/null
+++ b/completions/_mise
@@ -0,0 +1,47 @@
+#compdef mise
+local curcontext="$curcontext"
+
+# caching config
+_usage_mise_cache_policy() {
+ if [[ -z "${lifetime}" ]]; then
+ lifetime=$((60*60*4)) # 4 hours
+ fi
+ local -a oldp
+ oldp=( "$1"(Nms+${lifetime}) )
+ (( $#oldp ))
+}
+
+_mise() {
+ typeset -A opt_args
+ local curcontext="$curcontext" spec cache_policy
+
+ if ! command -v usage &> /dev/null; then
+ echo >&2
+ echo "Error: usage CLI not found. This is required for completions to work in mise." >&2
+ echo "See https://usage.jdx.dev for more information." >&2
+ return 1
+ fi
+
+ zstyle -s ":completion:${curcontext}:" cache-policy cache_policy
+ if [[ -z $cache_policy ]]; then
+ zstyle ":completion:${curcontext}:" cache-policy _usage_mise_cache_policy
+ fi
+
+ if ( [[ -z "${_usage_mise_spec:-}" ]] || _cache_invalid _usage_mise_spec ) \
+ && ! _retrieve_cache _usage_mise_spec;
+ then
+ spec="$(mise usage)"
+ _store_cache _usage_mise_spec spec
+ fi
+
+ _arguments '*: :($(usage complete-word -s "$spec" -- "${words[@]}" ))'
+ return 0
+}
+
+if [ "$funcstack[1]" = "_mise" ]; then
+ _mise "$@"
+else
+ compdef _mise mise
+fi
+
+# vim: noet ci pi sts=0 sw=4 ts=4
diff --git a/completions/mise.bash b/completions/mise.bash
new file mode 100644
index 000000000..50258940d
--- /dev/null
+++ b/completions/mise.bash
@@ -0,0 +1,21 @@
+_mise() {
+ if ! command -v usage &> /dev/null; then
+ echo >&2
+ echo "Error: usage CLI not found. This is required for completions to work in mise." >&2
+ echo "See https://usage.jdx.dev for more information." >&2
+ return 1
+ fi
+
+ if [[ -z ${_USAGE_SPEC_MISE:-} ]]; then
+ _USAGE_SPEC_MISE="$(mise usage)"
+ fi
+
+ COMPREPLY=( $(usage complete-word -s "${_USAGE_SPEC_MISE}" --cword="$COMP_CWORD" -- "${COMP_WORDS[@]}" ) )
+ if [[ $? -ne 0 ]]; then
+ unset COMPREPLY
+ fi
+ return 0
+}
+
+shopt -u hostcomplete && complete -o nospace -o bashdefault -o nosort -F _mise mise
+# vim: noet ci pi sts=0 sw=4 ts=4 ft=sh
diff --git a/completions/mise.fish b/completions/mise.fish
new file mode 100644
index 000000000..87f982803
--- /dev/null
+++ b/completions/mise.fish
@@ -0,0 +1,13 @@
+# if "usage" is not installed show an error
+if ! command -v usage &> /dev/null
+ # Try to enable usage through mise
+ if ! mise use -g usage &> /dev/null
+ echo >&2
+ echo "Error: usage CLI not found. This is required for completions to work in mise." >&2
+ echo "See https://usage.jdx.dev for more information." >&2
+ return 1
+ end
+end
+
+set _usage_spec_mise (mise usage | string collect)
+complete -xc mise -a '(usage complete-word -s "$_usage_spec_mise" -- (commandline -cop) (commandline -t))'
diff --git a/default.nix b/default.nix
new file mode 100644
index 000000000..e6ba19ecb
--- /dev/null
+++ b/default.nix
@@ -0,0 +1,50 @@
+{ pkgs, lib, stdenv, fetchFromGitHub, rustPlatform, coreutils, bash, direnv, openssl }:
+
+rustPlatform.buildRustPackage {
+ pname = "mise";
+ version = "2024.4.8";
+
+ src = lib.cleanSource ./.;
+
+ cargoLock = {
+ lockFile = ./Cargo.lock;
+ };
+
+ nativeBuildInputs = with pkgs; [ pkg-config ];
+ buildInputs = with pkgs; [
+ coreutils
+ bash
+ direnv
+ gnused
+ git
+ gawk
+ openssl
+ ] ++ lib.optionals stdenv.isDarwin [ darwin.apple_sdk.frameworks.Security darwin.apple_sdk.frameworks.SystemConfiguration ];
+
+ prePatch = ''
+ substituteInPlace ./test/data/plugins/**/bin/* \
+ --replace '#!/usr/bin/env bash' '#!${bash}/bin/bash'
+ substituteInPlace ./src/fake_asdf.rs ./src/cli/reshim.rs \
+ --replace '#!/bin/sh' '#!${bash}/bin/sh'
+ substituteInPlace ./src/env_diff.rs \
+ --replace '"bash"' '"${bash}/bin/bash"'
+ substituteInPlace ./test/cwd/.mise/tasks/filetask \
+ --replace '#!/usr/bin/env bash' '#!${bash}/bin/bash'
+ substituteInPlace ./src/cli/direnv/exec.rs \
+ --replace '"env"' '"${coreutils}/bin/env"' \
+ --replace 'cmd!("direnv"' 'cmd!("${direnv}/bin/direnv"'
+ '';
+
+ # Skip the test_plugin_list_urls as it uses the .git folder, which
+ # is excluded by default from Nix.
+ checkPhase = ''
+ RUST_BACKTRACE=full cargo test --all-features -- \
+ --skip cli::plugins::ls::tests::test_plugin_list_urls
+ '';
+
+ meta = with lib; {
+ description = "The front-end to your dev env";
+ homepage = "https://github.com/jdx/mise";
+ license = licenses.mit;
+ };
+}
diff --git a/deny.toml b/deny.toml
new file mode 100644
index 000000000..ab9c956f4
--- /dev/null
+++ b/deny.toml
@@ -0,0 +1,232 @@
+# This template contains all of the possible sections and their default values
+
+# Note that all fields that take a lint level have these possible values:
+# * deny - An error will be produced and the check will fail
+# * warn - A warning will be produced, but the check will not fail
+# * allow - No warning or error will be produced, though in some cases a note
+# will be
+
+# The values provided in this template are the default values that will be used
+# when any section or field is not specified in your own configuration
+
+# Root options
+
+# The graph table configures how the dependency graph is constructed and thus
+# which crates the checks are performed against
+[graph]
+# If 1 or more target triples (and optionally, target_features) are specified,
+# only the specified targets will be checked when running `cargo deny check`.
+# This means, if a particular package is only ever used as a target specific
+# dependency, such as, for example, the `nix` crate only being used via the
+# `target_family = "unix"` configuration, that only having windows targets in
+# this list would mean the nix crate, as well as any of its exclusive
+# dependencies not shared by any other crates, would be ignored, as the target
+# list here is effectively saying which targets you are building for.
+targets = [
+ # The triple can be any string, but only the target triples built in to
+ # rustc (as of 1.40) can be checked against actual config expressions
+ #"x86_64-unknown-linux-musl",
+ # You can also specify which target_features you promise are enabled for a
+ # particular target. target_features are currently not validated against
+ # the actual valid features supported by the target architecture.
+ #{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
+]
+# When creating the dependency graph used as the source of truth when checks are
+# executed, this field can be used to prune crates from the graph, removing them
+# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
+# is pruned from the graph, all of its dependencies will also be pruned unless
+# they are connected to another crate in the graph that hasn't been pruned,
+# so it should be used with care. The identifiers are [Package ID Specifications]
+# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
+#exclude = []
+# If true, metadata will be collected with `--all-features`. Note that this can't
+# be toggled off if true, if you want to conditionally enable `--all-features` it
+# is recommended to pass `--all-features` on the cmd line instead
+all-features = true
+# If true, metadata will be collected with `--no-default-features`. The same
+# caveat with `all-features` applies
+no-default-features = false
+# If set, these feature will be enabled when collecting metadata. If `--features`
+# is specified on the cmd line they will take precedence over this option.
+#features = []
+
+# The output table provides options for how/if diagnostics are outputted
+[output]
+# When outputting inclusion graphs in diagnostics that include features, this
+# option can be used to specify the depth at which feature edges will be added.
+# This option is included since the graphs can be quite large and the addition
+# of features from the crate(s) to all of the graph roots can be far too verbose.
+# This option can be overridden via `--feature-depth` on the cmd line
+feature-depth = 1
+
+# This section is considered when running `cargo deny check advisories`
+# More documentation for the advisories section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
+[advisories]
+# The path where the advisory databases are cloned/fetched into
+#db-path = "$CARGO_HOME/advisory-dbs"
+# The url(s) of the advisory databases to use
+#db-urls = ["https://github.com/rustsec/advisory-db"]
+# A list of advisory IDs to ignore. Note that ignored advisories will still
+# output a note when they are encountered.
+ignore = [
+ #"RUSTSEC-0000-0000",
+ #{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" },
+ #"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish
+ #{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" },
+]
+# If this is true, then cargo deny will use the git executable to fetch advisory database.
+# If this is false, then it uses a built-in git library.
+# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
+# See Git Authentication for more information about setting up git authentication.
+#git-fetch-with-cli = true
+
+# This section is considered when running `cargo deny check licenses`
+# More documentation for the licenses section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
+[licenses]
+# List of explicitly allowed licenses
+# See https://spdx.org/licenses/ for list of possible licenses
+# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
+allow = [
+ "Apache-2.0 WITH LLVM-exception",
+ "Apache-2.0",
+ "BSD-3-Clause",
+ "ISC",
+ "MIT",
+ "MPL-2.0",
+ "OpenSSL",
+ "Unicode-DFS-2016",
+]
+# The confidence threshold for detecting a license from license text.
+# The higher the value, the more closely the license text must be to the
+# canonical license text of a valid SPDX license file.
+# [possible values: any between 0.0 and 1.0].
+confidence-threshold = 0.8
+# Allow 1 or more licenses on a per-crate basis, so that particular licenses
+# aren't accepted for every possible crate as with the normal allow list
+exceptions = [
+ # Each entry is the crate and version constraint, and its specific allow
+ # list
+ #{ allow = ["Zlib"], crate = "adler32" },
+]
+
+# Some crates don't have (easily) machine readable licensing information,
+# adding a clarification entry for it allows you to manually specify the
+# licensing information
+[[licenses.clarify]]
+# The package spec the clarification applies to
+crate = "ring"
+# The SPDX expression for the license requirements of the crate
+expression = "MIT AND ISC AND OpenSSL"
+# One or more files in the crate's source used as the "source of truth" for
+# the license expression. If the contents match, the clarification will be used
+# when running the license check, otherwise the clarification will be ignored
+# and the crate will be checked normally, which may produce warnings or errors
+# depending on the rest of your configuration
+license-files = [
+ # Each entry is a crate relative path, and the (opaque) hash of its contents
+ { path = "LICENSE", hash = 0xbd0eed23 }
+]
+
+[licenses.private]
+# If true, ignores workspace crates that aren't published, or are only
+# published to private registries.
+# To see how to mark a crate as unpublished (to the official registry),
+# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
+ignore = false
+# One or more private registries that you might publish crates to, if a crate
+# is only published to private registries, and ignore is true, the crate will
+# not have its license(s) checked
+registries = [
+ #"https://sekretz.com/registry
+]
+
+# This section is considered when running `cargo deny check bans`.
+# More documentation about the 'bans' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
+[bans]
+# Lint level for when multiple versions of the same crate are detected
+multiple-versions = "allow"
+# Lint level for when a crate version requirement is `*`
+wildcards = "allow"
+# The graph highlighting used when creating dotgraphs for crates
+# with multiple versions
+# * lowest-version - The path to the lowest versioned duplicate is highlighted
+# * simplest-path - The path to the version with the fewest edges is highlighted
+# * all - Both lowest-version and simplest-path are used
+highlight = "all"
+# The default lint level for `default` features for crates that are members of
+# the workspace that is being checked. This can be overridden by allowing/denying
+# `default` on a crate-by-crate basis if desired.
+workspace-default-features = "allow"
+# The default lint level for `default` features for external crates that are not
+# members of the workspace. This can be overridden by allowing/denying `default`
+# on a crate-by-crate basis if desired.
+external-default-features = "allow"
+# List of crates that are allowed. Use with care!
+allow = [
+ #"ansi_term@0.11.0",
+ #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" },
+]
+# List of crates to deny
+deny = [
+ #"ansi_term@0.11.0",
+ #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" },
+ # Wrapper crates can optionally be specified to allow the crate when it
+ # is a direct dependency of the otherwise banned crate
+ #{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
+]
+
+# List of features to allow/deny
+# Each entry the name of a crate and a version range. If version is
+# not specified, all versions will be matched.
+#[[bans.features]]
+#crate = "reqwest"
+# Features to not allow
+#deny = ["json"]
+# Features to allow
+#allow = [
+# "rustls",
+# "__rustls",
+# "__tls",
+# "hyper-rustls",
+# "rustls",
+# "rustls-pemfile",
+# "rustls-tls-webpki-roots",
+# "tokio-rustls",
+# "webpki-roots",
+#]
+# If true, the allowed features must exactly match the enabled feature set. If
+# this is set there is no point setting `deny`
+#exact = true
+
+# Certain crates/versions that will be skipped when doing duplicate detection.
+skip = [
+ #"ansi_term@0.11.0",
+ #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" },
+]
+# Similarly to `skip` allows you to skip certain crates during duplicate
+# detection. Unlike skip, it also includes the entire tree of transitive
+# dependencies starting at the specified crate, up to a certain depth, which is
+# by default infinite.
+skip-tree = [
+ #"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies
+ #{ crate = "ansi_term@0.11.0", depth = 20 },
+]
+
+# This section is considered when running `cargo deny check sources`.
+# More documentation about the 'sources' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
+[sources]
+# Lint level for what to happen when a crate from a crate registry that is not
+# in the allow list is encountered
+unknown-registry = "warn"
+# Lint level for what to happen when a crate from a git repository that is not
+# in the allow list is encountered
+unknown-git = "warn"
+# List of URLs for allowed crate registries. Defaults to the crates.io index
+# if not specified. If it is specified but empty, no registries are allowed.
+allow-registry = ["https://github.com/rust-lang/crates.io-index"]
+# List of URLs for allowed Git repositories
+allow-git = []
diff --git a/docs/bun.md b/docs/bun.md
new file mode 100644
index 000000000..052b9204e
--- /dev/null
+++ b/docs/bun.md
@@ -0,0 +1 @@
+See [mise.jdx.dev](https://mise.jdx.dev/lang/bun.html) for more information.
diff --git a/docs/cli-reference.md b/docs/cli-reference.md
new file mode 100644
index 000000000..f5dff2ab3
--- /dev/null
+++ b/docs/cli-reference.md
@@ -0,0 +1,1733 @@
+
+
+# Commands
+
+## `mise activate [OPTIONS] [SHELL_TYPE]`
+
+```text
+Initializes mise in the current shell session
+
+This should go into your shell's rc file.
+Otherwise, it will only take effect in the current session.
+(e.g. ~/.zshrc, ~/.bashrc)
+
+This is only intended to be used in interactive sessions, not scripts.
+mise is only capable of updating PATH when the prompt is displayed to the user.
+For non-interactive use-cases, use shims instead.
+
+Typically this can be added with something like the following:
+
+ echo 'eval "$(mise activate)"' >> ~/.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)"' >> ~/.zshrc
+
+Customize status output with `status` settings.
+
+Usage: activate [OPTIONS] [SHELL_TYPE]
+
+Arguments:
+ [SHELL_TYPE]
+ Shell type to generate the script for
+
+ [possible values: bash, fish, nu, xonsh, zsh]
+
+Options:
+ --shims
+ Use shims instead of modifying PATH
+ Effectively the same as:
+ PATH="$HOME/.local/share/mise/shims:$PATH"
+
+ -q, --quiet
+ Suppress non-error messages
+
+Examples:
+
+ $ eval "$(mise activate bash)"
+ $ eval "$(mise activate zsh)"
+ $ mise activate fish | source
+ $ execx($(mise activate xonsh))
+```
+
+## `mise alias get