diff --git a/docs/.vitepress/cli-reference.ts b/docs/.vitepress/cli-reference.ts index 6f3d878dcb6..f2afaca2043 100644 --- a/docs/.vitepress/cli-reference.ts +++ b/docs/.vitepress/cli-reference.ts @@ -29,6 +29,7 @@ const guides: Record = { set: ["Environment variables", "/environments/"], unset: ["Environment variables", "/environments/"], exec: ["Running tools", "/dev-tools/"], + installs: ["Install layout", "/dev-tools/install-layout.html"], backends: ["Choosing backends", "/dev-tools/backends/"], config: ["Configuration", "/configuration.html"], edit: ["Configuration", "/configuration.html"], @@ -145,7 +146,7 @@ const guides: Record = { const categories = [ [ "Install and inspect tools", - "use install install-into uninstall unuse upgrade outdated lock latest ls ls-remote tool where which bin-paths registry search backends link sync prune reshim tool-stub packslip", + "use install install-into installs uninstall unuse upgrade outdated lock latest ls ls-remote tool where which bin-paths registry search backends link sync prune reshim tool-stub packslip", ], [ "Shell and environment", diff --git a/docs/.vitepress/cli_commands.ts b/docs/.vitepress/cli_commands.ts index d9e6e53f3ca..8fa7de05680 100644 --- a/docs/.vitepress/cli_commands.ts +++ b/docs/.vitepress/cli_commands.ts @@ -697,6 +697,17 @@ export const commands: { [key: string]: Command } = { "install-into": { hide: false, }, + installs: { + hide: false, + subcommands: { + ls: { + hide: false, + }, + select: { + hide: false, + }, + }, + }, latest: { hide: false, }, diff --git a/docs/cli/index.md b/docs/cli/index.md index 14581ec4a4a..07607617097 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -65,6 +65,7 @@ Choose a command family below. Its page lists the available subcommands. - [`mise use`](/cli/use.html) — Install a tool and add it to configuration - [`mise install`](/cli/install.html) — Install a tool version - [`mise install-into`](/cli/install-into.html) — Install a tool version to a specific path +- [`mise installs`](/cli/installs.html) — [experimental] Inspect and choose installations of the identity install layout - [`mise uninstall`](/cli/uninstall.html) — Remove installed tool versions - [`mise unuse`](/cli/unuse.html) — Remove tool requests from configuration and prune unused installations - [`mise upgrade`](/cli/upgrade.html) — Upgrade outdated tools diff --git a/docs/cli/installs.md b/docs/cli/installs.md new file mode 100644 index 00000000000..5a8e93f2747 --- /dev/null +++ b/docs/cli/installs.md @@ -0,0 +1,34 @@ +--- +description: "[experimental] Inspect and choose installations of the identity install layout" +--- + + +# `mise installs` + +- **Usage:** `mise installs [SUBCOMMAND]` +- **Effect:** read-only +- **Source code:** [`src/cli/installs/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/installs/mod.rs) + +[experimental] Inspect and choose installations of the identity install layout + +With `install_layout = "identity"`, each installation lives in its own +`