Skip to content

docs: improve installation documentation#7403

Merged
jdx merged 4 commits intomainfrom
docs/improve-installation-docs
Dec 18, 2025
Merged

docs: improve installation documentation#7403
jdx merged 4 commits intomainfrom
docs/improve-installation-docs

Conversation

@jdx
Copy link
Owner

@jdx jdx commented Dec 18, 2025

Summary

  • Add quick reference table with recommended install methods per platform
  • Add auto-update tip explaining which methods update automatically
  • Add package page links for Homebrew, Arch, MacPorts, npm, Scoop, winget
  • Update outdated version examples (v2024.x → v2025.12.0)
  • Update nix version requirement (23.05 → 24.05)
  • Expand Docker section with Hub link and example Dockerfile
  • Add Troubleshooting section pointing to mise doctor
  • Fix Xonsh code formatting (remove extra spaces in imports)

Test plan

  • Preview docs locally with mise run docs
  • Verify all external links work

🤖 Generated with Claude Code


Note

Revamps installation docs with a quick-reference table, links, Docker example, troubleshooting, and updated versions; adds release automation to update version strings in docs.

  • Docs (docs/installing-mise.md):
    • Install guide revamp: Add quick-reference table of methods and auto-update tip.
    • Links: Add package pages for Homebrew, Arch, MacPorts, npm, Scoop, winget, Docker Hub.
    • Docker: Add Hub link and example Dockerfile.
    • Versions: Update examples to v2025.12.0; bump Nix requirement to 24.05.
    • Fixes: Minor Xonsh code formatting.
  • Release tooling (Cargo.toml):
    • Add [package.metadata.release] with pre-release replacements to auto-update version strings in docs/installing-mise.md.

Written by Cursor Bugbot for commit 940cc55. This will update automatically on new commits. Configure here.

- Add quick reference table with recommended methods per platform
- Add auto-update tip explaining which methods update automatically
- Add package page links for Homebrew, Arch, MacPorts, npm, Scoop, winget
- Update outdated version examples (v2024.x → v2025.12.0)
- Update nix version requirement (23.05 → 24.05)
- Expand Docker section with Hub link and example Dockerfile
- Add Troubleshooting section pointing to `mise doctor`
- Fix Xonsh code formatting (remove extra spaces in imports)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings December 18, 2025 23:14
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the installation documentation by adding a quick reference table for recommended installation methods per platform, clarifying auto-update behavior, adding package repository links, and updating outdated version examples from 2024.x to 2025.12.0.

Key Changes

  • Added quick reference table with recommended and alternative installation methods for each platform
  • Updated version examples from v2024.x to v2025.12.0
  • Added package repository links for major package managers (Homebrew, Arch, MacPorts, npm, Scoop, winget)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

### nix

For the Nix package manager, at release 23.05 or later:
For the Nix package manager, at release 24.05 or later:
Copy link

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

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

The minimum Nix version requirement was updated from 23.05 to 24.05. Ensure this requirement change is intentional and that mise actually requires Nix 24.05, as this could affect users on older Nix versions who may not be able to upgrade immediately.

Suggested change
For the Nix package manager, at release 24.05 or later:
For the Nix package manager, at release 23.05 or later:

Copilot uses AI. Check for mistakes.
jdx and others added 2 commits December 18, 2025 17:15
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Adds cargo-release pre-release-replacements to update MISE_VERSION
and GitHub release URL examples in installing-mise.md when releasing.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The URL contains the version twice (path and filename), so the regex
needs to match both to avoid creating broken 404 URLs after release.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jdx jdx merged commit 3473207 into main Dec 18, 2025
29 checks passed
@jdx jdx deleted the docs/improve-installation-docs branch December 18, 2025 23:29
@github-actions
Copy link

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 x -- echo 19.5 ± 0.3 18.8 20.8 1.00
mise x -- echo 19.6 ± 0.3 18.9 21.8 1.00 ± 0.02

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 env 19.1 ± 0.4 18.5 24.6 1.00
mise env 19.2 ± 0.4 18.6 24.5 1.01 ± 0.03

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 hook-env 19.3 ± 0.4 18.6 22.6 1.00
mise hook-env 19.3 ± 0.5 18.8 27.7 1.00 ± 0.03

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 ls 16.8 ± 0.3 16.3 19.5 1.00
mise ls 16.9 ± 0.3 16.4 19.4 1.00 ± 0.02

xtasks/test/perf

Command mise-2025.12.12 mise Variance
install (cached) 107ms 108ms +0%
ls (cached) 66ms 66ms +0%
bin-paths (cached) 72ms 71ms +1%
task-ls (cached) 277ms 277ms +0%

jekis913 added a commit to jekis913/mise that referenced this pull request Dec 19, 2025
* upstream/renovate/lockfile-maintenance:
  chore(deps): lock file maintenance
  fix(ci): improve GHA cache efficiency and fix registry-ci bug (jdx#7404)
  feat(tera): add haiku() function for random name generation (jdx#7399)
  feat: implement independent versioning for subcrates (jdx#7402)
  docs: add comprehensive glossary (jdx#7401)
  docs: improve installation documentation (jdx#7403)
  test: add token pool integration for rate limit distribution (jdx#7397)
  docs: add link to COPR package page for Fedora/RHEL
  test: rename duplicate 'ci' job names for clarity (jdx#7398)
  registry: add github backend for swiftformat (jdx#7396)
  chore: rename mise-tools to mise-versions
  chore: release 2025.12.12 (jdx#7386)
  fix(github): use version_prefix when fetching release for SLSA verification (jdx#7391)
  refactor(vfox): remove submodules, embed plugins directly (jdx#7389)
  test(registry): add final ci job as merge gate (jdx#7390)
  test: split unit job to speed up macOS CI (jdx#7388)
  feat(backend): add security features to github backend (jdx#7387)
jdx pushed a commit that referenced this pull request Dec 19, 2025
### 🚀 Features

- **(tera)** add haiku() function for random name generation by @jdx in
[#7399](#7399)
- implement independent versioning for subcrates by @jdx in
[#7402](#7402)

### 🐛 Bug Fixes

- **(ci)** improve GHA cache efficiency and fix registry-ci bug by @jdx
in [#7404](#7404)
- **(ci)** use !cancelled() instead of always() for registry-ci by @jdx
in [#7435](#7435)
- **(test)** update backend_arg test to use clojure instead of poetry by
@jdx in [#7436](#7436)

### 📚 Documentation

- add link to COPR package page for Fedora/RHEL by @jdx in
[bc8ac73](bc8ac73)
- improve installation documentation by @jdx in
[#7403](#7403)
- add comprehensive glossary by @jdx in
[#7401](#7401)

### 🧪 Testing

- rename duplicate 'ci' job names for clarity by @jdx in
[#7398](#7398)
- add token pool integration for rate limit distribution by @jdx in
[#7397](#7397)

### 📦 Registry

- add github backend for swiftformat by @jdx in
[#7396](#7396)
- use pipx backend for azure-cli by @jdx in
[#7406](#7406)
- use pipx backend for dvc by @jdx in
[#7413](#7413)
- add github backend for zprint by @jdx in
[#7410](#7410)
- use gem backend for cocoapods by @jdx in
[#7411](#7411)
- use pipx backend for gallery-dl by @jdx in
[#7409](#7409)
- add aqua backends for HashiCorp tools by @jdx in
[#7408](#7408)
- use npm backend for danger-js by @jdx in
[#7407](#7407)
- use pipx backend for pipenv by @jdx in
[#7415](#7415)
- use pipx backend for poetry by @jdx in
[#7416](#7416)
- add github backend for xcodegen
([github:yonaskolb/XcodeGen](https://github.com/yonaskolb/XcodeGen)) by
@jdx in [#7417](#7417)
- use npm backend for heroku by @jdx in
[#7418](#7418)
- add aqua backend for setup-envtest by @jdx in
[#7421](#7421)
- add github backend for xcresultparser
([github:a7ex/xcresultparser](https://github.com/a7ex/xcresultparser))
by @jdx in [#7422](#7422)
- add aqua backend for tomcat by @jdx in
[#7423](#7423)
- use npm backend for serverless by @jdx in
[#7424](#7424)
- add github backend for daytona
([github:daytonaio/daytona](https://github.com/daytonaio/daytona)) by
@jdx in [#7412](#7412)
- add github backend for flyway
([github:flyway/flyway](https://github.com/flyway/flyway)) by @jdx in
[#7414](#7414)
- add github backend for schemacrawler
([github:schemacrawler/SchemaCrawler](https://github.com/schemacrawler/SchemaCrawler))
by @jdx in [#7419](#7419)
- add github backend for codeql by @jdx in
[#7420](#7420)
- use pipx backend for mitmproxy by @jdx in
[#7425](#7425)
- use pipx backend for sshuttle by @jdx in
[#7426](#7426)
- add github backend for quarkus by @jdx in
[#7428](#7428)
- add github backend for smithy by @jdx in
[#7430](#7430)
- add github backend for xchtmlreport
([github:XCTestHTMLReport/XCTestHTMLReport](https://github.com/XCTestHTMLReport/XCTestHTMLReport))
by @jdx in [#7431](#7431)
- add github backend for grails by @jdx in
[#7429](#7429)
- use npm backend for esy by @jdx in
[#7434](#7434)
- add github backend for micronaut by @jdx in
[#7433](#7433)
- add github backend for dome by @jdx in
[#7432](#7432)
- use vfox backend for poetry by @jdx in
[#7438](#7438)

### Chore

- **(docker)** add Node LTS to mise Docker image by @jdx in
[#7405](#7405)
- rename mise-tools to mise-versions by @jdx in
[ab3e1b8](ab3e1b8)
- s/mise task/mise tasks/g in docs and tests by @muzimuzhi in
[#7400](#7400)

### New Contributors

- @muzimuzhi made their first contribution in
[#7400](#7400)
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.

2 participants