Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 34 additions & 17 deletions docs/.vitepress/cli_commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,6 @@ export const commands: { [key: string]: Command } = {
activate: {
hide: false,
},
alias: {
hide: false,
subcommands: {
get: {
hide: false,
},
ls: {
hide: false,
},
set: {
hide: false,
},
unset: {
hide: false,
},
},
},
asdf: {
hide: true,
},
Expand Down Expand Up @@ -260,6 +243,23 @@ export const commands: { [key: string]: Command } = {
shell: {
hide: false,
},
"shell-alias": {
hide: false,
subcommands: {
get: {
hide: false,
},
ls: {
hide: false,
},
set: {
hide: false,
},
unset: {
hide: false,
},
},
},
sync: {
hide: false,
subcommands: {
Expand Down Expand Up @@ -306,6 +306,23 @@ export const commands: { [key: string]: Command } = {
tool: {
hide: false,
},
"tool-alias": {
hide: false,
subcommands: {
get: {
hide: false,
},
ls: {
hide: false,
},
set: {
hide: false,
},
unset: {
hide: false,
},
},
},
"tool-stub": {
hide: false,
},
Expand Down
25 changes: 0 additions & 25 deletions docs/cli/alias.md

This file was deleted.

26 changes: 0 additions & 26 deletions docs/cli/alias/get.md

This file was deleted.

15 changes: 10 additions & 5 deletions docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ Can also use `MISE_NO_CONFIG=1`
## Subcommands

- [`mise activate [FLAGS] [SHELL_TYPE]`](/cli/activate.md)
- [`mise alias [-p --plugin <PLUGIN>] [--no-header] <SUBCOMMAND>`](/cli/alias.md)
- [`mise alias get <PLUGIN> <ALIAS>`](/cli/alias/get.md)
- [`mise alias ls [--no-header] [TOOL]`](/cli/alias/ls.md)
- [`mise alias set <ARGS>…`](/cli/alias/set.md)
- [`mise alias unset <PLUGIN> [ALIAS]`](/cli/alias/unset.md)
- [`mise tool-alias [-p --plugin <PLUGIN>] [--no-header] <SUBCOMMAND>`](/cli/tool-alias.md)
- [`mise tool-alias get <PLUGIN> <ALIAS>`](/cli/tool-alias/get.md)
- [`mise tool-alias ls [--no-header] [TOOL]`](/cli/tool-alias/ls.md)
- [`mise tool-alias set <ARGS>…`](/cli/tool-alias/set.md)
- [`mise tool-alias unset <PLUGIN> [ALIAS]`](/cli/tool-alias/unset.md)
- [`mise backends <SUBCOMMAND>`](/cli/backends.md)
- [`mise backends ls`](/cli/backends/ls.md)
- [`mise bin-paths [TOOL@VERSION]…`](/cli/bin-paths.md)
Expand Down Expand Up @@ -134,6 +134,11 @@ Can also use `MISE_NO_CONFIG=1`
- [`mise settings set [-l --local] <SETTING> <VALUE>`](/cli/settings/set.md)
- [`mise settings unset [-l --local] <KEY>`](/cli/settings/unset.md)
- [`mise shell [FLAGS] <TOOL@VERSION>…`](/cli/shell.md)
- [`mise shell-alias [--no-header] <SUBCOMMAND>`](/cli/shell-alias.md)
- [`mise shell-alias get <shell_alias>`](/cli/shell-alias/get.md)
- [`mise shell-alias ls [--no-header]`](/cli/shell-alias/ls.md)
- [`mise shell-alias set <shell_alias> <COMMAND>`](/cli/shell-alias/set.md)
- [`mise shell-alias unset <shell_alias>`](/cli/shell-alias/unset.md)
- [`mise sync <SUBCOMMAND>`](/cli/sync.md)
- [`mise sync node [FLAGS]`](/cli/sync/node.md)
- [`mise sync python [--pyenv] [--uv]`](/cli/sync/python.md)
Expand Down
20 changes: 20 additions & 0 deletions docs/cli/shell-alias.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- @generated by usage-cli from usage spec -->
# `mise shell-alias`

- **Usage**: `mise shell-alias [--no-header] <SUBCOMMAND>`
- **Source code**: [`src/cli/shell_alias/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/shell_alias/mod.rs)

Manage shell aliases.

## Flags

### `--no-header`

Don't show table header

## Subcommands

- [`mise shell-alias get <shell_alias>`](/cli/shell-alias/get.md)
- [`mise shell-alias ls [--no-header]`](/cli/shell-alias/ls.md)
- [`mise shell-alias set <shell_alias> <COMMAND>`](/cli/shell-alias/set.md)
- [`mise shell-alias unset <shell_alias>`](/cli/shell-alias/unset.md)
20 changes: 20 additions & 0 deletions docs/cli/shell-alias/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- @generated by usage-cli from usage spec -->
# `mise shell-alias get`

- **Usage**: `mise shell-alias get <shell_alias>`
- **Source code**: [`src/cli/shell_alias/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/shell_alias/get.rs)

Show the command for a shell alias

## Arguments

### `<shell_alias>`

The alias to show

Examples:

```
$ mise shell-alias get ll
ls -la
```
26 changes: 26 additions & 0 deletions docs/cli/shell-alias/ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!-- @generated by usage-cli from usage spec -->
# `mise shell-alias ls`

- **Usage**: `mise shell-alias ls [--no-header]`
- **Aliases**: `list`
- **Source code**: [`src/cli/shell_alias/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/shell_alias/ls.rs)

List shell aliases

Shows the shell aliases that are set in the current directory.
These are defined in `mise.toml` under the `[shell_alias]` section.

## Flags

### `--no-header`

Don't show table header

Examples:

```
$ mise shell-alias ls
alias command
ll ls -la
gs git status
```
27 changes: 27 additions & 0 deletions docs/cli/shell-alias/set.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- @generated by usage-cli from usage spec -->
# `mise shell-alias set`

- **Usage**: `mise shell-alias set <shell_alias> <COMMAND>`
- **Aliases**: `add`, `create`
- **Source code**: [`src/cli/shell_alias/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/shell_alias/set.rs)

Add/update a shell alias

This modifies the contents of ~/.config/mise/config.toml

## Arguments

### `<shell_alias>`

The alias name

### `<COMMAND>`

The command to run

Examples:

```
mise shell-alias set ll "ls -la"
mise shell-alias set gs "git status"
```
22 changes: 22 additions & 0 deletions docs/cli/shell-alias/unset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- @generated by usage-cli from usage spec -->
# `mise shell-alias unset`

- **Usage**: `mise shell-alias unset <shell_alias>`
- **Aliases**: `rm`, `remove`, `delete`, `del`
- **Source code**: [`src/cli/shell_alias/unset.rs`](https://github.com/jdx/mise/blob/main/src/cli/shell_alias/unset.rs)

Removes a shell alias

This modifies the contents of ~/.config/mise/config.toml

## Arguments

### `<shell_alias>`

The alias to remove

Examples:

```
mise shell-alias unset ll
```
24 changes: 24 additions & 0 deletions docs/cli/tool-alias.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- @generated by usage-cli from usage spec -->
# `mise tool-alias`

- **Usage**: `mise tool-alias [-p --plugin <PLUGIN>] [--no-header] <SUBCOMMAND>`
- **Source code**: [`src/cli/tool_alias/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/tool_alias/mod.rs)

Manage tool version aliases.

## Flags

### `-p --plugin <PLUGIN>`

filter aliases by plugin

### `--no-header`

Don't show table header

## Subcommands

- [`mise tool-alias get <PLUGIN> <ALIAS>`](/cli/tool-alias/get.md)
- [`mise tool-alias ls [--no-header] [TOOL]`](/cli/tool-alias/ls.md)
- [`mise tool-alias set <ARGS>…`](/cli/tool-alias/set.md)
- [`mise tool-alias unset <PLUGIN> [ALIAS]`](/cli/tool-alias/unset.md)
26 changes: 26 additions & 0 deletions docs/cli/tool-alias/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!-- @generated by usage-cli from usage spec -->
# `mise tool-alias get`

- **Usage**: `mise tool-alias get <PLUGIN> <ALIAS>`
- **Source code**: [`src/cli/tool_alias/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/tool_alias/get.rs)

Show an alias for a plugin

This is the contents of a tool_alias.&lt;PLUGIN> entry in ~/.config/mise/config.toml

## Arguments

### `<PLUGIN>`

The plugin to show the alias for

### `<ALIAS>`

The alias to show

Examples:

```
$ mise tool-alias get node lts-hydrogen
20.0.0
```
12 changes: 6 additions & 6 deletions docs/cli/alias/ls.md → docs/cli/tool-alias/ls.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!-- @generated by usage-cli from usage spec -->
# `mise alias ls`
# `mise tool-alias ls`

- **Usage**: `mise alias ls [--no-header] [TOOL]`
- **Usage**: `mise tool-alias ls [--no-header] [TOOL]`
- **Aliases**: `list`
- **Source code**: [`src/cli/alias/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/ls.rs)
- **Source code**: [`src/cli/tool_alias/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/tool_alias/ls.rs)

List aliases
List tool version aliases
Shows the aliases that can be specified.
These can come from user config or from plugins in `bin/list-aliases`.

For user config, aliases are defined like the following in `~/.config/mise/config.toml`:

```
[alias.node.versions]
[tool_alias.node.versions]
lts = "22.0.0"
```

Expand All @@ -31,6 +31,6 @@ Don't show table header
Examples:

```
$ mise aliases
$ mise tool-alias ls
node lts-jod 22
```
10 changes: 5 additions & 5 deletions docs/cli/alias/set.md → docs/cli/tool-alias/set.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!-- @generated by usage-cli from usage spec -->
# `mise alias set`
# `mise tool-alias set`

- **Usage**: `mise alias set <ARGS>…`
- **Usage**: `mise tool-alias set <ARGS>…`
- **Aliases**: `add`, `create`
- **Source code**: [`src/cli/alias/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/set.rs)
- **Source code**: [`src/cli/tool_alias/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/tool_alias/set.rs)

Add/update an alias for a backend/plugin

Expand All @@ -26,6 +26,6 @@ The value to set the alias to
Examples:

```
mise alias set maven asdf:mise-plugins/mise-maven
mise alias set node lts-jod 22.0.0
mise tool-alias set maven asdf:mise-plugins/mise-maven
mise tool-alias set node lts-jod 22.0.0
```
Loading
Loading