From a7a2a5c57181ad890d73a8e8774028ccc8501fe5 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Mon, 4 Nov 2024 23:11:08 +0000 Subject: [PATCH] [autofix.ci] apply automated fixes --- docs/cli/activate.md | 5 +++-- docs/cli/alias.md | 8 +++++--- docs/cli/alias/get.md | 5 +++-- docs/cli/alias/ls.md | 8 +++++--- docs/cli/alias/set.md | 8 +++++--- docs/cli/alias/unset.md | 8 +++++--- docs/cli/backends.md | 8 +++++--- docs/cli/backends/ls.md | 8 +++++--- docs/cli/bin-paths.md | 5 +++-- docs/cli/cache.md | 5 +++-- docs/cli/cache/clear.md | 8 +++++--- docs/cli/cache/prune.md | 8 +++++--- docs/cli/completion.md | 5 +++-- docs/cli/config.md | 8 +++++--- docs/cli/config/generate.md | 8 +++++--- docs/cli/config/get.md | 5 +++-- docs/cli/config/ls.md | 5 +++-- docs/cli/config/set.md | 5 +++-- docs/cli/deactivate.md | 5 +++-- docs/cli/direnv.md | 5 +++-- docs/cli/direnv/activate.md | 5 +++-- docs/cli/doctor.md | 8 +++++--- docs/cli/env.md | 8 +++++--- docs/cli/exec.md | 8 +++++--- docs/cli/generate.md | 8 +++++--- docs/cli/generate/git-pre-commit.md | 8 +++++--- docs/cli/generate/github-action.md | 5 +++-- docs/cli/generate/task-docs.md | 5 +++-- docs/cli/implode.md | 5 +++-- docs/cli/index.md | 2 +- docs/cli/install.md | 8 +++++--- docs/cli/latest.md | 5 +++-- docs/cli/link.md | 8 +++++--- docs/cli/ls-remote.md | 5 +++-- docs/cli/ls.md | 8 +++++--- docs/cli/outdated.md | 5 +++-- docs/cli/plugins.md | 8 +++++--- docs/cli/plugins/install.md | 8 +++++--- docs/cli/plugins/link.md | 8 +++++--- docs/cli/plugins/ls-remote.md | 8 +++++--- docs/cli/plugins/ls.md | 8 +++++--- docs/cli/plugins/uninstall.md | 8 +++++--- docs/cli/plugins/update.md | 8 +++++--- docs/cli/prune.md | 5 +++-- docs/cli/registry.md | 5 +++-- docs/cli/reshim.md | 5 +++-- docs/cli/run.md | 8 +++++--- docs/cli/self-update.md | 5 +++-- docs/cli/set.md | 5 +++-- docs/cli/settings.md | 5 +++-- docs/cli/settings/add.md | 5 +++-- docs/cli/settings/get.md | 5 +++-- docs/cli/settings/ls.md | 8 +++++--- docs/cli/settings/set.md | 8 +++++--- docs/cli/settings/unset.md | 8 +++++--- docs/cli/shell.md | 8 +++++--- docs/cli/sync.md | 5 +++-- docs/cli/sync/node.md | 5 +++-- docs/cli/sync/python.md | 5 +++-- docs/cli/tasks.md | 8 +++++--- docs/cli/tasks/deps.md | 5 +++-- docs/cli/tasks/edit.md | 5 +++-- docs/cli/tasks/info.md | 5 +++-- docs/cli/tasks/ls.md | 5 +++-- docs/cli/tasks/run.md | 8 +++++--- docs/cli/trust.md | 5 +++-- docs/cli/uninstall.md | 8 +++++--- docs/cli/unset.md | 5 +++-- docs/cli/upgrade.md | 8 +++++--- docs/cli/use.md | 8 +++++--- docs/cli/version.md | 8 +++++--- docs/cli/watch.md | 8 +++++--- docs/cli/where.md | 5 +++-- docs/cli/which.md | 5 +++-- 74 files changed, 294 insertions(+), 184 deletions(-) diff --git a/docs/cli/activate.md b/docs/cli/activate.md index 4b862d3571..fcc927479f 100644 --- a/docs/cli/activate.md +++ b/docs/cli/activate.md @@ -1,7 +1,8 @@ # `mise activate` -- **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) +**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 diff --git a/docs/cli/alias.md b/docs/cli/alias.md index aa6a31260d..c5f619cca9 100644 --- a/docs/cli/alias.md +++ b/docs/cli/alias.md @@ -1,8 +1,10 @@ # `mise alias` -- **Usage**: `mise alias [-p --plugin ] [--no-header] ` -- **Aliases**: `a` -- **Source code**: [`src/cli/alias.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias.rs) +**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 diff --git a/docs/cli/alias/get.md b/docs/cli/alias/get.md index 5028ae2e9a..60c349e23b 100644 --- a/docs/cli/alias/get.md +++ b/docs/cli/alias/get.md @@ -1,7 +1,8 @@ # `mise alias get` -- **Usage**: `mise alias get ` -- **Source code**: [`src/cli/alias/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/get.rs) +**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 diff --git a/docs/cli/alias/ls.md b/docs/cli/alias/ls.md index e1fe8787e3..9aaa69aa41 100644 --- a/docs/cli/alias/ls.md +++ b/docs/cli/alias/ls.md @@ -1,8 +1,10 @@ # `mise alias ls` -- **Usage**: `mise alias ls [--no-header] [PLUGIN]` -- **Aliases**: `list` -- **Source code**: [`src/cli/alias/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/ls.rs) +**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 Shows the aliases that can be specified. diff --git a/docs/cli/alias/set.md b/docs/cli/alias/set.md index 9d3718a575..4f3485bafe 100644 --- a/docs/cli/alias/set.md +++ b/docs/cli/alias/set.md @@ -1,8 +1,10 @@ # `mise alias set` -- **Usage**: `mise alias set …` -- **Aliases**: `add`, `create` -- **Source code**: [`src/cli/alias/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/set.rs) +**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 62eaea1a4d..fbdd8e189d 100644 --- a/docs/cli/alias/unset.md +++ b/docs/cli/alias/unset.md @@ -1,8 +1,10 @@ # `mise alias unset` -- **Usage**: `mise alias unset ` -- **Aliases**: `rm`, `remove`, `delete`, `del` -- **Source code**: [`src/cli/alias/unset.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/unset.rs) +**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 f7caf15fbf..a75f95212f 100644 --- a/docs/cli/backends.md +++ b/docs/cli/backends.md @@ -1,8 +1,10 @@ # `mise backends` -- **Usage**: `mise backends ` -- **Aliases**: `b` -- **Source code**: [`src/cli/backends.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends.rs) +**Usage**: `mise backends ` + +**Source code**: [`src/cli/backends.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends.rs) + +**Aliases**: `b` Manage backends diff --git a/docs/cli/backends/ls.md b/docs/cli/backends/ls.md index 4c9f03abbd..ac07e96597 100644 --- a/docs/cli/backends/ls.md +++ b/docs/cli/backends/ls.md @@ -1,8 +1,10 @@ # `mise backends ls` -- **Usage**: `mise backends ls` -- **Aliases**: `list` -- **Source code**: [`src/cli/backends/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends/ls.rs) +**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 9bdc2f3b72..22054d3fe6 100644 --- a/docs/cli/bin-paths.md +++ b/docs/cli/bin-paths.md @@ -1,6 +1,7 @@ # `mise bin-paths` -- **Usage**: `mise bin-paths` -- **Source code**: [`src/cli/bin-paths.rs`](https://github.com/jdx/mise/blob/main/src/cli/bin-paths.rs) +**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 81d015fc7e..4c21154496 100644 --- a/docs/cli/cache.md +++ b/docs/cli/cache.md @@ -1,7 +1,8 @@ # `mise cache` -- **Usage**: `mise cache ` -- **Source code**: [`src/cli/cache.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache.rs) +**Usage**: `mise cache ` + +**Source code**: [`src/cli/cache.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache.rs) Manage the mise cache diff --git a/docs/cli/cache/clear.md b/docs/cli/cache/clear.md index 60d089fbbb..31a0bdf89c 100644 --- a/docs/cli/cache/clear.md +++ b/docs/cli/cache/clear.md @@ -1,8 +1,10 @@ # `mise cache clear` -- **Usage**: `mise cache clear [PLUGIN]...` -- **Aliases**: `c` -- **Source code**: [`src/cli/cache/clear.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache/clear.rs) +**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 91366f2d20..eaed9807e3 100644 --- a/docs/cli/cache/prune.md +++ b/docs/cli/cache/prune.md @@ -1,8 +1,10 @@ # `mise cache prune` -- **Usage**: `mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...` -- **Aliases**: `p` -- **Source code**: [`src/cli/cache/prune.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache/prune.rs) +**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 6c853baf0a..6110456fbc 100644 --- a/docs/cli/completion.md +++ b/docs/cli/completion.md @@ -1,7 +1,8 @@ # `mise completion` -- **Usage**: `mise completion [SHELL]` -- **Source code**: [`src/cli/completion.rs`](https://github.com/jdx/mise/blob/main/src/cli/completion.rs) +**Usage**: `mise completion [SHELL]` + +**Source code**: [`src/cli/completion.rs`](https://github.com/jdx/mise/blob/main/src/cli/completion.rs) Generate shell completions diff --git a/docs/cli/config.md b/docs/cli/config.md index 8ec54001bd..7114b252f5 100644 --- a/docs/cli/config.md +++ b/docs/cli/config.md @@ -1,8 +1,10 @@ # `mise config` -- **Usage**: `mise config [--no-header] [-J --json] ` -- **Aliases**: `cfg` -- **Source code**: [`src/cli/config.rs`](https://github.com/jdx/mise/blob/main/src/cli/config.rs) +**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 diff --git a/docs/cli/config/generate.md b/docs/cli/config/generate.md index 9d18fcaae9..e702a21362 100644 --- a/docs/cli/config/generate.md +++ b/docs/cli/config/generate.md @@ -1,8 +1,10 @@ # `mise config generate` -- **Usage**: `mise config generate [-o --output ]` -- **Aliases**: `g` -- **Source code**: [`src/cli/config/generate.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/generate.rs) +**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 b272c1a575..c3eba4042f 100644 --- a/docs/cli/config/get.md +++ b/docs/cli/config/get.md @@ -1,7 +1,8 @@ # `mise config get` -- **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) +**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 diff --git a/docs/cli/config/ls.md b/docs/cli/config/ls.md index 04bf93f5c9..314dbb7580 100644 --- a/docs/cli/config/ls.md +++ b/docs/cli/config/ls.md @@ -1,7 +1,8 @@ # `mise config ls` -- **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) +**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 diff --git a/docs/cli/config/set.md b/docs/cli/config/set.md index f7e5e252f2..ef314b50de 100644 --- a/docs/cli/config/set.md +++ b/docs/cli/config/set.md @@ -1,7 +1,8 @@ # `mise config set` -- **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) +**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) Set the value of a setting in a mise.toml file diff --git a/docs/cli/deactivate.md b/docs/cli/deactivate.md index 6d3787b668..4f96a34ce5 100644 --- a/docs/cli/deactivate.md +++ b/docs/cli/deactivate.md @@ -1,7 +1,8 @@ # `mise deactivate` -- **Usage**: `mise deactivate` -- **Source code**: [`src/cli/deactivate.rs`](https://github.com/jdx/mise/blob/main/src/cli/deactivate.rs) +**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 diff --git a/docs/cli/direnv.md b/docs/cli/direnv.md index 288b05d7d8..3b10de1cbd 100644 --- a/docs/cli/direnv.md +++ b/docs/cli/direnv.md @@ -1,7 +1,8 @@ # `mise direnv` -- **Usage**: `mise direnv ` -- **Source code**: [`src/cli/direnv.rs`](https://github.com/jdx/mise/blob/main/src/cli/direnv.rs) +**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 diff --git a/docs/cli/direnv/activate.md b/docs/cli/direnv/activate.md index ccdbe5f882..818c946f04 100644 --- a/docs/cli/direnv/activate.md +++ b/docs/cli/direnv/activate.md @@ -1,7 +1,8 @@ # `mise direnv activate` -- **Usage**: `mise direnv activate` -- **Source code**: [`src/cli/direnv/activate.rs`](https://github.com/jdx/mise/blob/main/src/cli/direnv/activate.rs) +**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 diff --git a/docs/cli/doctor.md b/docs/cli/doctor.md index 63689ac351..1235df70ce 100644 --- a/docs/cli/doctor.md +++ b/docs/cli/doctor.md @@ -1,8 +1,10 @@ # `mise doctor` -- **Usage**: `mise doctor` -- **Aliases**: `dr` -- **Source code**: [`src/cli/doctor.rs`](https://github.com/jdx/mise/blob/main/src/cli/doctor.rs) +**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 1ef70a66c6..413ffa3262 100644 --- a/docs/cli/env.md +++ b/docs/cli/env.md @@ -1,8 +1,10 @@ # `mise env` -- **Usage**: `mise env [-J --json] [-s --shell ] [TOOL@VERSION]...` -- **Aliases**: `e` -- **Source code**: [`src/cli/env.rs`](https://github.com/jdx/mise/blob/main/src/cli/env.rs) +**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 c13384b319..d05e6ade57 100644 --- a/docs/cli/exec.md +++ b/docs/cli/exec.md @@ -1,8 +1,10 @@ # `mise exec` -- **Usage**: `mise exec [FLAGS] [TOOL@VERSION]... [COMMAND]...` -- **Aliases**: `x` -- **Source code**: [`src/cli/exec.rs`](https://github.com/jdx/mise/blob/main/src/cli/exec.rs) +**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 7083ead915..c9bb885828 100644 --- a/docs/cli/generate.md +++ b/docs/cli/generate.md @@ -1,8 +1,10 @@ # `mise generate` -- **Usage**: `mise generate ` -- **Aliases**: `g` -- **Source code**: [`src/cli/generate.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate.rs) +**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 diff --git a/docs/cli/generate/git-pre-commit.md b/docs/cli/generate/git-pre-commit.md index 3656be9b67..8a6044bdcd 100644 --- a/docs/cli/generate/git-pre-commit.md +++ b/docs/cli/generate/git-pre-commit.md @@ -1,8 +1,10 @@ # `mise generate git-pre-commit` -- **Usage**: `mise generate git-pre-commit [FLAGS]` -- **Aliases**: `pre-commit` -- **Source code**: [`src/cli/generate/git-pre-commit.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/git-pre-commit.rs) +**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 d4c01bc0e7..81ce9ec476 100644 --- a/docs/cli/generate/github-action.md +++ b/docs/cli/generate/github-action.md @@ -1,7 +1,8 @@ # `mise generate github-action` -- **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) +**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 diff --git a/docs/cli/generate/task-docs.md b/docs/cli/generate/task-docs.md index bc922f2149..e68ffd4a93 100644 --- a/docs/cli/generate/task-docs.md +++ b/docs/cli/generate/task-docs.md @@ -1,7 +1,8 @@ # `mise generate task-docs` -- **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) +**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) Generate documentation for tasks in a project diff --git a/docs/cli/implode.md b/docs/cli/implode.md index b83ad8203b..6425a27235 100644 --- a/docs/cli/implode.md +++ b/docs/cli/implode.md @@ -1,7 +1,8 @@ # `mise implode` -- **Usage**: `mise implode [--config] [-n --dry-run]` -- **Source code**: [`src/cli/implode.rs`](https://github.com/jdx/mise/blob/main/src/cli/implode.rs) +**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 diff --git a/docs/cli/index.md b/docs/cli/index.md index e32e65c787..4a22fb3426 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -2,7 +2,7 @@ **Usage**: `mise [FLAGS] ` -- **Usage**: `mise [FLAGS] ` +**Usage**: `mise [FLAGS] ` ## Global Flags diff --git a/docs/cli/install.md b/docs/cli/install.md index dc29149a4a..7426c24920 100644 --- a/docs/cli/install.md +++ b/docs/cli/install.md @@ -1,8 +1,10 @@ # `mise install` -- **Usage**: `mise install [FLAGS] [TOOL@VERSION]...` -- **Aliases**: `i` -- **Source code**: [`src/cli/install.rs`](https://github.com/jdx/mise/blob/main/src/cli/install.rs) +**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 a08ad99666..3f16c5ebd8 100644 --- a/docs/cli/latest.md +++ b/docs/cli/latest.md @@ -1,7 +1,8 @@ # `mise latest` -- **Usage**: `mise latest [-i --installed] ` -- **Source code**: [`src/cli/latest.rs`](https://github.com/jdx/mise/blob/main/src/cli/latest.rs) +**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 diff --git a/docs/cli/link.md b/docs/cli/link.md index 09fdb1f87d..ac3c4d1b95 100644 --- a/docs/cli/link.md +++ b/docs/cli/link.md @@ -1,8 +1,10 @@ # `mise link` -- **Usage**: `mise link [-f --force] ` -- **Aliases**: `ln` -- **Source code**: [`src/cli/link.rs`](https://github.com/jdx/mise/blob/main/src/cli/link.rs) +**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 c03b74a7ce..5d498699b0 100644 --- a/docs/cli/ls-remote.md +++ b/docs/cli/ls-remote.md @@ -1,7 +1,8 @@ # `mise ls-remote` -- **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) +**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. diff --git a/docs/cli/ls.md b/docs/cli/ls.md index d184f25dd4..476df0160b 100644 --- a/docs/cli/ls.md +++ b/docs/cli/ls.md @@ -1,8 +1,10 @@ # `mise ls` -- **Usage**: `mise ls [FLAGS] [PLUGIN]...` -- **Aliases**: `list` -- **Source code**: [`src/cli/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/ls.rs) +**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 307bacc40e..2e8ad1e79b 100644 --- a/docs/cli/outdated.md +++ b/docs/cli/outdated.md @@ -1,7 +1,8 @@ # `mise outdated` -- **Usage**: `mise outdated [FLAGS] [TOOL@VERSION]...` -- **Source code**: [`src/cli/outdated.rs`](https://github.com/jdx/mise/blob/main/src/cli/outdated.rs) +**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 diff --git a/docs/cli/plugins.md b/docs/cli/plugins.md index 33c14969d1..7bb08950aa 100644 --- a/docs/cli/plugins.md +++ b/docs/cli/plugins.md @@ -1,8 +1,10 @@ # `mise plugins` -- **Usage**: `mise plugins [FLAGS] ` -- **Aliases**: `p` -- **Source code**: [`src/cli/plugins.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins.rs) +**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 diff --git a/docs/cli/plugins/install.md b/docs/cli/plugins/install.md index bda84f457e..21cff2927d 100644 --- a/docs/cli/plugins/install.md +++ b/docs/cli/plugins/install.md @@ -1,8 +1,10 @@ # `mise plugins install` -- **Usage**: `mise plugins install [FLAGS] [NEW_PLUGIN] [GIT_URL]` -- **Aliases**: `i`, `a`, `add` -- **Source code**: [`src/cli/plugins/install.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/install.rs) +**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 44dec3aed1..0be7dd0cc3 100644 --- a/docs/cli/plugins/link.md +++ b/docs/cli/plugins/link.md @@ -1,8 +1,10 @@ # `mise plugins link` -- **Usage**: `mise plugins link [-f --force] [PATH]` -- **Aliases**: `ln` -- **Source code**: [`src/cli/plugins/link.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/link.rs) +**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 f27ac2a572..e8a8704d8a 100644 --- a/docs/cli/plugins/ls-remote.md +++ b/docs/cli/plugins/ls-remote.md @@ -1,8 +1,10 @@ # `mise plugins ls-remote` -- **Usage**: `mise plugins ls-remote [-u --urls] [--only-names]` -- **Aliases**: `list-remote`, `list-all` -- **Source code**: [`src/cli/plugins/ls-remote.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/ls-remote.rs) +**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 c67a12071a..067710cfb2 100644 --- a/docs/cli/plugins/ls.md +++ b/docs/cli/plugins/ls.md @@ -1,8 +1,10 @@ # `mise plugins ls` -- **Usage**: `mise plugins ls [FLAGS]` -- **Aliases**: `list` -- **Source code**: [`src/cli/plugins/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/ls.rs) +**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 8224680d86..22da97c699 100644 --- a/docs/cli/plugins/uninstall.md +++ b/docs/cli/plugins/uninstall.md @@ -1,8 +1,10 @@ # `mise plugins uninstall` -- **Usage**: `mise plugins uninstall [-p --purge] [-a --all] [PLUGIN]...` -- **Aliases**: `remove`, `rm` -- **Source code**: [`src/cli/plugins/uninstall.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/uninstall.rs) +**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 a380530de3..0503f4c2f4 100644 --- a/docs/cli/plugins/update.md +++ b/docs/cli/plugins/update.md @@ -1,8 +1,10 @@ # `mise plugins update` -- **Usage**: `mise plugins update [-j --jobs ] [PLUGIN]...` -- **Aliases**: `up`, `upgrade` -- **Source code**: [`src/cli/plugins/update.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/update.rs) +**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 860dace10a..195d27ab4b 100644 --- a/docs/cli/prune.md +++ b/docs/cli/prune.md @@ -1,7 +1,8 @@ # `mise prune` -- **Usage**: `mise prune [FLAGS] [PLUGIN]...` -- **Source code**: [`src/cli/prune.rs`](https://github.com/jdx/mise/blob/main/src/cli/prune.rs) +**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 diff --git a/docs/cli/registry.md b/docs/cli/registry.md index b18767761c..9c213b9f33 100644 --- a/docs/cli/registry.md +++ b/docs/cli/registry.md @@ -1,7 +1,8 @@ # `mise registry` -- **Usage**: `mise registry [NAME]` -- **Source code**: [`src/cli/registry.rs`](https://github.com/jdx/mise/blob/main/src/cli/registry.rs) +**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 diff --git a/docs/cli/reshim.md b/docs/cli/reshim.md index a649ffce2a..5ba2d115cf 100644 --- a/docs/cli/reshim.md +++ b/docs/cli/reshim.md @@ -1,7 +1,8 @@ # `mise reshim` -- **Usage**: `mise reshim [-f --force]` -- **Source code**: [`src/cli/reshim.rs`](https://github.com/jdx/mise/blob/main/src/cli/reshim.rs) +**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. diff --git a/docs/cli/run.md b/docs/cli/run.md index ce087e0fc8..85c6cfe013 100644 --- a/docs/cli/run.md +++ b/docs/cli/run.md @@ -1,8 +1,10 @@ # `mise run` -- **Usage**: `mise run [FLAGS]` -- **Aliases**: `r` -- **Source code**: [`src/cli/run.rs`](https://github.com/jdx/mise/blob/main/src/cli/run.rs) +**Usage**: `mise run [FLAGS]` + +**Source code**: [`src/cli/run.rs`](https://github.com/jdx/mise/blob/main/src/cli/run.rs) + +**Aliases**: `r` Run task(s) diff --git a/docs/cli/self-update.md b/docs/cli/self-update.md index 6acdb21cc0..b73d99e7b4 100644 --- a/docs/cli/self-update.md +++ b/docs/cli/self-update.md @@ -1,7 +1,8 @@ # `mise self-update` -- **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) +**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. diff --git a/docs/cli/set.md b/docs/cli/set.md index 621d76ed20..ac1f12f511 100644 --- a/docs/cli/set.md +++ b/docs/cli/set.md @@ -1,7 +1,8 @@ # `mise set` -- **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) +**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 diff --git a/docs/cli/settings.md b/docs/cli/settings.md index 505368fc1f..978b516ac6 100644 --- a/docs/cli/settings.md +++ b/docs/cli/settings.md @@ -1,7 +1,8 @@ # `mise settings` -- **Usage**: `mise settings [--keys] ` -- **Source code**: [`src/cli/settings.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings.rs) +**Usage**: `mise settings [--keys] ` + +**Source code**: [`src/cli/settings.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings.rs) Manage settings diff --git a/docs/cli/settings/add.md b/docs/cli/settings/add.md index f336c8fbde..bc0950a377 100644 --- a/docs/cli/settings/add.md +++ b/docs/cli/settings/add.md @@ -1,7 +1,8 @@ # `mise settings add` -- **Usage**: `mise settings add ` -- **Source code**: [`src/cli/settings/add.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/add.rs) +**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 diff --git a/docs/cli/settings/get.md b/docs/cli/settings/get.md index 249e8cff2e..a8bbc1e2d1 100644 --- a/docs/cli/settings/get.md +++ b/docs/cli/settings/get.md @@ -1,7 +1,8 @@ # `mise settings get` -- **Usage**: `mise settings get ` -- **Source code**: [`src/cli/settings/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/get.rs) +**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 diff --git a/docs/cli/settings/ls.md b/docs/cli/settings/ls.md index 2cc8981771..a25302ca97 100644 --- a/docs/cli/settings/ls.md +++ b/docs/cli/settings/ls.md @@ -1,8 +1,10 @@ # `mise settings ls` -- **Usage**: `mise settings ls [--keys]` -- **Aliases**: `list` -- **Source code**: [`src/cli/settings/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/ls.rs) +**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 ab541bf99a..e39c7607bf 100644 --- a/docs/cli/settings/set.md +++ b/docs/cli/settings/set.md @@ -1,8 +1,10 @@ # `mise settings set` -- **Usage**: `mise settings set ` -- **Aliases**: `create` -- **Source code**: [`src/cli/settings/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/set.rs) +**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 ccf458bd26..1e5f70bf98 100644 --- a/docs/cli/settings/unset.md +++ b/docs/cli/settings/unset.md @@ -1,8 +1,10 @@ # `mise settings unset` -- **Usage**: `mise settings unset ` -- **Aliases**: `rm`, `remove`, `delete`, `del` -- **Source code**: [`src/cli/settings/unset.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/unset.rs) +**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 f543acc4b1..2fa0a743be 100644 --- a/docs/cli/shell.md +++ b/docs/cli/shell.md @@ -1,8 +1,10 @@ # `mise shell` -- **Usage**: `mise shell [FLAGS] [TOOL@VERSION]...` -- **Aliases**: `sh` -- **Source code**: [`src/cli/shell.rs`](https://github.com/jdx/mise/blob/main/src/cli/shell.rs) +**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 4f1740f265..928c76425d 100644 --- a/docs/cli/sync.md +++ b/docs/cli/sync.md @@ -1,7 +1,8 @@ # `mise sync` -- **Usage**: `mise sync ` -- **Source code**: [`src/cli/sync.rs`](https://github.com/jdx/mise/blob/main/src/cli/sync.rs) +**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 diff --git a/docs/cli/sync/node.md b/docs/cli/sync/node.md index f8b98ea702..3c77bbf6b4 100644 --- a/docs/cli/sync/node.md +++ b/docs/cli/sync/node.md @@ -1,7 +1,8 @@ # `mise sync node` -- **Usage**: `mise sync node [FLAGS]` -- **Source code**: [`src/cli/sync/node.rs`](https://github.com/jdx/mise/blob/main/src/cli/sync/node.rs) +**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 diff --git a/docs/cli/sync/python.md b/docs/cli/sync/python.md index 824ef8c685..7992b26d5e 100644 --- a/docs/cli/sync/python.md +++ b/docs/cli/sync/python.md @@ -1,7 +1,8 @@ # `mise sync python` -- **Usage**: `mise sync python <--pyenv>` -- **Source code**: [`src/cli/sync/python.rs`](https://github.com/jdx/mise/blob/main/src/cli/sync/python.rs) +**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 diff --git a/docs/cli/tasks.md b/docs/cli/tasks.md index 334940f87c..97f52de34d 100644 --- a/docs/cli/tasks.md +++ b/docs/cli/tasks.md @@ -1,8 +1,10 @@ # `mise tasks` -- **Usage**: `mise tasks [FLAGS] ` -- **Aliases**: `t` -- **Source code**: [`src/cli/tasks.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks.rs) +**Usage**: `mise tasks [FLAGS] ` + +**Source code**: [`src/cli/tasks.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks.rs) + +**Aliases**: `t` Manage tasks diff --git a/docs/cli/tasks/deps.md b/docs/cli/tasks/deps.md index 17ea51f0b5..0231ca340e 100644 --- a/docs/cli/tasks/deps.md +++ b/docs/cli/tasks/deps.md @@ -1,7 +1,8 @@ # `mise tasks deps` -- **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) +**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) Display a tree visualization of a dependency graph diff --git a/docs/cli/tasks/edit.md b/docs/cli/tasks/edit.md index 4fd81b4659..6a6e940697 100644 --- a/docs/cli/tasks/edit.md +++ b/docs/cli/tasks/edit.md @@ -1,7 +1,8 @@ # `mise tasks edit` -- **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) +**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) Edit a tasks with $EDITOR diff --git a/docs/cli/tasks/info.md b/docs/cli/tasks/info.md index 1c444ded24..c13c185637 100644 --- a/docs/cli/tasks/info.md +++ b/docs/cli/tasks/info.md @@ -1,7 +1,8 @@ # `mise tasks info` -- **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) +**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) Get information about a task diff --git a/docs/cli/tasks/ls.md b/docs/cli/tasks/ls.md index 8aadeba321..7451a6566f 100644 --- a/docs/cli/tasks/ls.md +++ b/docs/cli/tasks/ls.md @@ -1,7 +1,8 @@ # `mise tasks ls` -- **Usage**: `mise tasks ls [FLAGS]` -- **Source code**: [`src/cli/tasks/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/ls.rs) +**Usage**: `mise tasks ls [FLAGS]` + +**Source code**: [`src/cli/tasks/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/ls.rs) List available tasks to execute These may be included from the config file or from the project's .mise/tasks directory diff --git a/docs/cli/tasks/run.md b/docs/cli/tasks/run.md index eb483bcaab..514407914f 100644 --- a/docs/cli/tasks/run.md +++ b/docs/cli/tasks/run.md @@ -1,8 +1,10 @@ # `mise tasks run` -- **Usage**: `mise tasks run [FLAGS] [TASK] [ARGS]...` -- **Aliases**: `r` -- **Source code**: [`src/cli/tasks/run.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/run.rs) +**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` Run task(s) diff --git a/docs/cli/trust.md b/docs/cli/trust.md index 84e3697670..62e46eeb48 100644 --- a/docs/cli/trust.md +++ b/docs/cli/trust.md @@ -1,7 +1,8 @@ # `mise trust` -- **Usage**: `mise trust [FLAGS] [CONFIG_FILE]` -- **Source code**: [`src/cli/trust.rs`](https://github.com/jdx/mise/blob/main/src/cli/trust.rs) +**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 diff --git a/docs/cli/uninstall.md b/docs/cli/uninstall.md index 3d8ccbc920..c2b3ede751 100644 --- a/docs/cli/uninstall.md +++ b/docs/cli/uninstall.md @@ -1,8 +1,10 @@ # `mise uninstall` -- **Usage**: `mise uninstall [-a --all] [-n --dry-run] [INSTALLED_TOOL@VERSION]...` -- **Aliases**: `remove`, `rm` -- **Source code**: [`src/cli/uninstall.rs`](https://github.com/jdx/mise/blob/main/src/cli/uninstall.rs) +**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 5941d01832..78de26b4ba 100644 --- a/docs/cli/unset.md +++ b/docs/cli/unset.md @@ -1,7 +1,8 @@ # `mise unset` -- **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) +**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. diff --git a/docs/cli/upgrade.md b/docs/cli/upgrade.md index 33707f1f68..bbb7d47a8d 100644 --- a/docs/cli/upgrade.md +++ b/docs/cli/upgrade.md @@ -1,8 +1,10 @@ # `mise upgrade` -- **Usage**: `mise upgrade [FLAGS] [TOOL@VERSION]...` -- **Aliases**: `up` -- **Source code**: [`src/cli/upgrade.rs`](https://github.com/jdx/mise/blob/main/src/cli/upgrade.rs) +**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 3561ba47b8..5536fd0f86 100644 --- a/docs/cli/use.md +++ b/docs/cli/use.md @@ -1,8 +1,10 @@ # `mise use` -- **Usage**: `mise use [FLAGS] [TOOL@VERSION]...` -- **Aliases**: `u` -- **Source code**: [`src/cli/use.rs`](https://github.com/jdx/mise/blob/main/src/cli/use.rs) +**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 06f60de14c..dc58bc6138 100644 --- a/docs/cli/version.md +++ b/docs/cli/version.md @@ -1,8 +1,10 @@ # `mise version` -- **Usage**: `mise version` -- **Aliases**: `v` -- **Source code**: [`src/cli/version.rs`](https://github.com/jdx/mise/blob/main/src/cli/version.rs) +**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 ee1875ff05..70a280f0a6 100644 --- a/docs/cli/watch.md +++ b/docs/cli/watch.md @@ -1,8 +1,10 @@ # `mise watch` -- **Usage**: `mise watch [-t --task... ] [-g --glob... ] [ARGS]...` -- **Aliases**: `w` -- **Source code**: [`src/cli/watch.rs`](https://github.com/jdx/mise/blob/main/src/cli/watch.rs) +**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` Run task(s) and watch for changes to rerun it diff --git a/docs/cli/where.md b/docs/cli/where.md index 6a599b18b3..afb6b48867 100644 --- a/docs/cli/where.md +++ b/docs/cli/where.md @@ -1,7 +1,8 @@ # `mise where` -- **Usage**: `mise where ` -- **Source code**: [`src/cli/where.rs`](https://github.com/jdx/mise/blob/main/src/cli/where.rs) +**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 diff --git a/docs/cli/which.md b/docs/cli/which.md index 7b8b6a8609..10f3f7f15c 100644 --- a/docs/cli/which.md +++ b/docs/cli/which.md @@ -1,7 +1,8 @@ # `mise which` -- **Usage**: `mise which [FLAGS] ` -- **Source code**: [`src/cli/which.rs`](https://github.com/jdx/mise/blob/main/src/cli/which.rs) +**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.