Skip to content

docs: add Windows default paths and mise.toml examples alongside CLI commands#8926

Merged
jdx merged 4 commits intomainfrom
docs/windows-paths-and-toml-examples
Apr 5, 2026
Merged

docs: add Windows default paths and mise.toml examples alongside CLI commands#8926
jdx merged 4 commits intomainfrom
docs/windows-paths-and-toml-examples

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented Apr 5, 2026

Summary

  • Add Windows defaults for MISE_DATA_DIR (%LOCALAPPDATA%\mise) and MISE_CACHE_DIR (%TEMP%\mise) in configuration.md — these were only showing Unix/macOS paths
  • Show the resulting mise.toml after mise use examples in dev-tools/index.md so users understand what the command actually does to their config
  • Add mise.toml equivalent after backend install examples (npm, pipx, github) in getting-started.md
  • Note that editing mise.toml directly is equivalent to mise use

Test plan

  • Verify docs render correctly with mise run docs

🤖 Generated with Claude Code


Note

Low Risk
Low risk: documentation-only changes plus expanded descriptions in settings.toml/schema/mise.json with no runtime logic modifications.

Overview
Improves configuration and getting-started docs by adding Windows default paths (e.g., MISE_DATA_DIR, MISE_CACHE_DIR, and shims location) and by refreshing/standardizing mise.toml examples (including bumping Node examples to 24).

Clarifies what mise use writes by showing the resulting mise.toml/global config.toml, notes that manual edits are equivalent (followed by mise install), and adds a new trusting config files section explaining prompts and how to disable them via trusted_config_paths/MISE_TRUSTED_CONFIG_PATHS.

Expands the trusted_config_paths setting description in both schema/mise.json and settings.toml to document trust behavior and the [/] “trust all” option.

Reviewed by Cursor Bugbot for commit ed15f04. Bugbot is set up for automated code reviews on this repo. Configure here.

jdx and others added 2 commits April 5, 2026 17:52
…commands

- Add Windows defaults for MISE_DATA_DIR (%LOCALAPPDATA%\mise) and
  MISE_CACHE_DIR (%TEMP%\mise) in configuration.md
- Show the resulting mise.toml after `mise use` in dev-tools/index.md
- Add mise.toml equivalent after backend examples in getting-started.md
- Note that editing mise.toml directly is equivalent to using `mise use`

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…, and better examples

- Add "Trusting config files" section to getting-started.md explaining
  why trust prompts appear and how to resolve them
- Add warning in hooks.md about common syntax mistake ([hooks.postinstall]
  vs [hooks] postinstall = "...")
- Add Windows shims path (%LOCALAPPDATA%\mise\shims) to shims.md
- Update configuration.md example to use typical node+python project
  instead of terraform+erlang

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jdx jdx enabled auto-merge (squash) April 5, 2026 17:55
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 5, 2026

Greptile Summary

This PR improves mise documentation across several areas: it adds Windows-specific default paths for MISE_DATA_DIR (%LOCALAPPDATA%\\mise) and MISE_CACHE_DIR (%TEMP%\\mise), shows the resulting mise.toml/config.toml after mise use commands so users understand what the command actually writes, adds a new "Trusting config files" section explaining the security trust model, and expands the trusted_config_paths description in both schema/mise.json and settings.toml.

  • Added Windows path defaults for data dir, cache dir, and shims directory
  • Added inline mise.toml examples showing the output of mise use commands
  • Added a "Trusting config files" section with trust prompt explanation, mise trust usage, and MISE_TRUSTED_CONFIG_PATHS env var
  • Updated node version from 22→24 in examples across docs and cookbook
  • Expanded trusted_config_paths description to document the trust-all-via-[\"/\"] pattern
  • Minor: at line 306 of getting-started.md, mise.toml is referenced in a global-config context where the actual filename is config.toml

Confidence Score: 5/5

Safe to merge — documentation-only changes with no runtime behavior impact

All changes are documentation, schema descriptions, and settings descriptions. The Windows path additions are accurate, the examples are correct, and the new trust section is well-explained. The only finding is a minor naming inconsistency (P2) in getting-started.md that does not block merge.

docs/getting-started.md line 306 has a minor mise.toml vs config.toml naming inconsistency in the global config context

Important Files Changed

Filename Overview
docs/configuration.md Added Windows defaults for MISE_DATA_DIR/MISE_CACHE_DIR, updated mise.toml example to realistic tools/env/tasks layout, fixed inline code formatting for config file path
docs/dev-tools/index.md Added resulting mise.toml snippet after mise use node@24, updated node from 22→24, added note about direct editing equivalence
docs/dev-tools/shims.md Added Windows shim directory path (%LOCALAPPDATA%\mise\shims) alongside existing Unix path
docs/getting-started.md Added config.toml example after backend install commands, added Trusting config files section; minor: references mise.toml in global config context at line 306
docs/mise-cookbook/nodejs.md Bumped node version reference from 22 to 24 in cookbook example
schema/mise.json Expanded trusted_config_paths description to document trust-all behavior via ["/"]
settings.toml Expanded trusted_config_paths description matching schema/mise.json update

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User runs mise use] --> B{Local or Global?}
    B -->|mise use| C[Creates/updates mise.toml]
    B -->|mise use -g| D[Updates ~/.config/mise/config.toml]
    C --> E[mise auto-trusts the file]
    D --> E
    F[User edits config file directly] --> G{File already trusted?}
    G -->|No| H[mise prompts: Trust it? y/n]
    G -->|Yes| I[Runs normally]
    H -->|mise trust| I
    H -->|trusted_config_paths includes path| I
    H -->|trusted_config_paths=["/"]| I
Loading

Fix All in Claude Code

Reviews (2): Last reviewed commit: "docs: update node examples from 22 to 24..." | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation to include Windows-specific default paths for data and cache directories, improves formatting for configuration file paths, and adds examples of configuration file contents. The reviewer suggests using consistent Windows environment variable syntax and path separators for Windows-specific defaults to avoid confusion. Additionally, it is recommended to use more generic terminology when referring to configuration files to clarify that instructions apply to both local and global configurations.

Comment thread docs/configuration.md
@@ -474,7 +477,9 @@ mise can also be configured via environment variables. The following options are

### `MISE_DATA_DIR`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For Windows-specific defaults, it is more consistent and platform-appropriate to use Windows environment variable syntax (%VARIABLE%) and backslashes for paths. Mixing Unix-style $XDG_DATA_HOME with Windows-style %LOCALAPPDATA% on the same line can be confusing.

Suggested change
Default (Windows): %LOCALAPPDATA%\mise or %XDG_DATA_HOME%\mise

Comment thread docs/configuration.md
@@ -484,6 +489,7 @@ across machines.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to the MISE_DATA_DIR section, the Windows default for MISE_CACHE_DIR should use consistent Windows syntax for environment variables and path separators.

Suggested change
Default (Windows): %TEMP%\mise or %XDG_CACHE_HOME%\mise

Comment thread docs/getting-started.md
"github:BurntSushi/ripgrep" = "latest"
```

You can also edit `mise.toml` directly instead of using `mise use` — the effect is the same. Run `mise install` after editing to install the tools.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The note refers to mise.toml, but the example immediately preceding it shows the global configuration file ~/.config/mise/config.toml. To avoid confusion, it's better to use a more generic term like "configuration file" or explicitly mention both.

Suggested change
You can also edit `mise.toml` directly instead of using `mise use` — the effect is the same. Run `mise install` after editing to install the tools.
You can also edit the configuration file directly instead of using mise use — the effect is the same. Run mise install after editing to install the tools.

jdx and others added 2 commits April 5, 2026 18:01
…ks change

- Show how to disable trust prompts entirely with
  `mise settings trusted_config_paths=["/"]` or MISE_TRUSTED_CONFIG_PATHS=/
- Update trusted_config_paths description in settings.toml to mention
  the "/" trick for disabling trust
- Revert hooks.md syntax warning (removed per review)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Node 24 is the current LTS. Align all introductory examples to avoid
confusion with the pinned version output that shows node 24.x.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 5, 2026

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.4 x -- echo 23.0 ± 0.4 22.0 25.8 1.00
mise x -- echo 23.2 ± 0.7 21.7 25.2 1.01 ± 0.04

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.4 env 21.5 ± 0.6 20.7 27.7 1.00
mise env 22.0 ± 0.4 21.1 24.0 1.02 ± 0.04

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.4 hook-env 22.2 ± 0.5 21.5 26.5 1.00
mise hook-env 22.7 ± 0.4 21.8 24.6 1.02 ± 0.03

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.4 ls 19.4 ± 0.3 18.8 22.1 1.00
mise ls 20.0 ± 0.4 19.2 21.7 1.03 ± 0.03

xtasks/test/perf

Command mise-2026.4.4 mise Variance
install (cached) 148ms 148ms +0%
ls (cached) 77ms 77ms +0%
bin-paths (cached) 82ms 82ms +0%
task-ls (cached) 822ms 797ms +3%

@jdx jdx merged commit b15368e into main Apr 5, 2026
37 checks passed
@jdx jdx deleted the docs/windows-paths-and-toml-examples branch April 5, 2026 18:41
mise-en-dev added a commit that referenced this pull request Apr 6, 2026
### 🚀 Features

- **(config)** report env files in config ls and doctor output by
@SamSoldatenko in [#8853](#8853)
- add support for token sources in GitLab and Forgejo by @roele in
[#8868](#8868)

### 🐛 Bug Fixes

- **(aqua)** prevent double .exe extension when Windows override URL
already ends in .exe by @yusei-wy in
[#8863](#8863)
- **(bash)** avoid duplicate trust warning after cd by @timothysparg in
[#8920](#8920)
- **(env)** prevent config root injection into PATH via _.source by @jdx
in [#8936](#8936)
- **(install)** suppress spurious dependency warning when tool is
configured by @jdx in [#8923](#8923)

### 📚 Documentation

- **(node)** add section on pinning npm version by @jdx in
[#8925](#8925)
- add Windows default paths and mise.toml examples alongside CLI
commands by @jdx in [#8926](#8926)
- clarify common sources of confusion from GitHub discussions by @jdx in
[#8927](#8927)
- clarify Python venv mechanisms, JAVA_HOME behavior, and activation
performance by @jdx in [#8928](#8928)
- add FAQ and troubleshooting entries based on common Discord questions
by @jdx in [#8930](#8930)

### New Contributors

- @SamSoldatenko made their first contribution in
[#8853](#8853)
- @yusei-wy made their first contribution in
[#8863](#8863)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant