docs(plugins): replace node/asdf-nodejs examples with vfox plugins#8191
docs(plugins): replace node/asdf-nodejs examples with vfox plugins#8191
Conversation
Nobody uses asdf-nodejs anymore, so update the doc comments and CLI examples across all plugin subcommands to reference vfox plugins (cmake, poetry) from the registry instead. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary of ChangesHello @jdx, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request modernizes the documentation and CLI examples for various Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Pull request overview
Updates CLI help text for the plugins subcommands to use vfox-registry plugin examples (e.g., cmake, poetry) instead of the older node / asdf-nodejs references, keeping the documentation aligned with current plugin recommendations.
Changes:
- Updated
pluginssubcommand example snippets to referencecmake/poetryand vfox plugin URLs. - Updated
--urlsexample URLs to usemise-plugins/vfox-*repositories. - Updated autoinstall example in
plugins installdocs to referencecmake.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/cli/plugins/update.rs | Updates plugins update help examples to use cmake. |
| src/cli/plugins/uninstall.rs | Updates plugins uninstall help example to use cmake (command wording still needs adjustment). |
| src/cli/plugins/mod.rs | Updates --urls doc example URL to a vfox plugin repo. |
| src/cli/plugins/ls.rs | Updates plugins ls example output and --urls example URLs to vfox plugin repos. |
| src/cli/plugins/link.rs | Updates plugins link docs/examples to use vfox-cmake paths (inference example currently mismatches code). |
| src/cli/plugins/install.rs | Updates plugins install docs/examples to use cmake/poetry and vfox plugin URL. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/cli/plugins/uninstall.rs
Outdated
| r#"<bold><underline>Examples:</underline></bold> | ||
|
|
||
| $ <bold>mise uninstall node</bold> | ||
| $ <bold>mise uninstall cmake</bold> |
There was a problem hiding this comment.
The example shown in the plugin-uninstall help uses mise uninstall ..., which invokes the top-level tool-version uninstall command (see src/cli/mod.rs where Uninstall and Plugins are separate commands). Since this help is for removing plugins, the example should use mise plugins uninstall ... (or the appropriate alias) to avoid misleading users.
| $ <bold>mise uninstall cmake</bold> | |
| $ <bold>mise plugins uninstall cmake</bold> |
| # essentially just `ln -s ./vfox-cmake ~/.local/share/mise/plugins/cmake` | ||
| $ <bold>mise plugins link cmake ./vfox-cmake</bold> | ||
|
|
||
| # infer plugin name as "node" | ||
| $ <bold>mise plugins link ./mise-node</bold> | ||
| # infer plugin name as "cmake" | ||
| $ <bold>mise plugins link ./vfox-cmake</bold> |
There was a problem hiding this comment.
The plugins link help says it will "infer plugin name as "cmake"" from the directory ./vfox-cmake, but get_name_from_path() only strips asdf-, rtx-, and mise- prefixes. With the current code this would infer vfox-cmake, not cmake. Either update the example to match the current inference behavior, or extend get_name_from_path() to also strip the vfox- prefix so the example works as written.
There was a problem hiding this comment.
Code Review
This pull request updates documentation and examples across several plugin-related commands, replacing outdated references to node and asdf-nodejs with more current examples like cmake and poetry. The changes are consistent and improve the documentation. I've found one minor issue in an example that could be misleading to users.
src/cli/plugins/install.rs
Outdated
| /// e.g.: node, ruby | ||
| /// Can specify multiple plugins: `mise plugins install node ruby python` | ||
| /// e.g.: cmake, poetry | ||
| /// Can specify multiple plugins: `mise plugins install cmake poetry elixir` |
There was a problem hiding this comment.
The example for installing multiple plugins includes elixir, which is a core plugin. The plugins install command is for non-core plugins and will error if you try to install a core plugin. It would be better to use another non-core plugin in the example or remove elixir to avoid confusion.
| /// Can specify multiple plugins: `mise plugins install cmake poetry elixir` | |
| /// Can specify multiple plugins: `mise plugins install cmake poetry` |
- Fix `plugins uninstall` example to use full `mise plugins uninstall` command - Remove `elixir` from multi-install example since it's a core plugin - Strip `vfox-` prefix in get_name_from_path() and get_name_from_url() so `./vfox-cmake` correctly infers plugin name as "cmake" Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
bugbot run |
Hyperfine Performance
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.13 x -- echo |
24.0 ± 0.5 | 23.1 | 28.2 | 1.00 |
mise x -- echo |
24.0 ± 0.5 | 23.3 | 28.6 | 1.00 ± 0.03 |
mise env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.13 env |
24.1 ± 1.6 | 22.8 | 44.0 | 1.01 ± 0.07 |
mise env |
23.9 ± 0.7 | 22.9 | 27.2 | 1.00 |
mise hook-env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.13 hook-env |
24.7 ± 0.7 | 23.7 | 32.8 | 1.00 |
mise hook-env |
24.9 ± 0.7 | 23.8 | 28.0 | 1.01 ± 0.04 |
mise ls
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.13 ls |
22.9 ± 0.5 | 21.9 | 25.9 | 1.00 |
mise ls |
23.0 ± 0.5 | 22.1 | 27.1 | 1.00 ± 0.03 |
xtasks/test/perf
| Command | mise-2026.2.13 | mise | Variance |
|---|---|---|---|
| install (cached) | 130ms | 132ms | -1% |
| ls (cached) | 82ms | 82ms | +0% |
| bin-paths (cached) | 87ms | 85ms | +2% |
| task-ls (cached) | 839ms | 831ms | +0% |
### 🚀 Features - **(task)** stream keep-order output in real-time per task by @jdx in [#8164](#8164) ### 🐛 Bug Fixes - **(aqua)** resolve lockfile artifacts for target platform (fix discussion #7479) by @mackwic in [#8183](#8183) - **(exec)** strip shims from PATH to prevent recursive shim execution by @jdx in [#8189](#8189) - **(hook-env)** preserve PATH reordering done after activation by @jdx in [#8190](#8190) - **(lockfile)** resolve version aliases before lockfile lookup by @jdx in [#8194](#8194) - **(registry)** set helm-diff archive bin name to diff by @jean-humann in [#8173](#8173) - **(task)** improve source freshness checks with dynamic task dirs by @rooperuu in [#8169](#8169) - **(task)** resolve global tasks when running from monorepo root by @jdx in [#8192](#8192) - **(task)** prevent wildcard glob `test:*` from matching parent task `test` by @jdx in [#8165](#8165) - **(task)** resolve task_config.includes relative to config root by @jdx in [#8193](#8193) - **(upgrade)** skip untrusted tracked configs during upgrade by @jdx in [#8195](#8195) ### 🚜 Refactor - use enum for npm.pacakge_manager by @risu729 in [#8180](#8180) ### 📚 Documentation - **(plugins)** replace node/asdf-nodejs examples with vfox plugins by @jdx in [#8191](#8191) ### ⚡ Performance - call npm view only once by @risu729 in [#8181](#8181) ### New Contributors - @jean-humann made their first contribution in [#8173](#8173) - @mackwic made their first contribution in [#8183](#8183) - @rooperuu made their first contribution in [#8169](#8169) ## 📦 Aqua Registry Updates #### New Packages (2) - [`BetterDiscord/cli`](https://github.com/BetterDiscord/cli) - [`glossia.ai/cli`](https://github.com/glossia.ai/cli)
…dx#8191) ## Summary - Replace outdated `node` / `asdf-nodejs` references in plugin subcommand doc comments and CLI examples with `cmake` / `poetry` (vfox plugins from the registry) - Affects `plugins install`, `plugins update`, `plugins uninstall`, `plugins link`, `plugins ls`, and the top-level `plugins` command - Unit tests for URL parsing left unchanged as they test name extraction logic ## Test plan - [x] `cargo check` passes - [x] All lints pass - [ ] Verify `mise plugins install --help` shows updated examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Mostly documentation/example updates; the only functional change is adding a `vfox-` prefix strip to plugin name inference, which is narrow and unlikely to affect existing users beyond improving URL/path inference. > > **Overview** > Refreshes `mise plugins` documentation, manpage text, and shell-completion metadata to replace `node`/`asdf-*` examples with `cmake`/`poetry` and `mise-plugins/vfox-*` URLs across `install`, `ls`, `link`, `update`, and `uninstall`. > > Extends plugin name inference to strip a `vfox-` prefix from plugin repo URLs and local plugin directory names (mirroring existing `asdf-`/`rtx-`/`mise-` handling). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit d6b4aff. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
### 🚀 Features - **(task)** stream keep-order output in real-time per task by @jdx in [jdx#8164](jdx#8164) ### 🐛 Bug Fixes - **(aqua)** resolve lockfile artifacts for target platform (fix discussion jdx#7479) by @mackwic in [jdx#8183](jdx#8183) - **(exec)** strip shims from PATH to prevent recursive shim execution by @jdx in [jdx#8189](jdx#8189) - **(hook-env)** preserve PATH reordering done after activation by @jdx in [jdx#8190](jdx#8190) - **(lockfile)** resolve version aliases before lockfile lookup by @jdx in [jdx#8194](jdx#8194) - **(registry)** set helm-diff archive bin name to diff by @jean-humann in [jdx#8173](jdx#8173) - **(task)** improve source freshness checks with dynamic task dirs by @rooperuu in [jdx#8169](jdx#8169) - **(task)** resolve global tasks when running from monorepo root by @jdx in [jdx#8192](jdx#8192) - **(task)** prevent wildcard glob `test:*` from matching parent task `test` by @jdx in [jdx#8165](jdx#8165) - **(task)** resolve task_config.includes relative to config root by @jdx in [jdx#8193](jdx#8193) - **(upgrade)** skip untrusted tracked configs during upgrade by @jdx in [jdx#8195](jdx#8195) ### 🚜 Refactor - use enum for npm.pacakge_manager by @risu729 in [jdx#8180](jdx#8180) ### 📚 Documentation - **(plugins)** replace node/asdf-nodejs examples with vfox plugins by @jdx in [jdx#8191](jdx#8191) ### ⚡ Performance - call npm view only once by @risu729 in [jdx#8181](jdx#8181) ### New Contributors - @jean-humann made their first contribution in [jdx#8173](jdx#8173) - @mackwic made their first contribution in [jdx#8183](jdx#8183) - @rooperuu made their first contribution in [jdx#8169](jdx#8169) ## 📦 Aqua Registry Updates #### New Packages (2) - [`BetterDiscord/cli`](https://github.com/BetterDiscord/cli) - [`glossia.ai/cli`](https://github.com/glossia.ai/cli)
Summary
node/asdf-nodejsreferences in plugin subcommand doc comments and CLI examples withcmake/poetry(vfox plugins from the registry)plugins install,plugins update,plugins uninstall,plugins link,plugins ls, and the top-levelpluginscommandTest plan
cargo checkpassesmise plugins install --helpshows updated examples🤖 Generated with Claude Code
Note
Low Risk
Mostly documentation/example updates; the only functional change is adding a
vfox-prefix strip to plugin name inference, which is narrow and unlikely to affect existing users beyond improving URL/path inference.Overview
Refreshes
mise pluginsdocumentation, manpage text, and shell-completion metadata to replacenode/asdf-*examples withcmake/poetryandmise-plugins/vfox-*URLs acrossinstall,ls,link,update, anduninstall.Extends plugin name inference to strip a
vfox-prefix from plugin repo URLs and local plugin directory names (mirroring existingasdf-/rtx-/mise-handling).Written by Cursor Bugbot for commit d6b4aff. This will update automatically on new commits. Configure here.