docs: add documentation for os field in tool configuration#5947
Merged
Conversation
Add documentation explaining how to use the os field to restrict tools to specific operating systems in mise.toml configuration files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the os field in tool configuration to explain how to restrict tool installation to specific operating systems. This addresses a gap where the feature was available but undocumented.
- Adds a new "OS-Specific Tools" section to the dev-tools documentation
- Documents supported OS identifiers (linux, macos, windows) and usage patterns
- Provides clear examples showing integration with other tool configuration options
Comments suppressed due to low confidence (1)
Hyperfine Performance
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.8.7 x -- echo |
19.2 ± 0.3 | 18.6 | 23.1 | 1.01 ± 0.06 |
mise x -- echo |
19.0 ± 1.1 | 17.9 | 33.8 | 1.00 |
mise env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.8.7 env |
18.1 ± 0.4 | 17.4 | 20.6 | 1.00 |
mise env |
18.1 ± 0.9 | 17.4 | 32.5 | 1.00 ± 0.05 |
mise hook-env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.8.7 hook-env |
17.8 ± 0.8 | 17.0 | 29.6 | 1.00 |
mise hook-env |
18.1 ± 0.9 | 17.1 | 30.1 | 1.02 ± 0.07 |
mise ls
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2025.8.7 ls |
16.6 ± 0.3 | 15.9 | 18.7 | 1.01 ± 0.03 |
mise ls |
16.5 ± 0.4 | 15.9 | 18.4 | 1.00 |
xtasks/test/perf
| Command | mise-2025.8.7 | mise | Variance |
|---|---|---|---|
| install (cached) | 190ms | ✅ 128ms | +48% |
| ls (cached) | 81ms | 82ms | -1% |
| bin-paths (cached) | 65ms | 65ms | +0% |
| task-ls (cached) | 483ms | 469ms | +2% |
✅ Performance improvement: install cached is 48%
jdx
pushed a commit
that referenced
this pull request
Aug 11, 2025
### 📦 Registry - add bob ([aqua:MordechaiHadad/bob](https://github.com/MordechaiHadad/bob)) by [@TyceHerrman](https://github.com/TyceHerrman) in [#5914](#5914) - support usage on FreeBSD by [@risu729](https://github.com/risu729) in [#5973](#5973) - filter out installer for podman by [@risu729](https://github.com/risu729) in [#5974](#5974) - use pipx aqua backend by [@itochan](https://github.com/itochan) in [#5971](#5971) ### 📚 Documentation - add documentation for os field in tool configuration by [@jdx](https://github.com/jdx) in [#5947](#5947) ### Chore - **(ci)** accept @ in regular expressions for new registry PR titles by [@mst-mkt](https://github.com/mst-mkt) in [#5969](#5969) - fix registry test filter by [@risu729](https://github.com/risu729) in [#5942](#5942) - fix registry test by [@risu729](https://github.com/risu729) in [#5953](#5953) ### New Contributors - @itochan made their first contribution in [#5971](#5971) - @mst-mkt made their first contribution in [#5969](#5969)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
osfield in tool configurationDetails
This PR adds a new section "OS-Specific Tools" to the dev-tools documentation that explains how to use the
osfield to restrict tool installation to specific operating systems (linux, macos, windows).The documentation includes:
Fixes the issue where the
osfield was being used in mise.toml files but was not documented in the user-facing documentation.🤖 Generated with Claude Code