Skip to content

docs: explain when to use the plugin in place of SDKMAN and compare their commands - #121

Merged
linghengqian merged 1 commit into
mainfrom
docs/sdkman-comparison
Nov 3, 2026
Merged

linghengqian merged 1 commit into
mainfrom
docs/sdkman-comparison

Conversation

@linghengqian

Copy link
Copy Markdown
Member
  • docs: explain when to use the plugin in place of SDKMAN and compare their commands.

  • docs/sdkman.md and docs/zh-CN/sdkman.md are new. They say when the plugin is the right tool, give a table of 14 tasks with the SDKMAN command and the vfox command for each, and list what differs: the default distribution, vfox search java listing OpenJDK only, installed names that carry a build number, a .sdkmanrc that only selects, and so on.

  • README.md and README_CN.md get a "Use cases" section. SDKMAN is a set of bash scripts and, by its own installation page, cannot be installed natively on Windows, so it cannot be used in PowerShell, not even in the Windows PowerShell 5.1 that comes with Windows. There the plugin takes its place.

  • docs/sdkmanrc.md and its Chinese page link to the new page.

The SDKMAN side comes from sdkman.io's installation and usage pages and its public API, read on 2026-11-02. SDKMAN itself was not installed. The vfox commands were tried with vfox 1.0.13 and plugin 0.6.3 on Linux, except vfox upgrade, vfox update java and vfox use --global, which change the machine. The relative links and anchors in the docs resolve.

The pages do not claim that vfox was tested in Windows PowerShell 5.1: the Windows e2e suite runs PowerShell 7 only. They say that SDKMAN cannot be used there and that vfox has a hook for PowerShell.

@linghengqian linghengqian added the documentation Improvements or additions to documentation label Nov 3, 2026
@linghengqian
linghengqian merged commit f8322ab into main Nov 3, 2026
11 checks passed
@linghengqian
linghengqian deleted the docs/sdkman-comparison branch November 3, 2026 01:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant