{{ message }}
Repository navigation
docs: add limactl mcp to the command reference - #5608
Open
Sarthak-Shreshtha01 wants to merge 5 commits into
Open
Sarthak-Shreshtha01 wants to merge 5 commits into
Sarthak-Shreshtha01 wants to merge 5 commits into
Conversation
`limactl-mcp generate-doc` now also writes the cli-reference pages (`--cli-dir`), and `make docsy` puts them next to the `limactl` pages. The plugin uses the display name `limactl mcp`, so the pages and the usage show `limactl mcp` instead of `limactl-mcp`. Fixes lima-vm#5606 Signed-off-by: Sarthak <sarthakshreshtha345@gmail.com>
AkihiroSuda
reviewed
Oct 13, 2026
AkihiroSuda
added
documentation
`limactl generate-doc --type docsy` now discovers the plugins installed next to limactl, and runs `generate-doc --cli-dir DIR` for each plugin that supports this flag. Plugin names are no longer hardcoded in the Makefile. The DIR argument of `limactl-mcp generate-doc` is now optional. Signed-off-by: Sarthak <sarthakshreshtha345@gmail.com>
AkihiroSuda
self-requested a review
October 15, 2026 06:18
AkihiroSuda
reviewed
Oct 15, 2026
AkihiroSuda
reviewed
Oct 15, 2026
…mactl menu Keep the DIR argument of `limactl-mcp generate-doc` and switch it to the cli-reference pages with `--content-mode=cli`. `limactl-menu` gets the same hidden command, so `limactl menu` is documented too. The docsy page generation is shared in pkg/gendoc. Signed-off-by: Sarthak <sarthakshreshtha345@gmail.com>
… pages A limactl-mcp in $PATH was picked by plugins.Discover before the copy in libexec/lima, and bundledPlugins then dropped it, so the mcp pages were silently missing. DiscoverBundled only scans the directories next to limactl and libexec/lima. Signed-off-by: Sarthak <sarthakshreshtha345@gmail.com>
Signed-off-by: Sarthak <sarthakshreshtha345@gmail.com>
Member
Contributor
Author
|
I will squash the commits into a single commit. |
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The reference pages at https://lima-vm.io/docs/reference/ are made only from
limactl, so the commands of thelimactl mcpandlimactl menuplugins were missing. Both plugins now have a hiddengenerate-doc --content-mode=cli DIRthat writes their pages, andlimactl generate-doc --type docsyruns it for each plugin installed with limactl that supports it, so no plugin names are hardcoded.limactl-mcp generate-doc DIRstill writesmcp.mdby default. The docsy page code is shared inpkg/gendoc. The related tests pass, including the newTestGenDocContentModeCLIfor both plugins.Fixes #5606