Skip to content

Commit fc7309d

Browse files
committed
Add Mise documentation and reference it in README
1 parent d35a798 commit fc7309d

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

Mise.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Mise
2+
3+
[mise](https://mise.jdx.dev) is a polyglot runtime manager (Ruby, Node.js, Python, Go, and more). It replaces tools like rbenv, nvm, and pyenv with a single CLI.
4+
5+
## Common commands
6+
7+
| Command | Action |
8+
|---|---|
9+
| `mise use --global ruby@3.3` | Set global Ruby version to 3.3 |
10+
| `mise use ruby@3.2` | Set Ruby 3.2 for the current project (creates `.mise.toml`) |
11+
| `mise use --global node@22` | Set global Node.js version to 22 |
12+
| `mise install ruby node` | Install the configured versions |
13+
| `mise current` | Show active tool versions |
14+
| `mise ls` | List all installed versions |
15+
| `mise ls-remote ruby` | List available Ruby versions |
16+
| `mise upgrade ruby` | Upgrade Ruby to the latest compatible version |
17+
| `mise prune` | Remove unused versions to free disk space |
18+
19+
## Per-project versions
20+
21+
Create a `.mise.toml` in your project root to pin versions:
22+
23+
```toml
24+
[tools]
25+
ruby = "3.3"
26+
node = "22"
27+
```
28+
29+
Mise picks this up automatically when you `cd` into the project directory.
30+
31+
## Adding more tools
32+
33+
Mise supports many tools beyond Ruby and Node.js:
34+
35+
```bash
36+
mise use --global python@3.12
37+
mise use --global jq
38+
mise use --global go@latest
39+
```
40+
41+
See the full list with `mise registry` or at [mise.jdx.dev](https://mise.jdx.dev).

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ Every config file sources a `.local` counterpart if present. Place your personal
8686

8787
- [Vim Key Mapping](Vim.md)
8888
- [Tmux Key Mapping](Tmux.md)
89+
- [Mise](Mise.md)
8990
- [Testing](tests/README.md)
9091

9192
## Options

0 commit comments

Comments
 (0)