mise 2026.10.4 → 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.
Files changed (2) hide show
  1. package/README.md +113 -86
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -27,11 +27,12 @@
27
27
  <p><b>Dev tools, env vars, and tasks in one CLI</b></p>
28
28
 
29
29
  <p align="center">
30
- <a href="https://mise.jdx.dev/getting-started.html">Getting Started</a> •
31
- <a href="https://mise.jdx.dev">Documentation</a> •
32
- <a href="https://mise.jdx.dev/dev-tools/">Dev Tools</a> •
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> •
33
33
  <a href="https://mise.jdx.dev/environments/">Environments</a> •
34
- <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>
35
36
  </p>
36
37
 
37
38
  <p align="center">
@@ -59,16 +60,33 @@
59
60
 
60
61
  ## What is mise?
61
62
 
62
- mise manages your development tools, environment variables, and project tasks.
63
- Declare them in `mise.toml`, commit the file, and use the same setup in your shell,
64
- 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.
65
67
 
66
- - **[Tools](https://mise.jdx.dev/dev-tools/):** install Node.js, Python, Go, and [hundreds more](https://mise.jdx.dev/registry.html), with different versions for each project.
67
- - **[Environments](https://mise.jdx.dev/environments/):** set project environment variables and load `.env` files.
68
- - **[Tasks](https://mise.jdx.dev/tasks/):** run build, test, and other commands with the tools and environment they need.
69
- - **[Bootstrap](https://mise.jdx.dev/bootstrap.html):** declare machine setup, including system packages, dotfiles, and services.
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.
70
78
 
71
- Use the parts you need. Start with one tool or task and add more to the same config.
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.
85
+
86
+ [![Demo of mise managing tools](./docs/tapes/demo.gif)](https://mise.jdx.dev/demo.html)
87
+
88
+ The [demo transcript](https://mise.jdx.dev/demo.html#transcript) lists the
89
+ commands with current versions.
72
90
 
73
91
  ## Quickstart
74
92
 
@@ -81,28 +99,32 @@ curl https://mise.run | sh
81
99
  ~/.local/bin/mise --version
82
100
  ```
83
101
 
84
- On Windows, install with `winget install jdx.mise`. See the
85
- [installation guide](https://mise.jdx.dev/installing-mise.html) for package managers
86
- 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).
87
104
 
88
- The examples below use `mise`. If it isn't on your `PATH` yet, use
89
- `~/.local/bin/mise` instead on macOS or Linux.
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.
90
108
 
91
109
  ### 2. Try a tool
92
110
 
93
111
  ```sh
94
112
  mise exec node@24 -- node --version
113
+ # v24.x.x
95
114
  ```
96
115
 
97
- This installs Node.js if needed and runs it for this command, without changing
98
- your project configuration. No shell activation is required.
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.
99
118
 
100
- For an existing project that already has a reviewed `mise.toml`, run `mise install`
101
- from its directory and `mise tasks ls` to discover its tasks.
119
+ ### 3. Set up a project
102
120
 
103
- ### 3. Give a project its own environment
121
+ ```sh
122
+ mkdir my-project && cd my-project
123
+ mise use node@24
124
+ ```
104
125
 
105
- In a project directory, create `mise.toml`:
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:
106
128
 
107
129
  ```toml
108
130
  [tools]
@@ -112,8 +134,8 @@ node = "24"
112
134
  NODE_ENV = "development"
113
135
 
114
136
  [tasks.hello]
115
- description = "Print the project's Node.js version and environment"
116
- run = '''node -e "console.log(process.version, process.env.NODE_ENV)"'''
137
+ description = "Print the Node.js version and NODE_ENV"
138
+ run = 'node -e "console.log(process.version, process.env.NODE_ENV)"'
117
139
  ```
118
140
 
119
141
  Run the task:
@@ -122,82 +144,87 @@ Run the task:
122
144
  mise run hello
123
145
  ```
124
146
 
125
- mise installs the configured tool if needed, loads `NODE_ENV`, and runs the task.
126
- The output includes the Node.js version and `development`. Commit `mise.toml` so
127
- teammates and CI can run the same command.
128
-
129
- To add tools later, run `mise use python@3.14` from the project directory.
130
- Use `mise use --global` to set personal defaults. Version requests such as `"24"`
131
- select a release in that series; use [exact pins or a lockfile](https://mise.jdx.dev/dev-tools/mise-lock.html)
132
- 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
+ ```
133
151
 
134
- ### 4. Activate your shell (optional)
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`.
135
159
 
136
- Activation makes project tools and environment variables available directly when
137
- you enter a directory. For an installation from `mise.run`, add **one** of these
138
- lines to the corresponding shell config:
160
+ To see what mise loaded in this directory:
139
161
 
140
- ```bash
141
- # ~/.bashrc
142
- eval "$(~/.local/bin/mise activate bash)"
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
143
166
  ```
144
167
 
145
- ```zsh
146
- # ~/.zshrc
147
- eval "$(~/.local/bin/mise activate zsh)"
148
- ```
168
+ ### 4. Activate mise in your shell (optional)
149
169
 
150
- ```fish
151
- # ~/.config/fish/config.fish
152
- ~/.local/bin/mise activate fish | source
153
- ```
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:
154
174
 
155
- Restart your shell, then run `node --version` inside the project. For PowerShell
156
- and other installation methods, follow the
157
- [shell setup guide](https://mise.jdx.dev/getting-started.html#activate-mise).
175
+ ```sh
176
+ # bash
177
+ echo 'eval "$(~/.local/bin/mise activate bash)"' >> ~/.bashrc
178
+ ```
158
179
 
159
- ## Check your project setup
180
+ ```sh
181
+ # zsh
182
+ echo 'eval "$(~/.local/bin/mise activate zsh)"' >> "${ZDOTDIR:-$HOME}/.zshrc"
183
+ ```
160
184
 
161
185
  ```sh
162
- mise config ls
163
- mise ls --current
164
- mise exec -- node --version
186
+ # fish
187
+ mkdir -p ~/.config/fish
188
+ echo '~/.local/bin/mise activate fish | source' >> ~/.config/fish/config.fish
165
189
  ```
166
190
 
167
- These show which configuration files are loaded, which versions are selected,
168
- and whether the tool runs in the project environment. If `mise exec` works but
169
- `node --version` does not, check shell activation with `mise doctor`.
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).
170
194
 
171
195
  ## Where to go next
172
196
 
173
- | I want to… | Read |
174
- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
175
- | Set up mise for the first time | [Getting started](https://mise.jdx.dev/getting-started.html) |
176
- | Add mise to an existing project | [Walkthrough](https://mise.jdx.dev/walkthrough.html) |
177
- | Understand configuration and overrides | [Configuration](https://mise.jdx.dev/configuration.html) |
178
- | Use mise in an editor or CI | [IDE integration](https://mise.jdx.dev/ide-integration.html) · [Continuous integration](https://mise.jdx.dev/continuous-integration.html) |
179
- | Find a command or solve a problem | [CLI reference](https://mise.jdx.dev/cli/) · [Troubleshooting](https://mise.jdx.dev/troubleshooting.html) |
180
- | Contribute to mise | [Contributing](CONTRIBUTING.md) · [Writing docs](docs/README.md) |
181
-
182
- ## Demo
183
-
184
- Watch mise install tools and switch Node.js versions as you change directories.
185
-
186
- [![Demo of mise managing tools](./docs/tapes/demo.gif)](https://mise.jdx.dev/demo.html)
187
-
188
- A [text transcript](https://mise.jdx.dev/demo.html) is also available.
189
-
190
- ## GitHub Issues & Discussions
191
-
192
- Report bugs in [GitHub Issues](https://github.com/jdx/mise/issues). Use
193
- [GitHub Discussions](https://github.com/jdx/mise/discussions) for questions and feature ideas.
194
-
195
- - [Issues](https://github.com/jdx/mise/issues): report a bug with a minimal config, the command you ran, expected behavior, and relevant error output. See the [troubleshooting guide](https://mise.jdx.dev/troubleshooting.html) first.
196
- - [Troubleshooting](https://github.com/jdx/mise/discussions/categories/troubleshooting-and-bug-reports): ask for help when you are not sure whether something is a bug.
197
- - [Ideas](https://github.com/jdx/mise/discussions/categories/ideas): suggest a feature or describe a workflow mise could support.
198
- - [Announcements](https://github.com/jdx/mise/discussions/categories/announcements): follow project updates.
199
-
200
- ## Special Thanks
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
201
228
 
202
229
  <p>
203
230
  <a href="https://namespace.so">
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "mise",
3
3
  "description": "Dev tools, env vars, and tasks in one CLI",
4
- "version": "2026.10.4",
4
+ "version": "2026.10.5",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "https://github.com/jdx/mise"