@jdxcode/mise 2026.10.3 → 2026.10.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +119 -86
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,14 +18,21 @@
|
|
|
18
18
|
<a href="https://discord.gg/mABnUDvP57"><img alt="Discord" src="https://img.shields.io/discord/1066429325269794907?style=for-the-badge&color=8B2252"></a>
|
|
19
19
|
</p>
|
|
20
20
|
|
|
21
|
+
<p align="center">
|
|
22
|
+
<a href="https://www.star-history.com/jdx/mise">
|
|
23
|
+
<picture><source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/badge?repo=jdx/mise&type=rank&theme=dark" /><source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/badge?repo=jdx/mise&type=rank" /><img alt="Star History Rank" src="https://api.star-history.com/badge?repo=jdx/mise&type=rank" /></picture> <picture><source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/badge?repo=jdx/mise&type=trending&theme=dark" /><source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/badge?repo=jdx/mise&type=trending" /><img alt="GitHub Trending Repository of the Day" src="https://api.star-history.com/badge?repo=jdx/mise&type=trending" /></picture>
|
|
24
|
+
</a>
|
|
25
|
+
</p>
|
|
26
|
+
|
|
21
27
|
<p><b>Dev tools, env vars, and tasks in one CLI</b></p>
|
|
22
28
|
|
|
23
29
|
<p align="center">
|
|
24
|
-
<a href="https://mise.jdx.dev/getting-started.html">Getting
|
|
25
|
-
<a href="https://mise.jdx.dev">
|
|
26
|
-
<a href="https://mise.jdx.dev/dev-tools/">Dev
|
|
30
|
+
<a href="https://mise.jdx.dev/getting-started.html">Getting started</a> •
|
|
31
|
+
<a href="https://mise.jdx.dev">Docs</a> •
|
|
32
|
+
<a href="https://mise.jdx.dev/dev-tools/">Dev tools</a> •
|
|
27
33
|
<a href="https://mise.jdx.dev/environments/">Environments</a> •
|
|
28
|
-
<a href="https://mise.jdx.dev/tasks/">Tasks</a>
|
|
34
|
+
<a href="https://mise.jdx.dev/tasks/">Tasks</a> •
|
|
35
|
+
<a href="https://mise.jdx.dev/bootstrap.html">Bootstrap</a>
|
|
29
36
|
</p>
|
|
30
37
|
|
|
31
38
|
<p align="center">
|
|
@@ -53,16 +60,33 @@
|
|
|
53
60
|
|
|
54
61
|
## What is mise?
|
|
55
62
|
|
|
56
|
-
mise
|
|
57
|
-
|
|
58
|
-
your editor, and CI.
|
|
63
|
+
mise (pronounced "meez", short for _mise-en-place_) installs a project's tools,
|
|
64
|
+
sets its environment variables, and runs its tasks from one `mise.toml` that
|
|
65
|
+
works in your shell, editor, and CI. With `mise bootstrap`, it can also set up a
|
|
66
|
+
whole machine: packages, dotfiles, and services.
|
|
67
|
+
|
|
68
|
+
- Install [tools](https://mise.jdx.dev/dev-tools/) such as Node.js, Python, and
|
|
69
|
+
Terraform from a [registry of 1,000+](https://mise.jdx.dev/registry.html),
|
|
70
|
+
with a different version in each project.
|
|
71
|
+
- Set [environment variables](https://mise.jdx.dev/environments/) and load
|
|
72
|
+
`.env` files for each project.
|
|
73
|
+
- Run [tasks](https://mise.jdx.dev/tasks/), such as build and test, with the
|
|
74
|
+
project's tools and environment variables.
|
|
75
|
+
- Set up a machine with [`mise bootstrap`](https://mise.jdx.dev/bootstrap.html),
|
|
76
|
+
which applies the system packages, [dotfiles](https://mise.jdx.dev/dotfiles.html),
|
|
77
|
+
repositories, and services you declare for it.
|
|
78
|
+
|
|
79
|
+
Use only the parts you need. You can start with one tool or one task.
|
|
80
|
+
|
|
81
|
+
## Demo
|
|
82
|
+
|
|
83
|
+
Watch mise run a tool once with `mise exec`, set global defaults, and switch
|
|
84
|
+
Node.js versions as you move into and out of a project.
|
|
59
85
|
|
|
60
|
-
|
|
61
|
-
- **[Environments](https://mise.jdx.dev/environments/):** set project environment variables and load `.env` files.
|
|
62
|
-
- **[Tasks](https://mise.jdx.dev/tasks/):** run build, test, and other commands with the tools and environment they need.
|
|
63
|
-
- **[Bootstrap](https://mise.jdx.dev/bootstrap.html):** declare machine setup, including system packages, dotfiles, and services.
|
|
86
|
+
[](https://mise.jdx.dev/demo.html)
|
|
64
87
|
|
|
65
|
-
|
|
88
|
+
The [demo transcript](https://mise.jdx.dev/demo.html#transcript) lists the
|
|
89
|
+
commands with current versions.
|
|
66
90
|
|
|
67
91
|
## Quickstart
|
|
68
92
|
|
|
@@ -75,28 +99,32 @@ curl https://mise.run | sh
|
|
|
75
99
|
~/.local/bin/mise --version
|
|
76
100
|
```
|
|
77
101
|
|
|
78
|
-
On Windows,
|
|
79
|
-
[
|
|
80
|
-
and other installation methods.
|
|
102
|
+
On Windows, run `winget install jdx.mise`. For Homebrew, apt, Scoop, and other
|
|
103
|
+
methods, see [Installing mise](https://mise.jdx.dev/installing-mise.html).
|
|
81
104
|
|
|
82
|
-
The
|
|
83
|
-
`~/.local/bin/mise`
|
|
105
|
+
The installer puts mise in `~/.local/bin`. If that directory is not on your
|
|
106
|
+
`PATH`, type `~/.local/bin/mise` wherever the steps below say `mise`, until you
|
|
107
|
+
activate mise in step 4.
|
|
84
108
|
|
|
85
109
|
### 2. Try a tool
|
|
86
110
|
|
|
87
111
|
```sh
|
|
88
112
|
mise exec node@24 -- node --version
|
|
113
|
+
# v24.x.x
|
|
89
114
|
```
|
|
90
115
|
|
|
91
|
-
|
|
92
|
-
your
|
|
116
|
+
`mise exec` installs Node.js 24 if needed and runs one command with it. It does
|
|
117
|
+
not change your shell or any config file, and it works without activation.
|
|
93
118
|
|
|
94
|
-
|
|
95
|
-
from its directory and `mise tasks ls` to discover its tasks.
|
|
119
|
+
### 3. Set up a project
|
|
96
120
|
|
|
97
|
-
|
|
121
|
+
```sh
|
|
122
|
+
mkdir my-project && cd my-project
|
|
123
|
+
mise use node@24
|
|
124
|
+
```
|
|
98
125
|
|
|
99
|
-
|
|
126
|
+
`mise use` installs Node.js 24 and writes it to a new `mise.toml`. Add an
|
|
127
|
+
environment variable and a task to that file:
|
|
100
128
|
|
|
101
129
|
```toml
|
|
102
130
|
[tools]
|
|
@@ -106,8 +134,8 @@ node = "24"
|
|
|
106
134
|
NODE_ENV = "development"
|
|
107
135
|
|
|
108
136
|
[tasks.hello]
|
|
109
|
-
description = "Print the
|
|
110
|
-
run = '
|
|
137
|
+
description = "Print the Node.js version and NODE_ENV"
|
|
138
|
+
run = 'node -e "console.log(process.version, process.env.NODE_ENV)"'
|
|
111
139
|
```
|
|
112
140
|
|
|
113
141
|
Run the task:
|
|
@@ -116,82 +144,87 @@ Run the task:
|
|
|
116
144
|
mise run hello
|
|
117
145
|
```
|
|
118
146
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
To add tools later, run `mise use python@3.14` from the project directory.
|
|
124
|
-
Use `mise use --global` to set personal defaults. Version requests such as `"24"`
|
|
125
|
-
select a release in that series; use [exact pins or a lockfile](https://mise.jdx.dev/dev-tools/mise-lock.html)
|
|
126
|
-
when you need everyone to use the same resolved version.
|
|
147
|
+
```text
|
|
148
|
+
[hello] $ node -e "console.log(process.version, process.env.NODE_ENV)"
|
|
149
|
+
v24.x.x development
|
|
150
|
+
```
|
|
127
151
|
|
|
128
|
-
|
|
152
|
+
The task runs with the project's Node.js and `NODE_ENV`. Commit `mise.toml` so
|
|
153
|
+
teammates and CI get the same setup. `"24"` is a version request for the
|
|
154
|
+
Node.js 24 series, not an exact pin; to share exact versions, use a
|
|
155
|
+
[lockfile](https://mise.jdx.dev/dev-tools/mise-lock.html). Run
|
|
156
|
+
`mise use python@3.14` to add another tool to the project, or
|
|
157
|
+
`mise use --global node@24` to set a personal default in
|
|
158
|
+
`~/.config/mise/config.toml`.
|
|
129
159
|
|
|
130
|
-
|
|
131
|
-
you enter a directory. For an installation from `mise.run`, add **one** of these
|
|
132
|
-
lines to the corresponding shell config:
|
|
160
|
+
To see what mise loaded in this directory:
|
|
133
161
|
|
|
134
|
-
```
|
|
135
|
-
#
|
|
136
|
-
|
|
162
|
+
```sh
|
|
163
|
+
mise config ls # config files in use here
|
|
164
|
+
mise ls --current # tool versions selected by those files
|
|
165
|
+
mise doctor # checks the installation and shell activation
|
|
137
166
|
```
|
|
138
167
|
|
|
139
|
-
|
|
140
|
-
# ~/.zshrc
|
|
141
|
-
eval "$(~/.local/bin/mise activate zsh)"
|
|
142
|
-
```
|
|
168
|
+
### 4. Activate mise in your shell (optional)
|
|
143
169
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
170
|
+
Activation puts a project's tools on your `PATH` and sets its environment
|
|
171
|
+
variables when you enter the project, so you can run `node` without
|
|
172
|
+
`mise exec`. If you installed with `mise.run`, run the commands for your
|
|
173
|
+
shell once:
|
|
148
174
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
175
|
+
```sh
|
|
176
|
+
# bash
|
|
177
|
+
echo 'eval "$(~/.local/bin/mise activate bash)"' >> ~/.bashrc
|
|
178
|
+
```
|
|
152
179
|
|
|
153
|
-
|
|
180
|
+
```sh
|
|
181
|
+
# zsh
|
|
182
|
+
echo 'eval "$(~/.local/bin/mise activate zsh)"' >> "${ZDOTDIR:-$HOME}/.zshrc"
|
|
183
|
+
```
|
|
154
184
|
|
|
155
185
|
```sh
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
mise
|
|
186
|
+
# fish
|
|
187
|
+
mkdir -p ~/.config/fish
|
|
188
|
+
echo '~/.local/bin/mise activate fish | source' >> ~/.config/fish/config.fish
|
|
159
189
|
```
|
|
160
190
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
191
|
+
Open a new shell. In `my-project`, `node --version` now prints `v24.x.x`. For
|
|
192
|
+
PowerShell, Nushell, and other shells, or for mise installed another way, see
|
|
193
|
+
[Shell setup](https://mise.jdx.dev/shell-setup.html).
|
|
164
194
|
|
|
165
195
|
## Where to go next
|
|
166
196
|
|
|
167
|
-
|
|
|
168
|
-
|
|
|
169
|
-
|
|
|
170
|
-
| Add mise to
|
|
171
|
-
|
|
|
172
|
-
|
|
|
173
|
-
| Find a
|
|
174
|
-
|
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
- [
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
197
|
+
| To | Read |
|
|
198
|
+
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
199
|
+
| Follow the full tutorial | [Getting started](https://mise.jdx.dev/getting-started.html) |
|
|
200
|
+
| Add mise to a project you already work on | [Existing projects](https://mise.jdx.dev/walkthrough.html) |
|
|
201
|
+
| Join a project that already has a `mise.toml` | Review its config, then run `mise install` and `mise tasks ls` ([details](https://mise.jdx.dev/walkthrough.html#share-the-setup)) |
|
|
202
|
+
| Set up another shell or completions | [Shell setup](https://mise.jdx.dev/shell-setup.html) |
|
|
203
|
+
| Find a tool | [Registry](https://mise.jdx.dev/registry.html) |
|
|
204
|
+
| Use mise in an editor or CI | [Editors and IDEs](https://mise.jdx.dev/ide-integration.html) · [Continuous integration](https://mise.jdx.dev/continuous-integration.html) |
|
|
205
|
+
| Learn the main features | [Dev tools](https://mise.jdx.dev/dev-tools/) · [Environments](https://mise.jdx.dev/environments/) · [Tasks](https://mise.jdx.dev/tasks/) |
|
|
206
|
+
| Set up a new machine | [Bootstrap](https://mise.jdx.dev/bootstrap.html) · [Dotfiles](https://mise.jdx.dev/dotfiles.html) |
|
|
207
|
+
| Look up a command, setting, or config key | [CLI reference](https://mise.jdx.dev/cli/) · [Settings](https://mise.jdx.dev/configuration/settings.html) · [mise.toml](https://mise.jdx.dev/configuration.html) |
|
|
208
|
+
| Fix a problem | [Troubleshooting](https://mise.jdx.dev/troubleshooting.html) · [FAQ](https://mise.jdx.dev/faq.html) |
|
|
209
|
+
| Contribute to mise or its docs | [Contributing](CONTRIBUTING.md) · [Writing docs](docs/README.md) |
|
|
210
|
+
|
|
211
|
+
## Get help
|
|
212
|
+
|
|
213
|
+
- Report bugs in [GitHub Issues](https://github.com/jdx/mise/issues). Check
|
|
214
|
+
[Troubleshooting](https://mise.jdx.dev/troubleshooting.html) first, and
|
|
215
|
+
include the command you ran, a minimal `mise.toml`, the expected and actual
|
|
216
|
+
behavior, and your `mise doctor` output after you review it for private
|
|
217
|
+
details.
|
|
218
|
+
- Ask questions and share ideas in
|
|
219
|
+
[GitHub Discussions](https://github.com/jdx/mise/discussions).
|
|
220
|
+
- Chat with other users on [Discord](https://discord.gg/mABnUDvP57).
|
|
221
|
+
|
|
222
|
+
For security reports and other contacts, see
|
|
223
|
+
[Contact](https://mise.jdx.dev/contact.html). Before you use AI to reply to an
|
|
224
|
+
Issue or Discussion, read the
|
|
225
|
+
[AI reply policy](https://mise.jdx.dev/contributing.html#community-participation).
|
|
226
|
+
|
|
227
|
+
## Special thanks
|
|
195
228
|
|
|
196
229
|
<p>
|
|
197
230
|
<a href="https://namespace.so">
|