-
Notifications
You must be signed in to change notification settings - Fork 328
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
Update a few phrases for mise install #1712
Conversation
docs/cli-reference.md
Outdated
It won't be used simply by being installed, however. | ||
For that, you must set up a `.mise.toml`/`.tool-version` file manually or with `mise use`. | ||
Or you can call a tool version explicitly with `mise exec <TOOL>@<VERSION> -- <COMMAND>`. | ||
`install` will install a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>` |
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.
`install` will install a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>` | |
Installs a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>` |
docs/cli-reference.md
Outdated
`install` will install a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>` | ||
Tools are inactive without being enabled, however. | ||
To enable a tool, set up a `.mise.toml`/`.tool-version` file or `mise use`. | ||
Another way is to use a tool explicitly with `mise exec <TOOL>@<VERSION> -- <COMMAND>`. |
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.
Another way is to use a tool explicitly with `mise exec <TOOL>@<VERSION> -- <COMMAND>`. | |
Alternatively, run `mise exec <TOOL>@<VERSION> -- <COMMAND>` to execute a tool without creating config files. |
docs/cli-reference.md
Outdated
For that, you must set up a `.mise.toml`/`.tool-version` file manually or with `mise use`. | ||
Or you can call a tool version explicitly with `mise exec <TOOL>@<VERSION> -- <COMMAND>`. | ||
`install` will install a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>` | ||
Tools are inactive without being enabled, however. |
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.
Tools are inactive without being enabled, however. | |
Installing alone will not activate the tools so they won't be in PATH. |
I'm a little uncomfortable with this language since it still will create shims, so shim users will have it in PATH but the shims won't work. I think that this language does make sense for the majority of users though and that subtle behavior difference won't make any practical difference since the way shims behave is if they're not active it falls back to the system bin (if any). So it behaves basically as if it "wasn't in PATH".
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.
Good point!
docs/cli-reference.md
Outdated
Or you can call a tool version explicitly with `mise exec <TOOL>@<VERSION> -- <COMMAND>`. | ||
`install` will install a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>` | ||
Tools are inactive without being enabled, however. | ||
To enable a tool, set up a `.mise.toml`/`.tool-version` file or `mise use`. |
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.
To enable a tool, set up a `.mise.toml`/`.tool-version` file or `mise use`. | |
To install and/or activate in one command, use `mise use` which will create a `.mise.toml` file in the current directory to activate this tool when inside the directory. |
docs/cli-reference.md
Outdated
Show installation output. This argument will print plugins' logs. | ||
When plugin downloads assets, mise will show download logs. | ||
When plugin configures and compiles tools, mise will show configuration and compilation logs. |
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.
Show installation output. This argument will print plugins' logs. | |
When plugin downloads assets, mise will show download logs. | |
When plugin configures and compiles tools, mise will show configuration and compilation logs. | |
Show installation output. | |
This argument will print plugin output such as download, configuration, and compilation output. |
so I really appreciate your attention on this. I agree that this language can be improved (like a lot of stuff in mise). Apologies if some of my feedback seems nitpicky. I'm trying to be careful about being consistent and using "activated" instead of "enabled" everywhere I describe this behavior. Unfortunately this isn't the right place to make this change. This file is autogenerated, you'll need to make these changes in this file's comments instead. Then on the next release this markdown file will be updated. |
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.
Thanks for your review. I would guess the doc comes from a script but I didn't browser through code yet. Writing a PR is probably better than forgetting about it after getting your help (from an issue).
mise is a nice tool. I am using it instead of asdf. I understand the consistency you want to achieve. I respect the effort you had put into mise already. The next patch will be better!
docs/cli-reference.md
Outdated
For that, you must set up a `.mise.toml`/`.tool-version` file manually or with `mise use`. | ||
Or you can call a tool version explicitly with `mise exec <TOOL>@<VERSION> -- <COMMAND>`. | ||
`install` will install a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>` | ||
Tools are inactive without being enabled, however. |
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.
Good point!
A minor effort in updating the doc. I can see more venues for improvements on:
I will leave it to future work for now. Perhaps soon!
The text should be more intuitive for my understanding on #1711