-
Notifications
You must be signed in to change notification settings - Fork 201
Add mise usage instructions to installation guide #2252
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Added instructions for using mise for dependency management.
docs/installation.md
Outdated
| uv tool upgrade ty | ||
| ``` | ||
|
|
||
| ### Using mise |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we include this (which I think will require consensus from other maintainers too), I think it should go below all the official distribution methods instead of here. The title should also probably be consistent? e.g., "Installing with mise"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like how it's done in uv https://docs.astral.sh/uv/getting-started/installation/#homebrew or we could even have a single headline, Or your package manager of choice (or similar) and have all of them listed ina single section.
docs/installation.md
Outdated
| # Install the latest version | ||
| mise install ty | ||
|
|
||
| # Use a specific version for the project | ||
| mise use [email protected] | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Having multiple instructions in a single block doesn't match the other examples on this page.
docs/installation.md
Outdated
| # List available versions | ||
| mise ls-remote ty |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to include this, we don't explain how to list versions for any of the other installers.
MichaReiser
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on Zanie's feedback
|
Made this one consistent with other installation methods. |
docs/installation.md
Outdated
| ### Installing globally with mise | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should come after pipx, but definitely after the standalone installer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved
Co-authored-by: Dhruv Manilawala <[email protected]>
# Conflicts: # ruff
| mise install ty | ||
| ``` | ||
|
|
||
| To set it globally: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for yet another reviewer coming in late -- but I don't understand what "To set it globally" means, or how it differs from "Install ty globally" above?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With mise, you install something once, and then it might be linked to some project or be the default choice. So the user set the installed tool for the environment.
In contrast, with tools like npm, the package will be installed for the specific project (or globally), keeping multiple copies on the disk.
Hope that this explains the chosen wording
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works for me -- I assume it will be clear enough to a mise user.
|
This already has an approving review, and feedback has been addressed; going ahead and merging it. |
The tool was added to mise registry with jdx/mise#7495 , and this commit updates the docs