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
2 changes: 1 addition & 1 deletion docs/cli/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

Manage aliases

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/backends.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **Usage**: `mise backends <SUBCOMMAND>`
- **Aliases**: `b`
- **Source code**: [`src/cli/backends.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends.rs)
- **Source code**: [`src/cli/backends/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends/mod.rs)

Manage backends

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/bin-paths.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `mise bin-paths`

- **Usage**: `mise bin-paths [TOOL@VERSION]...`
- **Source code**: [`src/cli/bin-paths.rs`](https://github.com/jdx/mise/blob/main/src/cli/bin-paths.rs)
- **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

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/cache.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `mise cache`

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

Manage the mise cache

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **Usage**: `mise config [--no-header] [-J --json] <SUBCOMMAND>`
- **Aliases**: `cfg`
- **Source code**: [`src/cli/config.rs`](https://github.com/jdx/mise/blob/main/src/cli/config.rs)
- **Source code**: [`src/cli/config/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/mod.rs)

Manage config files

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/doctor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **Usage**: `mise doctor [-J --json] <SUBCOMMAND>`
- **Aliases**: `dr`
- **Source code**: [`src/cli/doctor.rs`](https://github.com/jdx/mise/blob/main/src/cli/doctor.rs)
- **Source code**: [`src/cli/doctor/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/doctor/mod.rs)

Check mise installation for possible problems

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **Usage**: `mise generate <SUBCOMMAND>`
- **Aliases**: `gen`
- **Source code**: [`src/cli/generate.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate.rs)
- **Source code**: [`src/cli/generate/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/mod.rs)

[experimental] Generate files for various tools/services

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/generate/git-pre-commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **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)
- **Source code**: [`src/cli/generate/git_pre_commit.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/git_pre_commit.rs)

[experimental] Generate a git pre-commit hook

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/generate/github-action.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `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)
- **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

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/generate/task-docs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `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)
- **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

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/generate/task-stubs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `mise generate task-stubs`

- **Usage**: `mise generate task-stubs [-m --mise-bin <MISE_BIN>] [-d --dir <DIR>]`
- **Source code**: [`src/cli/generate/task-stubs.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/task-stubs.rs)
- **Source code**: [`src/cli/generate/task_stubs.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/task_stubs.rs)

[experimental] Generates shims to run mise tasks

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/install-into.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `mise install-into`

- **Usage**: `mise install-into <TOOL@VERSION> <PATH>`
- **Source code**: [`src/cli/install-into.rs`](https://github.com/jdx/mise/blob/main/src/cli/install-into.rs)
- **Source code**: [`src/cli/install_into.rs`](https://github.com/jdx/mise/blob/main/src/cli/install_into.rs)

Install a tool version to a specific path

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/ls-remote.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `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)
- **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.

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **Usage**: `mise plugins [FLAGS] <SUBCOMMAND>`
- **Aliases**: `p`
- **Source code**: [`src/cli/plugins.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins.rs)
- **Source code**: [`src/cli/plugins/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/mod.rs)

Manage plugins

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/plugins/ls-remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **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)
- **Source code**: [`src/cli/plugins/ls_remote.rs`](https://github.com/jdx/mise/blob/main/src/cli/plugins/ls_remote.rs)

List all available remote plugins

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/self-update.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `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)
- **Source code**: [`src/cli/self_update.rs`](https://github.com/jdx/mise/blob/main/src/cli/self_update.rs)

Updates mise itself.

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/settings.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `mise settings`

- **Usage**: `mise settings [FLAGS] [SETTING] [VALUE] <SUBCOMMAND>`
- **Source code**: [`src/cli/settings.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings.rs)
- **Source code**: [`src/cli/settings/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/settings/mod.rs)

Show current settings

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/sync.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `mise sync`

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

Synchronize tools from other version managers with mise

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **Usage**: `mise tasks [FLAGS] [TASK] <SUBCOMMAND>`
- **Aliases**: `t`
- **Source code**: [`src/cli/tasks.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks.rs)
- **Source code**: [`src/cli/tasks/mod.rs`](https://github.com/jdx/mise/blob/main/src/cli/tasks/mod.rs)

Manage tasks

Expand Down
9 changes: 8 additions & 1 deletion mise.usage.kdl
Original file line number Diff line number Diff line change
Expand Up @@ -2064,7 +2064,14 @@ 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"
source_code_link_template r#"
{%- set path = path | replace(from='-', to='_') -%}
{%- if cmd.subcommands | length > 0 -%}
{%- set path = path | split(pat="/") | slice(end=1) | concat(with="mod.rs") | join(sep="/") -%}
{%- else -%}
{%- set path = path ~ ".rs" -%}
{%- endif -%}
https://github.com/jdx/mise/blob/main/src/cli/{{path}}"#

complete "alias" run="mise alias ls {{words[PREV]}} | awk '{print $2}'"
complete "config_file" type="file"
Expand Down
9 changes: 8 additions & 1 deletion src/assets/mise-extra.usage.kdl
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
source_code_link_template "https://github.com/jdx/mise/blob/main/src/cli/{{path}}.rs"
source_code_link_template r#"
{%- set path = path | replace(from='-', to='_') -%}
{%- if cmd.subcommands | length > 0 -%}
{%- set path = path | split(pat="/") | slice(end=1) | concat(with="mod.rs") | join(sep="/") -%}
{%- else -%}
{%- set path = path ~ ".rs" -%}
{%- endif -%}
https://github.com/jdx/mise/blob/main/src/cli/{{path}}"#

complete "alias" run="mise alias ls {{words[PREV]}} | awk '{print $2}'"
complete "config_file" type="file"
Expand Down
Loading