Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update documentation for core tools #4341

Merged
merged 2 commits into from
Feb 8, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
[autofix.ci] apply automated fixes
  • Loading branch information
autofix-ci[bot] authored Feb 8, 2025
commit 76377d247c2114547df5340bd9811e1c777050a0
4 changes: 2 additions & 2 deletions docs/lang/bun.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Bun

`mise` can be used to install and manage multiple versions of [bun](https://bun.sh/) on the same system.
`mise` can be used to install and manage multiple versions of [bun](https://bun.sh/) on the same system.

> The following are instructions for using the bun mise core plugin. This is used when there isn't a
git plugin installed named "bun".
> git plugin installed named "bun".

The code for this is inside the mise repository at
[`./src/plugins/core/bun.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/bun.rs).
Expand Down
4 changes: 2 additions & 2 deletions docs/lang/deno.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
`mise` can be used to install and manage multiple versions of [deno](https://deno.land/) on the same system.

> The following are instructions for using the deno mise core plugin. This is used when there isn't a
git plugin installed named "deno". If you want to use [asdf-deno](https://github.com/asdf-community/asdf-deno)
then run `mise plugins install deno https://github.com/asdf-community/asdf-deno`.
> git plugin installed named "deno". If you want to use [asdf-deno](https://github.com/asdf-community/asdf-deno)
> then run `mise plugins install deno https://github.com/asdf-community/asdf-deno`.

The code for this is inside the mise repository at
[`./src/plugins/core/deno.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/deno.rs).
Expand Down
2 changes: 1 addition & 1 deletion docs/lang/erlang.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
`mise` can be used to install and manage multiple versions of [erlang](https://www.erlang.org/) on the same system.

> The following are instructions for using the erlang core plugin.
This is used when there isn't a git plugin installed named "erlang".
> This is used when there isn't a git plugin installed named "erlang".

The code for this is inside the mise repository at
[`./src/plugins/core/erlang.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/erlang.rs).
Expand Down
6 changes: 2 additions & 4 deletions docs/lang/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
`mise` can be used to install and manage multiple versions of [go](https://golang.org/) on the same system.

> The following are instructions for using the go mise core plugin. This is used when there isn't a
git plugin installed named "go". If you want to use [asdf-golang](https://github.com/kennyp/asdf-golang)
then use `mise plugins install go GIT_URL`.
> git plugin installed named "go". If you want to use [asdf-golang](https://github.com/kennyp/asdf-golang)
> then use `mise plugins install go GIT_URL`.

The code for this is inside the mise repository at
[`./src/plugins/core/go.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/go.rs).
Expand Down Expand Up @@ -49,5 +49,3 @@ github.com/jesseduffield/lazygit
import Settings from '/components/settings.vue';
</script>
<Settings child="go" :level="3" />


14 changes: 7 additions & 7 deletions docs/lang/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Like `sdkman`, `mise` can manage multiple versions of Java on the same system.

> The following are instructions for using the java mise core plugin. This is used when there isn't a
git plugin installed named "java". If you want to use [asdf-java](https://github.com/halcyon/asdf-java)
then use `mise plugins install java GIT_URL`.
> git plugin installed named "java". If you want to use [asdf-java](https://github.com/halcyon/asdf-java)
> then use `mise plugins install java GIT_URL`.

The code for this is inside the mise repository at
[`./src/plugins/core/java.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/java.rs).
Expand All @@ -31,7 +31,7 @@ See available versions with `mise ls-remote java`. com>.

::: warning
Note that shorthand versions (like `21` in the example) use [`OpenJDK`](https://openjdk.org/) as the vendor.
The OpenJDK versions will only be updated for a 6-month period. Updates and security patches will not be available after this short period. This also applies for LTS versions.
The OpenJDK versions will only be updated for a 6-month period. Updates and security patches will not be available after this short period. This also applies for LTS versions.

For more information on which JDK to choose, see <https://whichjdk.com>.
:::
Expand All @@ -56,9 +56,9 @@ The Java core plugin supports the idiomatic version files `.java-version` and `.

For `.sdkmanrc` files, mise will try to map the vendor and version to the appropriate version
string. For example, the version `20.0.2-tem` will be mapped to `temurin-20.0.2`. Due to Azul's Zulu
versioning, the version `11.0.12-zulu` will be mapped to the major version `zulu-11`.
versioning, the version `11.0.12-zulu` will be mapped to the major version `zulu-11`.

Not all vendors available in [sdkman](https://sdkman.io/jdks) are supported by mise.
Not all vendors available in [sdkman](https://sdkman.io/jdks) are supported by mise.
The following vendors are NOT supported: `bsg` (Bisheng), `graal` (GraalVM), `nik` (Liberica NIK).

### Using unsupported versions
Expand Down Expand Up @@ -112,12 +112,12 @@ are supported:

## Gradle toolchains detection

Gradle can automatically detect toolchains installed by some tools (see [toolchain | auto-detection](https://docs.gradle.org/current/userguide/toolchains.html#sec:auto_detection)).
Gradle can automatically detect toolchains installed by some tools (see [toolchain | auto-detection](https://docs.gradle.org/current/userguide/toolchains.html#sec:auto_detection)).

At the moment, `Gradle` does not support auto-detecting Java installations by `mise` (see [gradle/issues/29508](https://github.com/gradle/gradle/issues/29508) and [gradle/issues/29355](https://github.com/gradle/gradle/issues/29355)). A workaround is to leverage the fact that `mise` install layout is [similar to the one used by `asdf`](/ide-integration.html#sdk-selection-using-asdf-layout).

```shell
mkdir -p ~/.asdf/installs/ && ln -s ~/.local/share/mise/installs/java ~/.asdf/installs/
```

Otherwise, you can always use the [foojay-resolver-convention](https://plugins.gradle.org/plugin/org.gradle.toolchains.foojay-resolver-convention) plugin to let Gradle automatically install JDKs required by your project.
Otherwise, you can always use the [foojay-resolver-convention](https://plugins.gradle.org/plugin/org.gradle.toolchains.foojay-resolver-convention) plugin to let Gradle automatically install JDKs required by your project.
10 changes: 4 additions & 6 deletions docs/lang/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Like `nvm`, (or `volta`, `fnm` or `asdf`...), `mise` can manage multiple versions of Node.js on the same system.

> The following are instructions for using the node mise core plugin. This is used when there isn't a
git plugin installed named "node".
> git plugin installed named "node".
> If you want to use [asdf-nodejs](https://github.com/asdf-vm/asdf-nodejs)
then run `mise plugins install node https://github.com/asdf-vm/asdf-nodejs`
> then run `mise plugins install node https://github.com/asdf-vm/asdf-nodejs`

The code for this is inside the mise repository at [`./src/plugins/core/node.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/node.rs).

Expand All @@ -20,12 +20,11 @@ mise use -g node@20

See the [Node.JS Cookbook](/mise-cookbook/nodejs.html) for common tasks and examples.


## `.nvmrc` and `.node-version` support

By default, mise uses a `mise.toml` file for auto-switching between software versions.

It also supports `.tool-versions`, `.nvmrc` or `.node-version` file to find out what version of Node.js should be used. This will be used if `node` isn't defined in `mise.toml`.
It also supports `.tool-versions`, `.nvmrc` or `.node-version` file to find out what version of Node.js should be used. This will be used if `node` isn't defined in `mise.toml`.

This makes it a drop-in replacement for `nvm`. See [idiomatic version files](/configuration.html#idiomatic-version-files) for more information.

Expand All @@ -47,7 +46,6 @@ You cannot install/use a plugin named "nodejs". If you attempt this, mise will j
"node". See the [FAQ](/faq.html#what-is-the-difference-between-nodejs-and-node-or-golang-and-go)
for an explanation.


## Building from source

If compiling from source, see [BUILDING.md](https://github.com/nodejs/node/blob/main/BUILDING.md#building-nodejs-on-supported-platforms) in node's documentation for
Expand Down Expand Up @@ -102,4 +100,4 @@ import Settings from '/components/settings.vue';

::: info
These environment variables will be migrated to compatible settings in the future.
:::
:::
4 changes: 2 additions & 2 deletions docs/lang/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Like `pyenv`, `mise` can manage multiple versions of Python on the same system. Mise can also automatically create virtual environments for your projects and integrates with `uv`.

> The following are instructions for using the python mise core plugin. The core plugin will be used
so long as no plugin is manually
installed named "python" using `mise plugins install python [GIT_URL]`.
> so long as no plugin is manually
> installed named "python" using `mise plugins install python [GIT_URL]`.

The code for this is inside of the mise repository
at [`./src/plugins/core/python.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/python.rs).
Expand Down
6 changes: 3 additions & 3 deletions docs/lang/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Like `rvm`, `rbenv`, or `asdf`, `mise` can manage multiple versions of [Ruby](https://www.ruby-lang.org/) on the same system.

> The following are instructions for using the ruby mise core plugin. This is used when there isn't a
git plugin installed named "ruby". If you want to use [asdf-ruby](https://github.com/asdf-vm/asdf-ruby)
then use `mise plugins install ruby GIT_URL`.
> git plugin installed named "ruby". If you want to use [asdf-ruby](https://github.com/asdf-vm/asdf-ruby)
> then use `mise plugins install ruby GIT_URL`.

The code for this is inside the mise repository at
[`./src/plugins/core/ruby.rs`](https://github.com/jdx/mise/blob/main/src/plugins/core/ruby.rs).
Expand All @@ -24,7 +24,6 @@ from source. Ensure that you have the necessary
You can check its [README](https://github.com/rbenv/ruby-build/blob/master/README.md) for additional settings and some
troubleshooting.


## Default gems

mise can automatically install a default set of gems right after installing a new ruby version.
Expand Down Expand Up @@ -61,6 +60,7 @@ update:
mise cache clean
mise ls-remote ruby
```

## Settings

`ruby-build` already has a
Expand Down