From aca3036ec4073827962aa70aed2c24bee6c5d7f5 Mon Sep 17 00:00:00 2001 From: jdx <216188+jdx@users.noreply.github.com> Date: Sun, 27 Oct 2024 15:08:36 -0500 Subject: [PATCH] docs: added source code links --- .mise.toml | 2 +- Cargo.lock | 26 +++-- Cargo.toml | 2 +- docs/cli/activate.md | 2 + docs/cli/alias.md | 10 +- docs/cli/alias/get.md | 2 + docs/cli/alias/ls.md | 2 + docs/cli/alias/set.md | 2 + docs/cli/alias/unset.md | 2 + docs/cli/backends.md | 4 +- docs/cli/backends/ls.md | 2 + docs/cli/bin-paths.md | 2 + docs/cli/cache.md | 6 +- docs/cli/cache/clear.md | 2 + docs/cli/cache/prune.md | 2 + docs/cli/completion.md | 2 + docs/cli/config.md | 10 +- docs/cli/config/generate.md | 2 + docs/cli/config/get.md | 2 + docs/cli/config/ls.md | 2 + docs/cli/config/set.md | 2 + docs/cli/deactivate.md | 2 + docs/cli/direnv.md | 4 +- docs/cli/direnv/activate.md | 2 + docs/cli/doctor.md | 2 + docs/cli/env.md | 2 + docs/cli/exec.md | 2 + docs/cli/generate.md | 8 +- docs/cli/generate/git-pre-commit.md | 2 + docs/cli/generate/github-action.md | 2 + docs/cli/generate/task-docs.md | 2 + docs/cli/implode.md | 2 + docs/cli/index.md | 146 ++++++++++++++-------------- docs/cli/install.md | 2 + docs/cli/latest.md | 2 + docs/cli/link.md | 2 + docs/cli/ls-remote.md | 2 + docs/cli/ls.md | 2 + docs/cli/outdated.md | 2 + docs/cli/plugins.md | 14 +-- docs/cli/plugins/install.md | 2 + docs/cli/plugins/link.md | 2 + docs/cli/plugins/ls-remote.md | 2 + docs/cli/plugins/ls.md | 2 + docs/cli/plugins/uninstall.md | 2 + docs/cli/plugins/update.md | 2 + docs/cli/prune.md | 2 + docs/cli/registry.md | 2 + docs/cli/reshim.md | 2 + docs/cli/run.md | 2 + docs/cli/self-update.md | 2 + docs/cli/set.md | 2 + docs/cli/settings.md | 12 ++- docs/cli/settings/add.md | 2 + docs/cli/settings/get.md | 2 + docs/cli/settings/ls.md | 2 + docs/cli/settings/set.md | 2 + docs/cli/settings/unset.md | 2 + docs/cli/shell.md | 2 + docs/cli/sync.md | 6 +- docs/cli/sync/node.md | 2 + docs/cli/sync/python.md | 2 + docs/cli/tasks.md | 12 ++- docs/cli/tasks/deps.md | 2 + docs/cli/tasks/edit.md | 2 + docs/cli/tasks/info.md | 2 + docs/cli/tasks/ls.md | 2 + docs/cli/tasks/run.md | 2 + docs/cli/trust.md | 2 + docs/cli/uninstall.md | 2 + docs/cli/unset.md | 2 + docs/cli/upgrade.md | 2 + docs/cli/use.md | 2 + docs/cli/version.md | 2 + docs/cli/watch.md | 2 + docs/cli/where.md | 2 + docs/cli/which.md | 2 + mise.usage.kdl | 2 + src/assets/mise-extra.usage.kdl | 2 + 79 files changed, 275 insertions(+), 117 deletions(-) diff --git a/.mise.toml b/.mise.toml index fd55830591..bdebf8c8b1 100644 --- a/.mise.toml +++ b/.mise.toml @@ -24,7 +24,7 @@ direnv = "latest" actionlint = "latest" ripgrep = "latest" "pipx:toml-sort" = "latest" -usage = "latest" +usage = "0.12.1" #python = { version = "latest", virtualenv = "{{env.HOME}}/.cache/venv" } #ruby = "3.1" diff --git a/Cargo.lock b/Cargo.lock index 618726c264..a32fda3ccb 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -694,7 +694,7 @@ dependencies = [ "cssparser-macros", "dtoa-short", "itoa", - "phf 0.11.2", + "phf 0.10.1", "smallvec", ] @@ -2472,7 +2472,9 @@ version = "0.10.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "fabbf1ead8a5bcbc20f5f8b939ee3f5b0f6f281b6ad3468b84656b658b455259" dependencies = [ + "phf_macros", "phf_shared 0.10.0", + "proc-macro-hack", ] [[package]] @@ -2481,7 +2483,6 @@ version = "0.11.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ade2d8b8f33c7333b51bcf0428d37e217e9f32192ae4772156f65063b8ce03dc" dependencies = [ - "phf_macros", "phf_shared 0.11.2", ] @@ -2527,15 +2528,16 @@ dependencies = [ [[package]] name = "phf_macros" -version = "0.11.2" +version = "0.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3444646e286606587e49f3bcf1679b8cef1dc2c5ecc29ddacaffc305180d464b" +checksum = "58fdf3184dd560f160dd73922bea2d5cd6e8f064bf4b13110abd81b03697b4e0" dependencies = [ - "phf_generator 0.11.2", - "phf_shared 0.11.2", + "phf_generator 0.10.0", + "phf_shared 0.10.0", + "proc-macro-hack", "proc-macro2", "quote", - "syn 2.0.85", + "syn 1.0.109", ] [[package]] @@ -2681,6 +2683,12 @@ dependencies = [ "version_check", ] +[[package]] +name = "proc-macro-hack" +version = "0.5.20+deprecated" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc375e1527247fe1a97d8b7156678dfe7c1af2fc075c9a4db3690ecd2a148068" + [[package]] name = "proc-macro2" version = "1.0.89" @@ -4123,9 +4131,9 @@ checksum = "daf8dba3b7eb870caf1ddeed7bc9d2a049f3cfdfae7cb521b087cc33ae4c49da" [[package]] name = "usage-lib" -version = "0.11.1" +version = "0.12.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c443fdef6cd83c5e1a5fabe7aa6399857c08f6345d38103358e23ffab9cb3587" +checksum = "6dc8dea44bf76baf42320d274395aa892a1d51d33809861d7bed4091690e2923" dependencies = [ "clap", "heck 0.5.0", diff --git a/Cargo.toml b/Cargo.toml index c7b95e065a..99f2559102 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -118,7 +118,7 @@ toml_edit = { version = "0.22", features = ["parse"] } ubi = { version = "0.2", default-features = false } url = "2" # usage-lib = { path = "../usage/lib", features = ["clap", "docs"] } -usage-lib = { version = "0.11", features = ["clap", "docs"] } +usage-lib = { version = "0.12", features = ["clap", "docs"] } versions = { version = "6", features = ["serde"] } # vfox = { path="../vfox.rs" } vfox = "0.2" diff --git a/docs/cli/activate.md b/docs/cli/activate.md index 112e1b1c55..dd58e7cd52 100644 --- a/docs/cli/activate.md +++ b/docs/cli/activate.md @@ -2,6 +2,8 @@ **Usage**: `mise activate [--shims] [-q --quiet] [SHELL_TYPE]` +**Source code**: [`src/cli/activate.rs`](https://github.com/jdx/mise/blob/main/src/cli/activate.rs) + Initializes mise in the current shell session This should go into your shell's rc file. diff --git a/docs/cli/alias.md b/docs/cli/alias.md index 6d4bfd622b..c5f619cca9 100644 --- a/docs/cli/alias.md +++ b/docs/cli/alias.md @@ -2,6 +2,8 @@ **Usage**: `mise alias [-p --plugin ] [--no-header] ` +**Source code**: [`src/cli/alias.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias.rs) + **Aliases**: `a` Manage aliases @@ -18,7 +20,7 @@ Don't show table header ## Subcommands -* [`mise alias get `](/cli/alias/get.md) -* [`mise alias ls [--no-header] [PLUGIN]`](/cli/alias/ls.md) -* [`mise alias set …`](/cli/alias/set.md) -* [`mise alias unset `](/cli/alias/unset.md) +- [`mise alias get `](/cli/alias/get.md) +- [`mise alias ls [--no-header] [PLUGIN]`](/cli/alias/ls.md) +- [`mise alias set …`](/cli/alias/set.md) +- [`mise alias unset `](/cli/alias/unset.md) diff --git a/docs/cli/alias/get.md b/docs/cli/alias/get.md index 78d1409f59..60c349e23b 100644 --- a/docs/cli/alias/get.md +++ b/docs/cli/alias/get.md @@ -2,6 +2,8 @@ **Usage**: `mise alias get ` +**Source code**: [`src/cli/alias/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/get.rs) + Show an alias for a plugin This is the contents of an alias.<PLUGIN> entry in ~/.config/mise/config.toml diff --git a/docs/cli/alias/ls.md b/docs/cli/alias/ls.md index 17a676c295..6ce38d2aa3 100644 --- a/docs/cli/alias/ls.md +++ b/docs/cli/alias/ls.md @@ -2,6 +2,8 @@ **Usage**: `mise alias ls [--no-header] [PLUGIN]` +**Source code**: [`src/cli/alias/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/ls.rs) + **Aliases**: `list` List aliases diff --git a/docs/cli/alias/set.md b/docs/cli/alias/set.md index 9da1a04971..e2e64c3f1e 100644 --- a/docs/cli/alias/set.md +++ b/docs/cli/alias/set.md @@ -2,6 +2,8 @@ **Usage**: `mise alias set …` +**Source code**: [`src/cli/alias/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/set.rs) + **Aliases**: `add`, `create` Add/update an alias for a plugin diff --git a/docs/cli/alias/unset.md b/docs/cli/alias/unset.md index 5ef3802100..3cb9f81dbd 100644 --- a/docs/cli/alias/unset.md +++ b/docs/cli/alias/unset.md @@ -2,6 +2,8 @@ **Usage**: `mise alias unset ` +**Source code**: [`src/cli/alias/unset.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/unset.rs) + **Aliases**: `rm`, `remove`, `delete`, `del` Clears an alias for a plugin diff --git a/docs/cli/backends.md b/docs/cli/backends.md index 526b29593d..a75f95212f 100644 --- a/docs/cli/backends.md +++ b/docs/cli/backends.md @@ -2,10 +2,12 @@ **Usage**: `mise backends ` +**Source code**: [`src/cli/backends.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends.rs) + **Aliases**: `b` Manage backends ## Subcommands -* [`mise backends ls`](/cli/backends/ls.md) +- [`mise backends ls`](/cli/backends/ls.md) diff --git a/docs/cli/backends/ls.md b/docs/cli/backends/ls.md index 8e4aa461af..ac07e96597 100644 --- a/docs/cli/backends/ls.md +++ b/docs/cli/backends/ls.md @@ -2,6 +2,8 @@ **Usage**: `mise backends ls` +**Source code**: [`src/cli/backends/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends/ls.rs) + **Aliases**: `list` List built-in backends diff --git a/docs/cli/bin-paths.md b/docs/cli/bin-paths.md index 2ea4741065..22054d3fe6 100644 --- a/docs/cli/bin-paths.md +++ b/docs/cli/bin-paths.md @@ -2,4 +2,6 @@ **Usage**: `mise bin-paths` +**Source code**: [`src/cli/bin-paths.rs`](https://github.com/jdx/mise/blob/main/src/cli/bin-paths.rs) + List all the active runtime bin paths diff --git a/docs/cli/cache.md b/docs/cli/cache.md index 2e1346ecc4..4c21154496 100644 --- a/docs/cli/cache.md +++ b/docs/cli/cache.md @@ -2,11 +2,13 @@ **Usage**: `mise cache ` +**Source code**: [`src/cli/cache.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache.rs) + Manage the mise cache Run `mise cache` with no args to view the current cache directory. ## Subcommands -* [`mise cache clear [PLUGIN]...`](/cli/cache/clear.md) -* [`mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...`](/cli/cache/prune.md) +- [`mise cache clear [PLUGIN]...`](/cli/cache/clear.md) +- [`mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...`](/cli/cache/prune.md) diff --git a/docs/cli/cache/clear.md b/docs/cli/cache/clear.md index 703fa50584..31a0bdf89c 100644 --- a/docs/cli/cache/clear.md +++ b/docs/cli/cache/clear.md @@ -2,6 +2,8 @@ **Usage**: `mise cache clear [PLUGIN]...` +**Source code**: [`src/cli/cache/clear.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache/clear.rs) + **Aliases**: `c` Deletes all cache files in mise diff --git a/docs/cli/cache/prune.md b/docs/cli/cache/prune.md index 0634ed47be..eaed9807e3 100644 --- a/docs/cli/cache/prune.md +++ b/docs/cli/cache/prune.md @@ -2,6 +2,8 @@ **Usage**: `mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...` +**Source code**: [`src/cli/cache/prune.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache/prune.rs) + **Aliases**: `p` Removes stale mise cache files diff --git a/docs/cli/completion.md b/docs/cli/completion.md index aaaf2a9afc..6110456fbc 100644 --- a/docs/cli/completion.md +++ b/docs/cli/completion.md @@ -2,6 +2,8 @@ **Usage**: `mise completion [SHELL]` +**Source code**: [`src/cli/completion.rs`](https://github.com/jdx/mise/blob/main/src/cli/completion.rs) + Generate shell completions ## Arguments diff --git a/docs/cli/config.md b/docs/cli/config.md index f757327f3f..7114b252f5 100644 --- a/docs/cli/config.md +++ b/docs/cli/config.md @@ -2,6 +2,8 @@ **Usage**: `mise config [--no-header] [-J --json] ` +**Source code**: [`src/cli/config.rs`](https://github.com/jdx/mise/blob/main/src/cli/config.rs) + **Aliases**: `cfg` Manage config files @@ -18,7 +20,7 @@ Output in JSON format ## Subcommands -* [`mise config generate [-o --output ]`](/cli/config/generate.md) -* [`mise config get [-f --file ] [KEY]`](/cli/config/get.md) -* [`mise config ls [--no-header] [-J --json]`](/cli/config/ls.md) -* [`mise config set [-f --file ] [-t --type ] `](/cli/config/set.md) +- [`mise config generate [-o --output ]`](/cli/config/generate.md) +- [`mise config get [-f --file ] [KEY]`](/cli/config/get.md) +- [`mise config ls [--no-header] [-J --json]`](/cli/config/ls.md) +- [`mise config set [-f --file ] [-t --type ] `](/cli/config/set.md) diff --git a/docs/cli/config/generate.md b/docs/cli/config/generate.md index 02a9c36a54..e702a21362 100644 --- a/docs/cli/config/generate.md +++ b/docs/cli/config/generate.md @@ -2,6 +2,8 @@ **Usage**: `mise config generate [-o --output ]` +**Source code**: [`src/cli/config/generate.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/generate.rs) + **Aliases**: `g` [experimental] Generate a mise.toml file diff --git a/docs/cli/config/get.md b/docs/cli/config/get.md index 48fd497865..c3eba4042f 100644 --- a/docs/cli/config/get.md +++ b/docs/cli/config/get.md @@ -2,6 +2,8 @@ **Usage**: `mise config get [-f --file ] [KEY]` +**Source code**: [`src/cli/config/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/get.rs) + Display the value of a setting in a mise.toml file ## Arguments diff --git a/docs/cli/config/ls.md b/docs/cli/config/ls.md index c665ff6cb5..314dbb7580 100644 --- a/docs/cli/config/ls.md +++ b/docs/cli/config/ls.md @@ -2,6 +2,8 @@ **Usage**: `mise config ls [--no-header] [-J --json]` +**Source code**: [`src/cli/config/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/ls.rs) + List config files currently in use ## Flags diff --git a/docs/cli/config/set.md b/docs/cli/config/set.md index 8b8017f91c..0a119c05be 100644 --- a/docs/cli/config/set.md +++ b/docs/cli/config/set.md @@ -2,6 +2,8 @@ **Usage**: `mise config set [-f --file ] [-t --type ] ` +**Source code**: [`src/cli/config/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/set.rs) + Display the value of a setting in a mise.toml file ## Arguments diff --git a/docs/cli/deactivate.md b/docs/cli/deactivate.md index ee0c6cfe50..4f96a34ce5 100644 --- a/docs/cli/deactivate.md +++ b/docs/cli/deactivate.md @@ -2,6 +2,8 @@ **Usage**: `mise deactivate` +**Source code**: [`src/cli/deactivate.rs`](https://github.com/jdx/mise/blob/main/src/cli/deactivate.rs) + Disable mise for current shell session This can be used to temporarily disable mise in a shell session. diff --git a/docs/cli/direnv.md b/docs/cli/direnv.md index 7e68924cf9..3b10de1cbd 100644 --- a/docs/cli/direnv.md +++ b/docs/cli/direnv.md @@ -2,6 +2,8 @@ **Usage**: `mise direnv ` +**Source code**: [`src/cli/direnv.rs`](https://github.com/jdx/mise/blob/main/src/cli/direnv.rs) + Output direnv function to use mise inside direnv See for more information @@ -12,4 +14,4 @@ direnv may not know to update environment variables when legacy file versions ch ## Subcommands -* [`mise direnv activate`](/cli/direnv/activate.md) +- [`mise direnv activate`](/cli/direnv/activate.md) diff --git a/docs/cli/direnv/activate.md b/docs/cli/direnv/activate.md index 85107fe4e5..818c946f04 100644 --- a/docs/cli/direnv/activate.md +++ b/docs/cli/direnv/activate.md @@ -2,6 +2,8 @@ **Usage**: `mise direnv activate` +**Source code**: [`src/cli/direnv/activate.rs`](https://github.com/jdx/mise/blob/main/src/cli/direnv/activate.rs) + Output direnv function to use mise inside direnv See for more information diff --git a/docs/cli/doctor.md b/docs/cli/doctor.md index 7e2751c211..1235df70ce 100644 --- a/docs/cli/doctor.md +++ b/docs/cli/doctor.md @@ -2,6 +2,8 @@ **Usage**: `mise doctor` +**Source code**: [`src/cli/doctor.rs`](https://github.com/jdx/mise/blob/main/src/cli/doctor.rs) + **Aliases**: `dr` Check mise installation for possible problems diff --git a/docs/cli/env.md b/docs/cli/env.md index 98f4ed3c80..4aee308b46 100644 --- a/docs/cli/env.md +++ b/docs/cli/env.md @@ -2,6 +2,8 @@ **Usage**: `mise env [-J --json] [-s --shell ] [TOOL@VERSION]...` +**Source code**: [`src/cli/env.rs`](https://github.com/jdx/mise/blob/main/src/cli/env.rs) + **Aliases**: `e` Exports env vars to activate mise a single time diff --git a/docs/cli/exec.md b/docs/cli/exec.md index 5f9599bf45..d05e6ade57 100644 --- a/docs/cli/exec.md +++ b/docs/cli/exec.md @@ -2,6 +2,8 @@ **Usage**: `mise exec [FLAGS] [TOOL@VERSION]... [COMMAND]...` +**Source code**: [`src/cli/exec.rs`](https://github.com/jdx/mise/blob/main/src/cli/exec.rs) + **Aliases**: `x` Execute a command with tool(s) set diff --git a/docs/cli/generate.md b/docs/cli/generate.md index a0fb076fc4..c9bb885828 100644 --- a/docs/cli/generate.md +++ b/docs/cli/generate.md @@ -2,12 +2,14 @@ **Usage**: `mise generate ` +**Source code**: [`src/cli/generate.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate.rs) + **Aliases**: `g` [experimental] Generate files for various tools/services ## Subcommands -* [`mise generate git-pre-commit [FLAGS]`](/cli/generate/git-pre-commit.md) -* [`mise generate github-action [FLAGS]`](/cli/generate/github-action.md) -* [`mise generate task-docs [FLAGS]`](/cli/generate/task-docs.md) +- [`mise generate git-pre-commit [FLAGS]`](/cli/generate/git-pre-commit.md) +- [`mise generate github-action [FLAGS]`](/cli/generate/github-action.md) +- [`mise generate task-docs [FLAGS]`](/cli/generate/task-docs.md) diff --git a/docs/cli/generate/git-pre-commit.md b/docs/cli/generate/git-pre-commit.md index d0c8127e93..8a6044bdcd 100644 --- a/docs/cli/generate/git-pre-commit.md +++ b/docs/cli/generate/git-pre-commit.md @@ -2,6 +2,8 @@ **Usage**: `mise generate git-pre-commit [FLAGS]` +**Source code**: [`src/cli/generate/git-pre-commit.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/git-pre-commit.rs) + **Aliases**: `pre-commit` [experimental] Generate a git pre-commit hook diff --git a/docs/cli/generate/github-action.md b/docs/cli/generate/github-action.md index 62b8b8b079..81ce9ec476 100644 --- a/docs/cli/generate/github-action.md +++ b/docs/cli/generate/github-action.md @@ -2,6 +2,8 @@ **Usage**: `mise generate github-action [FLAGS]` +**Source code**: [`src/cli/generate/github-action.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/github-action.rs) + [experimental] Generate a GitHub Action workflow file This command generates a GitHub Action workflow file that runs a mise task like `mise run ci` diff --git a/docs/cli/generate/task-docs.md b/docs/cli/generate/task-docs.md index 7f5dffc805..ed5304251b 100644 --- a/docs/cli/generate/task-docs.md +++ b/docs/cli/generate/task-docs.md @@ -2,6 +2,8 @@ **Usage**: `mise generate task-docs [FLAGS]` +**Source code**: [`src/cli/generate/task-docs.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/task-docs.rs) + [experimental] Generate documentation for tasks in a project ## Flags diff --git a/docs/cli/implode.md b/docs/cli/implode.md index 424b2a68b6..6425a27235 100644 --- a/docs/cli/implode.md +++ b/docs/cli/implode.md @@ -2,6 +2,8 @@ **Usage**: `mise implode [--config] [-n --dry-run]` +**Source code**: [`src/cli/implode.rs`](https://github.com/jdx/mise/blob/main/src/cli/implode.rs) + Removes mise CLI and all related data Skips config directory by default. diff --git a/docs/cli/index.md b/docs/cli/index.md index 65da168128..4a22fb3426 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -28,76 +28,76 @@ Answer yes to all confirmation prompts ## Subcommands -* [`mise activate [--shims] [-q --quiet] [SHELL_TYPE]`](/cli/activate.md) -* [`mise alias [-p --plugin ] [--no-header] `](/cli/alias.md) -* [`mise alias get `](/cli/alias/get.md) -* [`mise alias ls [--no-header] [PLUGIN]`](/cli/alias/ls.md) -* [`mise alias set …`](/cli/alias/set.md) -* [`mise alias unset `](/cli/alias/unset.md) -* [`mise backends `](/cli/backends.md) -* [`mise backends ls`](/cli/backends/ls.md) -* [`mise bin-paths`](/cli/bin-paths.md) -* [`mise cache `](/cli/cache.md) -* [`mise cache clear [PLUGIN]...`](/cli/cache/clear.md) -* [`mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...`](/cli/cache/prune.md) -* [`mise completion [SHELL]`](/cli/completion.md) -* [`mise config [--no-header] [-J --json] `](/cli/config.md) -* [`mise config generate [-o --output ]`](/cli/config/generate.md) -* [`mise config get [-f --file ] [KEY]`](/cli/config/get.md) -* [`mise config ls [--no-header] [-J --json]`](/cli/config/ls.md) -* [`mise config set [-f --file ] [-t --type ] `](/cli/config/set.md) -* [`mise deactivate`](/cli/deactivate.md) -* [`mise direnv `](/cli/direnv.md) -* [`mise direnv activate`](/cli/direnv/activate.md) -* [`mise doctor`](/cli/doctor.md) -* [`mise env [-J --json] [-s --shell ] [TOOL@VERSION]...`](/cli/env.md) -* [`mise exec [FLAGS] [TOOL@VERSION]... [COMMAND]...`](/cli/exec.md) -* [`mise generate `](/cli/generate.md) -* [`mise generate git-pre-commit [FLAGS]`](/cli/generate/git-pre-commit.md) -* [`mise generate github-action [FLAGS]`](/cli/generate/github-action.md) -* [`mise generate task-docs [FLAGS]`](/cli/generate/task-docs.md) -* [`mise implode [--config] [-n --dry-run]`](/cli/implode.md) -* [`mise install [FLAGS] [TOOL@VERSION]...`](/cli/install.md) -* [`mise latest [-i --installed] `](/cli/latest.md) -* [`mise link [-f --force] `](/cli/link.md) -* [`mise ls [FLAGS] [PLUGIN]...`](/cli/ls.md) -* [`mise ls-remote [--all] [TOOL@VERSION] [PREFIX]`](/cli/ls-remote.md) -* [`mise outdated [FLAGS] [TOOL@VERSION]...`](/cli/outdated.md) -* [`mise plugins [FLAGS] `](/cli/plugins.md) -* [`mise plugins install [FLAGS] [NEW_PLUGIN] [GIT_URL]`](/cli/plugins/install.md) -* [`mise plugins link [-f --force] [PATH]`](/cli/plugins/link.md) -* [`mise plugins ls [FLAGS]`](/cli/plugins/ls.md) -* [`mise plugins ls-remote [-u --urls] [--only-names]`](/cli/plugins/ls-remote.md) -* [`mise plugins uninstall [-p --purge] [-a --all] [PLUGIN]...`](/cli/plugins/uninstall.md) -* [`mise plugins update [-j --jobs ] [PLUGIN]...`](/cli/plugins/update.md) -* [`mise prune [FLAGS] [PLUGIN]...`](/cli/prune.md) -* [`mise registry [NAME]`](/cli/registry.md) -* [`mise reshim [-f --force]`](/cli/reshim.md) -* [`mise run [FLAGS]`](/cli/run.md) -* [`mise self-update [FLAGS] [VERSION]`](/cli/self-update.md) -* [`mise set [--file ] [-g --global] [ENV_VARS]...`](/cli/set.md) -* [`mise settings [--keys] `](/cli/settings.md) -* [`mise settings add `](/cli/settings/add.md) -* [`mise settings get `](/cli/settings/get.md) -* [`mise settings ls [--keys]`](/cli/settings/ls.md) -* [`mise settings set `](/cli/settings/set.md) -* [`mise settings unset `](/cli/settings/unset.md) -* [`mise shell [FLAGS] [TOOL@VERSION]...`](/cli/shell.md) -* [`mise sync `](/cli/sync.md) -* [`mise sync node [FLAGS]`](/cli/sync/node.md) -* [`mise sync python <--pyenv>`](/cli/sync/python.md) -* [`mise tasks [FLAGS] `](/cli/tasks.md) -* [`mise tasks deps [--hidden] [--dot] [TASKS]...`](/cli/tasks/deps.md) -* [`mise tasks edit [-p --path] `](/cli/tasks/edit.md) -* [`mise tasks info [-J --json] `](/cli/tasks/info.md) -* [`mise tasks ls [FLAGS]`](/cli/tasks/ls.md) -* [`mise tasks run [FLAGS] [TASK] [ARGS]...`](/cli/tasks/run.md) -* [`mise trust [FLAGS] [CONFIG_FILE]`](/cli/trust.md) -* [`mise uninstall [-a --all] [-n --dry-run] [INSTALLED_TOOL@VERSION]...`](/cli/uninstall.md) -* [`mise unset [-f --file ] [-g --global] [KEYS]...`](/cli/unset.md) -* [`mise upgrade [FLAGS] [TOOL@VERSION]...`](/cli/upgrade.md) -* [`mise use [FLAGS] [TOOL@VERSION]...`](/cli/use.md) -* [`mise version`](/cli/version.md) -* [`mise watch [-t --task... ] [-g --glob... ] [ARGS]...`](/cli/watch.md) -* [`mise where `](/cli/where.md) -* [`mise which [FLAGS] `](/cli/which.md) +- [`mise activate [--shims] [-q --quiet] [SHELL_TYPE]`](/cli/activate.md) +- [`mise alias [-p --plugin ] [--no-header] `](/cli/alias.md) +- [`mise alias get `](/cli/alias/get.md) +- [`mise alias ls [--no-header] [PLUGIN]`](/cli/alias/ls.md) +- [`mise alias set …`](/cli/alias/set.md) +- [`mise alias unset `](/cli/alias/unset.md) +- [`mise backends `](/cli/backends.md) +- [`mise backends ls`](/cli/backends/ls.md) +- [`mise bin-paths`](/cli/bin-paths.md) +- [`mise cache `](/cli/cache.md) +- [`mise cache clear [PLUGIN]...`](/cli/cache/clear.md) +- [`mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...`](/cli/cache/prune.md) +- [`mise completion [SHELL]`](/cli/completion.md) +- [`mise config [--no-header] [-J --json] `](/cli/config.md) +- [`mise config generate [-o --output ]`](/cli/config/generate.md) +- [`mise config get [-f --file ] [KEY]`](/cli/config/get.md) +- [`mise config ls [--no-header] [-J --json]`](/cli/config/ls.md) +- [`mise config set [-f --file ] [-t --type ] `](/cli/config/set.md) +- [`mise deactivate`](/cli/deactivate.md) +- [`mise direnv `](/cli/direnv.md) +- [`mise direnv activate`](/cli/direnv/activate.md) +- [`mise doctor`](/cli/doctor.md) +- [`mise env [-J --json] [-s --shell ] [TOOL@VERSION]...`](/cli/env.md) +- [`mise exec [FLAGS] [TOOL@VERSION]... [COMMAND]...`](/cli/exec.md) +- [`mise generate `](/cli/generate.md) +- [`mise generate git-pre-commit [FLAGS]`](/cli/generate/git-pre-commit.md) +- [`mise generate github-action [FLAGS]`](/cli/generate/github-action.md) +- [`mise generate task-docs [FLAGS]`](/cli/generate/task-docs.md) +- [`mise implode [--config] [-n --dry-run]`](/cli/implode.md) +- [`mise install [FLAGS] [TOOL@VERSION]...`](/cli/install.md) +- [`mise latest [-i --installed] `](/cli/latest.md) +- [`mise link [-f --force] `](/cli/link.md) +- [`mise ls [FLAGS] [PLUGIN]...`](/cli/ls.md) +- [`mise ls-remote [--all] [TOOL@VERSION] [PREFIX]`](/cli/ls-remote.md) +- [`mise outdated [FLAGS] [TOOL@VERSION]...`](/cli/outdated.md) +- [`mise plugins [FLAGS] `](/cli/plugins.md) +- [`mise plugins install [FLAGS] [NEW_PLUGIN] [GIT_URL]`](/cli/plugins/install.md) +- [`mise plugins link [-f --force] [PATH]`](/cli/plugins/link.md) +- [`mise plugins ls [FLAGS]`](/cli/plugins/ls.md) +- [`mise plugins ls-remote [-u --urls] [--only-names]`](/cli/plugins/ls-remote.md) +- [`mise plugins uninstall [-p --purge] [-a --all] [PLUGIN]...`](/cli/plugins/uninstall.md) +- [`mise plugins update [-j --jobs ] [PLUGIN]...`](/cli/plugins/update.md) +- [`mise prune [FLAGS] [PLUGIN]...`](/cli/prune.md) +- [`mise registry [NAME]`](/cli/registry.md) +- [`mise reshim [-f --force]`](/cli/reshim.md) +- [`mise run [FLAGS]`](/cli/run.md) +- [`mise self-update [FLAGS] [VERSION]`](/cli/self-update.md) +- [`mise set [--file ] [-g --global] [ENV_VARS]...`](/cli/set.md) +- [`mise settings [--keys] `](/cli/settings.md) +- [`mise settings add `](/cli/settings/add.md) +- [`mise settings get `](/cli/settings/get.md) +- [`mise settings ls [--keys]`](/cli/settings/ls.md) +- [`mise settings set `](/cli/settings/set.md) +- [`mise settings unset `](/cli/settings/unset.md) +- [`mise shell [FLAGS] [TOOL@VERSION]...`](/cli/shell.md) +- [`mise sync `](/cli/sync.md) +- [`mise sync node [FLAGS]`](/cli/sync/node.md) +- [`mise sync python <--pyenv>`](/cli/sync/python.md) +- [`mise tasks [FLAGS] `](/cli/tasks.md) +- [`mise tasks deps [--hidden] [--dot] [TASKS]...`](/cli/tasks/deps.md) +- [`mise tasks edit [-p --path] `](/cli/tasks/edit.md) +- [`mise tasks info [-J --json] `](/cli/tasks/info.md) +- [`mise tasks ls [FLAGS]`](/cli/tasks/ls.md) +- [`mise tasks run [FLAGS] [TASK] [ARGS]...`](/cli/tasks/run.md) +- [`mise trust [FLAGS] [CONFIG_FILE]`](/cli/trust.md) +- [`mise uninstall [-a --all] [-n --dry-run] [INSTALLED_TOOL@VERSION]...`](/cli/uninstall.md) +- [`mise unset [-f --file ] [-g --global] [KEYS]...`](/cli/unset.md) +- [`mise upgrade [FLAGS] [TOOL@VERSION]...`](/cli/upgrade.md) +- [`mise use [FLAGS] [TOOL@VERSION]...`](/cli/use.md) +- [`mise version`](/cli/version.md) +- [`mise watch [-t --task... ] [-g --glob... ] [ARGS]...`](/cli/watch.md) +- [`mise where `](/cli/where.md) +- [`mise which [FLAGS] `](/cli/which.md) diff --git a/docs/cli/install.md b/docs/cli/install.md index eeccb47190..7426c24920 100644 --- a/docs/cli/install.md +++ b/docs/cli/install.md @@ -2,6 +2,8 @@ **Usage**: `mise install [FLAGS] [TOOL@VERSION]...` +**Source code**: [`src/cli/install.rs`](https://github.com/jdx/mise/blob/main/src/cli/install.rs) + **Aliases**: `i` Install a tool version diff --git a/docs/cli/latest.md b/docs/cli/latest.md index 27f487f4db..3f16c5ebd8 100644 --- a/docs/cli/latest.md +++ b/docs/cli/latest.md @@ -2,6 +2,8 @@ **Usage**: `mise latest [-i --installed] ` +**Source code**: [`src/cli/latest.rs`](https://github.com/jdx/mise/blob/main/src/cli/latest.rs) + Gets the latest available version for a plugin Supports prefixes such as `node@20` to get the latest version of node 20. diff --git a/docs/cli/link.md b/docs/cli/link.md index f605222a93..ac3c4d1b95 100644 --- a/docs/cli/link.md +++ b/docs/cli/link.md @@ -2,6 +2,8 @@ **Usage**: `mise link [-f --force] ` +**Source code**: [`src/cli/link.rs`](https://github.com/jdx/mise/blob/main/src/cli/link.rs) + **Aliases**: `ln` Symlinks a tool version into mise diff --git a/docs/cli/ls-remote.md b/docs/cli/ls-remote.md index 0d14e081b3..5d498699b0 100644 --- a/docs/cli/ls-remote.md +++ b/docs/cli/ls-remote.md @@ -2,6 +2,8 @@ **Usage**: `mise ls-remote [--all] [TOOL@VERSION] [PREFIX]` +**Source code**: [`src/cli/ls-remote.rs`](https://github.com/jdx/mise/blob/main/src/cli/ls-remote.rs) + 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. diff --git a/docs/cli/ls.md b/docs/cli/ls.md index 5e683ab668..476df0160b 100644 --- a/docs/cli/ls.md +++ b/docs/cli/ls.md @@ -2,6 +2,8 @@ **Usage**: `mise ls [FLAGS] [PLUGIN]...` +**Source code**: [`src/cli/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/ls.rs) + **Aliases**: `list` List installed and active tool versions diff --git a/docs/cli/outdated.md b/docs/cli/outdated.md index c403054839..2e8ad1e79b 100644 --- a/docs/cli/outdated.md +++ b/docs/cli/outdated.md @@ -2,6 +2,8 @@ **Usage**: `mise outdated [FLAGS] [TOOL@VERSION]...` +**Source code**: [`src/cli/outdated.rs`](https://github.com/jdx/mise/blob/main/src/cli/outdated.rs) + Shows outdated tool versions See `mise upgrade` to upgrade these versions. diff --git a/docs/cli/plugins.md b/docs/cli/plugins.md index e56b02d94d..7bb08950aa 100644 --- a/docs/cli/plugins.md +++ b/docs/cli/plugins.md @@ -2,6 +2,8 @@ **Usage**: `mise plugins [FLAGS] ` +**Source code**: [`src/cli/plugins.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins.rs) + **Aliases**: `p` Manage plugins @@ -27,9 +29,9 @@ e.g.: ## Subcommands -* [`mise plugins install [FLAGS] [NEW_PLUGIN] [GIT_URL]`](/cli/plugins/install.md) -* [`mise plugins link [-f --force] [PATH]`](/cli/plugins/link.md) -* [`mise plugins ls [FLAGS]`](/cli/plugins/ls.md) -* [`mise plugins ls-remote [-u --urls] [--only-names]`](/cli/plugins/ls-remote.md) -* [`mise plugins uninstall [-p --purge] [-a --all] [PLUGIN]...`](/cli/plugins/uninstall.md) -* [`mise plugins update [-j --jobs ] [PLUGIN]...`](/cli/plugins/update.md) +- [`mise plugins install [FLAGS] [NEW_PLUGIN] [GIT_URL]`](/cli/plugins/install.md) +- [`mise plugins link [-f --force] [PATH]`](/cli/plugins/link.md) +- [`mise plugins ls [FLAGS]`](/cli/plugins/ls.md) +- [`mise plugins ls-remote [-u --urls] [--only-names]`](/cli/plugins/ls-remote.md) +- [`mise plugins uninstall [-p --purge] [-a --all] [PLUGIN]...`](/cli/plugins/uninstall.md) +- [`mise plugins update [-j --jobs ] [PLUGIN]...`](/cli/plugins/update.md) diff --git a/docs/cli/plugins/install.md b/docs/cli/plugins/install.md index 125f12a961..21cff2927d 100644 --- a/docs/cli/plugins/install.md +++ b/docs/cli/plugins/install.md @@ -2,6 +2,8 @@ **Usage**: `mise plugins install [FLAGS] [NEW_PLUGIN] [GIT_URL]` +**Source code**: [`src/cli/plugins/install.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/install.rs) + **Aliases**: `i`, `a`, `add` Install a plugin diff --git a/docs/cli/plugins/link.md b/docs/cli/plugins/link.md index 5af5ff73a4..0be7dd0cc3 100644 --- a/docs/cli/plugins/link.md +++ b/docs/cli/plugins/link.md @@ -2,6 +2,8 @@ **Usage**: `mise plugins link [-f --force] [PATH]` +**Source code**: [`src/cli/plugins/link.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/link.rs) + **Aliases**: `ln` Symlinks a plugin into mise diff --git a/docs/cli/plugins/ls-remote.md b/docs/cli/plugins/ls-remote.md index b2e14fc6a9..e8a8704d8a 100644 --- a/docs/cli/plugins/ls-remote.md +++ b/docs/cli/plugins/ls-remote.md @@ -2,6 +2,8 @@ **Usage**: `mise plugins ls-remote [-u --urls] [--only-names]` +**Source code**: [`src/cli/plugins/ls-remote.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/ls-remote.rs) + **Aliases**: `list-remote`, `list-all` List all available remote plugins diff --git a/docs/cli/plugins/ls.md b/docs/cli/plugins/ls.md index 0685356b21..067710cfb2 100644 --- a/docs/cli/plugins/ls.md +++ b/docs/cli/plugins/ls.md @@ -2,6 +2,8 @@ **Usage**: `mise plugins ls [FLAGS]` +**Source code**: [`src/cli/plugins/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/ls.rs) + **Aliases**: `list` List installed plugins diff --git a/docs/cli/plugins/uninstall.md b/docs/cli/plugins/uninstall.md index 0044758d72..22da97c699 100644 --- a/docs/cli/plugins/uninstall.md +++ b/docs/cli/plugins/uninstall.md @@ -2,6 +2,8 @@ **Usage**: `mise plugins uninstall [-p --purge] [-a --all] [PLUGIN]...` +**Source code**: [`src/cli/plugins/uninstall.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/uninstall.rs) + **Aliases**: `remove`, `rm` Removes a plugin diff --git a/docs/cli/plugins/update.md b/docs/cli/plugins/update.md index f5c9c670bc..0503f4c2f4 100644 --- a/docs/cli/plugins/update.md +++ b/docs/cli/plugins/update.md @@ -2,6 +2,8 @@ **Usage**: `mise plugins update [-j --jobs ] [PLUGIN]...` +**Source code**: [`src/cli/plugins/update.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/update.rs) + **Aliases**: `up`, `upgrade` Updates a plugin to the latest version diff --git a/docs/cli/prune.md b/docs/cli/prune.md index 1e062c7760..1e2836bff3 100644 --- a/docs/cli/prune.md +++ b/docs/cli/prune.md @@ -2,6 +2,8 @@ **Usage**: `mise prune [FLAGS] [PLUGIN]...` +**Source code**: [`src/cli/prune.rs`](https://github.com/jdx/mise/blob/main/src/cli/prune.rs) + Delete unused versions of tools mise tracks which config files have been used in ~/.local/share/mise/tracked_config_files diff --git a/docs/cli/registry.md b/docs/cli/registry.md index 9f025ff49b..9c213b9f33 100644 --- a/docs/cli/registry.md +++ b/docs/cli/registry.md @@ -2,6 +2,8 @@ **Usage**: `mise registry [NAME]` +**Source code**: [`src/cli/registry.rs`](https://github.com/jdx/mise/blob/main/src/cli/registry.rs) + List available tools to install This command lists the tools available in the registry as shorthand names. diff --git a/docs/cli/reshim.md b/docs/cli/reshim.md index bb7b8e2202..5ba2d115cf 100644 --- a/docs/cli/reshim.md +++ b/docs/cli/reshim.md @@ -2,6 +2,8 @@ **Usage**: `mise reshim [-f --force]` +**Source code**: [`src/cli/reshim.rs`](https://github.com/jdx/mise/blob/main/src/cli/reshim.rs) + 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. diff --git a/docs/cli/run.md b/docs/cli/run.md index 2c557204ef..ea9dde9f74 100644 --- a/docs/cli/run.md +++ b/docs/cli/run.md @@ -2,6 +2,8 @@ **Usage**: `mise run [FLAGS]` +**Source code**: [`src/cli/run.rs`](https://github.com/jdx/mise/blob/main/src/cli/run.rs) + **Aliases**: `r` [experimental] Run task(s) diff --git a/docs/cli/self-update.md b/docs/cli/self-update.md index 105baed5cc..b73d99e7b4 100644 --- a/docs/cli/self-update.md +++ b/docs/cli/self-update.md @@ -2,6 +2,8 @@ **Usage**: `mise self-update [FLAGS] [VERSION]` +**Source code**: [`src/cli/self-update.rs`](https://github.com/jdx/mise/blob/main/src/cli/self-update.rs) + Updates mise itself. Uses the GitHub Releases API to find the latest release and binary. diff --git a/docs/cli/set.md b/docs/cli/set.md index be92564cf0..ac1f12f511 100644 --- a/docs/cli/set.md +++ b/docs/cli/set.md @@ -2,6 +2,8 @@ **Usage**: `mise set [--file ] [-g --global] [ENV_VARS]...` +**Source code**: [`src/cli/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/set.rs) + Set environment variables in mise.toml By default, this command modifies `mise.toml` in the current directory. diff --git a/docs/cli/settings.md b/docs/cli/settings.md index e7ecf9d35b..978b516ac6 100644 --- a/docs/cli/settings.md +++ b/docs/cli/settings.md @@ -2,6 +2,8 @@ **Usage**: `mise settings [--keys] ` +**Source code**: [`src/cli/settings.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings.rs) + Manage settings ## Flags @@ -12,8 +14,8 @@ Only display key names for each setting ## Subcommands -* [`mise settings add `](/cli/settings/add.md) -* [`mise settings get `](/cli/settings/get.md) -* [`mise settings ls [--keys]`](/cli/settings/ls.md) -* [`mise settings set `](/cli/settings/set.md) -* [`mise settings unset `](/cli/settings/unset.md) +- [`mise settings add `](/cli/settings/add.md) +- [`mise settings get `](/cli/settings/get.md) +- [`mise settings ls [--keys]`](/cli/settings/ls.md) +- [`mise settings set `](/cli/settings/set.md) +- [`mise settings unset `](/cli/settings/unset.md) diff --git a/docs/cli/settings/add.md b/docs/cli/settings/add.md index ee9635480d..bc0950a377 100644 --- a/docs/cli/settings/add.md +++ b/docs/cli/settings/add.md @@ -2,6 +2,8 @@ **Usage**: `mise settings add ` +**Source code**: [`src/cli/settings/add.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/add.rs) + Adds a setting to the configuration file Used with an array setting, this will append the value to the array. diff --git a/docs/cli/settings/get.md b/docs/cli/settings/get.md index 40e3afe099..a8bbc1e2d1 100644 --- a/docs/cli/settings/get.md +++ b/docs/cli/settings/get.md @@ -2,6 +2,8 @@ **Usage**: `mise settings get ` +**Source code**: [`src/cli/settings/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/get.rs) + Show a current setting This is the contents of a single entry in ~/.config/mise/config.toml diff --git a/docs/cli/settings/ls.md b/docs/cli/settings/ls.md index 20d5df1678..a25302ca97 100644 --- a/docs/cli/settings/ls.md +++ b/docs/cli/settings/ls.md @@ -2,6 +2,8 @@ **Usage**: `mise settings ls [--keys]` +**Source code**: [`src/cli/settings/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/ls.rs) + **Aliases**: `list` Show current settings diff --git a/docs/cli/settings/set.md b/docs/cli/settings/set.md index c1f98fce69..e39c7607bf 100644 --- a/docs/cli/settings/set.md +++ b/docs/cli/settings/set.md @@ -2,6 +2,8 @@ **Usage**: `mise settings set ` +**Source code**: [`src/cli/settings/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/set.rs) + **Aliases**: `create` Add/update a setting diff --git a/docs/cli/settings/unset.md b/docs/cli/settings/unset.md index f538aa7c6a..1e5f70bf98 100644 --- a/docs/cli/settings/unset.md +++ b/docs/cli/settings/unset.md @@ -2,6 +2,8 @@ **Usage**: `mise settings unset ` +**Source code**: [`src/cli/settings/unset.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/unset.rs) + **Aliases**: `rm`, `remove`, `delete`, `del` Clears a setting diff --git a/docs/cli/shell.md b/docs/cli/shell.md index b3f5ec1e49..2fa0a743be 100644 --- a/docs/cli/shell.md +++ b/docs/cli/shell.md @@ -2,6 +2,8 @@ **Usage**: `mise shell [FLAGS] [TOOL@VERSION]...` +**Source code**: [`src/cli/shell.rs`](https://github.com/jdx/mise/blob/main/src/cli/shell.rs) + **Aliases**: `sh` Sets a tool version for the current session. diff --git a/docs/cli/sync.md b/docs/cli/sync.md index e6d0d0a3f8..928c76425d 100644 --- a/docs/cli/sync.md +++ b/docs/cli/sync.md @@ -2,9 +2,11 @@ **Usage**: `mise sync ` +**Source code**: [`src/cli/sync.rs`](https://github.com/jdx/mise/blob/main/src/cli/sync.rs) + Add tool versions from external tools to mise ## Subcommands -* [`mise sync node [FLAGS]`](/cli/sync/node.md) -* [`mise sync python <--pyenv>`](/cli/sync/python.md) +- [`mise sync node [FLAGS]`](/cli/sync/node.md) +- [`mise sync python <--pyenv>`](/cli/sync/python.md) diff --git a/docs/cli/sync/node.md b/docs/cli/sync/node.md index 02cffd27a5..3c77bbf6b4 100644 --- a/docs/cli/sync/node.md +++ b/docs/cli/sync/node.md @@ -2,6 +2,8 @@ **Usage**: `mise sync node [FLAGS]` +**Source code**: [`src/cli/sync/node.rs`](https://github.com/jdx/mise/blob/main/src/cli/sync/node.rs) + Symlinks all tool versions from an external tool into mise For example, use this to import all Homebrew node installs into mise diff --git a/docs/cli/sync/python.md b/docs/cli/sync/python.md index db0db7eb88..7992b26d5e 100644 --- a/docs/cli/sync/python.md +++ b/docs/cli/sync/python.md @@ -2,6 +2,8 @@ **Usage**: `mise sync python <--pyenv>` +**Source code**: [`src/cli/sync/python.rs`](https://github.com/jdx/mise/blob/main/src/cli/sync/python.rs) + Symlinks all tool versions from an external tool into mise For example, use this to import all pyenv installs into mise diff --git a/docs/cli/tasks.md b/docs/cli/tasks.md index f9c067ccc8..cd4f6c63c7 100644 --- a/docs/cli/tasks.md +++ b/docs/cli/tasks.md @@ -2,6 +2,8 @@ **Usage**: `mise tasks [FLAGS] ` +**Source code**: [`src/cli/tasks.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks.rs) + **Aliases**: `t` [experimental] Manage tasks @@ -46,11 +48,11 @@ Output in JSON format ## Subcommands -* [`mise tasks deps [--hidden] [--dot] [TASKS]...`](/cli/tasks/deps.md) -* [`mise tasks edit [-p --path] `](/cli/tasks/edit.md) -* [`mise tasks info [-J --json] `](/cli/tasks/info.md) -* [`mise tasks ls [FLAGS]`](/cli/tasks/ls.md) -* [`mise tasks run [FLAGS] [TASK] [ARGS]...`](/cli/tasks/run.md) +- [`mise tasks deps [--hidden] [--dot] [TASKS]...`](/cli/tasks/deps.md) +- [`mise tasks edit [-p --path] `](/cli/tasks/edit.md) +- [`mise tasks info [-J --json] `](/cli/tasks/info.md) +- [`mise tasks ls [FLAGS]`](/cli/tasks/ls.md) +- [`mise tasks run [FLAGS] [TASK] [ARGS]...`](/cli/tasks/run.md) Examples: diff --git a/docs/cli/tasks/deps.md b/docs/cli/tasks/deps.md index 52c5bdc15b..2932e6e3ec 100644 --- a/docs/cli/tasks/deps.md +++ b/docs/cli/tasks/deps.md @@ -2,6 +2,8 @@ **Usage**: `mise tasks deps [--hidden] [--dot] [TASKS]...` +**Source code**: [`src/cli/tasks/deps.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/deps.rs) + [experimental] Display a tree visualization of a dependency graph ## Arguments diff --git a/docs/cli/tasks/edit.md b/docs/cli/tasks/edit.md index 8e6dd54266..2f1cac241f 100644 --- a/docs/cli/tasks/edit.md +++ b/docs/cli/tasks/edit.md @@ -2,6 +2,8 @@ **Usage**: `mise tasks edit [-p --path] ` +**Source code**: [`src/cli/tasks/edit.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/edit.rs) + [experimental] Edit a tasks with $EDITOR The tasks will be created as a standalone script if it does not already exist. diff --git a/docs/cli/tasks/info.md b/docs/cli/tasks/info.md index e72b5b81e1..b882e83bf0 100644 --- a/docs/cli/tasks/info.md +++ b/docs/cli/tasks/info.md @@ -2,6 +2,8 @@ **Usage**: `mise tasks info [-J --json] ` +**Source code**: [`src/cli/tasks/info.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/info.rs) + [experimental] Get information about a task ## Arguments diff --git a/docs/cli/tasks/ls.md b/docs/cli/tasks/ls.md index d8e79074b7..917e502652 100644 --- a/docs/cli/tasks/ls.md +++ b/docs/cli/tasks/ls.md @@ -2,6 +2,8 @@ **Usage**: `mise tasks ls [FLAGS]` +**Source code**: [`src/cli/tasks/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/ls.rs) + [experimental] 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. diff --git a/docs/cli/tasks/run.md b/docs/cli/tasks/run.md index 5383117e41..ee297dcb52 100644 --- a/docs/cli/tasks/run.md +++ b/docs/cli/tasks/run.md @@ -2,6 +2,8 @@ **Usage**: `mise tasks run [FLAGS] [TASK] [ARGS]...` +**Source code**: [`src/cli/tasks/run.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/run.rs) + **Aliases**: `r` [experimental] Run task(s) diff --git a/docs/cli/trust.md b/docs/cli/trust.md index 01b3a92911..62e46eeb48 100644 --- a/docs/cli/trust.md +++ b/docs/cli/trust.md @@ -2,6 +2,8 @@ **Usage**: `mise trust [FLAGS] [CONFIG_FILE]` +**Source code**: [`src/cli/trust.rs`](https://github.com/jdx/mise/blob/main/src/cli/trust.rs) + Marks a config file as trusted This means mise will parse the file with potentially dangerous diff --git a/docs/cli/uninstall.md b/docs/cli/uninstall.md index 43f2704624..c2b3ede751 100644 --- a/docs/cli/uninstall.md +++ b/docs/cli/uninstall.md @@ -2,6 +2,8 @@ **Usage**: `mise uninstall [-a --all] [-n --dry-run] [INSTALLED_TOOL@VERSION]...` +**Source code**: [`src/cli/uninstall.rs`](https://github.com/jdx/mise/blob/main/src/cli/uninstall.rs) + **Aliases**: `remove`, `rm` Removes installed tool versions diff --git a/docs/cli/unset.md b/docs/cli/unset.md index ee3815622e..78de26b4ba 100644 --- a/docs/cli/unset.md +++ b/docs/cli/unset.md @@ -2,6 +2,8 @@ **Usage**: `mise unset [-f --file ] [-g --global] [KEYS]...` +**Source code**: [`src/cli/unset.rs`](https://github.com/jdx/mise/blob/main/src/cli/unset.rs) + Remove environment variable(s) from the config file. By default, this command modifies `mise.toml` in the current directory. diff --git a/docs/cli/upgrade.md b/docs/cli/upgrade.md index 664ca4a036..bbb7d47a8d 100644 --- a/docs/cli/upgrade.md +++ b/docs/cli/upgrade.md @@ -2,6 +2,8 @@ **Usage**: `mise upgrade [FLAGS] [TOOL@VERSION]...` +**Source code**: [`src/cli/upgrade.rs`](https://github.com/jdx/mise/blob/main/src/cli/upgrade.rs) + **Aliases**: `up` Upgrades outdated tools diff --git a/docs/cli/use.md b/docs/cli/use.md index 5e54bd5f2b..5536fd0f86 100644 --- a/docs/cli/use.md +++ b/docs/cli/use.md @@ -2,6 +2,8 @@ **Usage**: `mise use [FLAGS] [TOOL@VERSION]...` +**Source code**: [`src/cli/use.rs`](https://github.com/jdx/mise/blob/main/src/cli/use.rs) + **Aliases**: `u` Installs a tool and adds the version it to mise.toml. diff --git a/docs/cli/version.md b/docs/cli/version.md index 69318ef50c..dc58bc6138 100644 --- a/docs/cli/version.md +++ b/docs/cli/version.md @@ -2,6 +2,8 @@ **Usage**: `mise version` +**Source code**: [`src/cli/version.rs`](https://github.com/jdx/mise/blob/main/src/cli/version.rs) + **Aliases**: `v` Display the version of mise diff --git a/docs/cli/watch.md b/docs/cli/watch.md index d9444a5c79..65af112dae 100644 --- a/docs/cli/watch.md +++ b/docs/cli/watch.md @@ -2,6 +2,8 @@ **Usage**: `mise watch [-t --task... ] [-g --glob... ] [ARGS]...` +**Source code**: [`src/cli/watch.rs`](https://github.com/jdx/mise/blob/main/src/cli/watch.rs) + **Aliases**: `w` [experimental] Run task(s) and watch for changes to rerun it diff --git a/docs/cli/where.md b/docs/cli/where.md index 668ddd6009..afb6b48867 100644 --- a/docs/cli/where.md +++ b/docs/cli/where.md @@ -2,6 +2,8 @@ **Usage**: `mise where ` +**Source code**: [`src/cli/where.rs`](https://github.com/jdx/mise/blob/main/src/cli/where.rs) + Display the installation path for a tool The tool must be installed for this to work. diff --git a/docs/cli/which.md b/docs/cli/which.md index 24ed626398..10f3f7f15c 100644 --- a/docs/cli/which.md +++ b/docs/cli/which.md @@ -2,6 +2,8 @@ **Usage**: `mise which [FLAGS] ` +**Source code**: [`src/cli/which.rs`](https://github.com/jdx/mise/blob/main/src/cli/which.rs) + Shows the path that a tool's bin points to. Use this to figure out what version of a tool is currently active. diff --git a/mise.usage.kdl b/mise.usage.kdl index 0c7b1ae322..fc0794a7b1 100644 --- a/mise.usage.kdl +++ b/mise.usage.kdl @@ -1507,6 +1507,8 @@ Use this to figure out what version of a tool is currently active." cmd "render-help" hide=true help="internal command to generate markdown from help" cmd "render-mangen" hide=true help="internal command to generate markdown from help" +source_code_link_template "https://github.com/jdx/mise/blob/main/src/cli/{{path}}.rs" + complete "alias" run="mise alias ls {{words[PREV]}} | awk '{print $2}'" complete "config_file" type="file" complete "new_plugin" run="mise plugins --all" diff --git a/src/assets/mise-extra.usage.kdl b/src/assets/mise-extra.usage.kdl index e5b742d287..ce9dc0abbc 100644 --- a/src/assets/mise-extra.usage.kdl +++ b/src/assets/mise-extra.usage.kdl @@ -1,3 +1,5 @@ +source_code_link_template "https://github.com/jdx/mise/blob/main/src/cli/{{path}}.rs" + complete "alias" run="mise alias ls {{words[PREV]}} | awk '{print $2}'" complete "config_file" type="file" complete "new_plugin" run="mise plugins --all"