dnrops
/
mise
mirror of https://github.com/jdx/mise
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Update walkthrough.md (#4751)

This commit is contained in:
jdx 2025-03-29 20:51:49 -05:00 committed by GitHub
parent aae70b9eeb
commit 4ed6e41b0c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/walkthrough.md
View File

@ -74,7 +74,7 @@ mise use cargo:starship
## Upgrading Dev Tools ## Upgrading Dev Tools
Upgrading tool versions can be done with [`mise upgrade|up`](/cli/upgrade). By default, it will respect Upgrading tool versions can be done with [`mise up|upgrade`](/cli/upgrade). By default, it will respect
the version prefix in `mise.toml`. If a [lockfile](/configuration/settings#lockfile) exists, the version prefix in `mise.toml`. If a [lockfile](/configuration/settings#lockfile) exists,
mise will update `mise.lock` to the latest version of the tool with the prefix from `mise.toml`. mise will update `mise.lock` to the latest version of the tool with the prefix from `mise.toml`.
@ -143,7 +143,7 @@ Or in a `mise-tasks` directory as a standalone file, such as `mise-tasks/build`:
npm run build npm run build
``` ```
Tasks are executed with [`mise run|r`](/cli/run): Tasks are executed with [`mise r|run`](/cli/run):
```bash ```bash
mise run build mise run build
@ -200,22 +200,22 @@ _See [Tasks](/tasks/) for more information on working with tasks._
Since there are a lot of commands available in mise, here are what I consider the most important: Since there are a lot of commands available in mise, here are what I consider the most important:
- [`mise completion`](/cli/completion) – Set up completions for your shell. - [`mise completion`](/cli/completion) – Set up completions for your shell.
- [`mise config|cfg`](/cli/config) – A bunch of commands for working with `mise.toml` files via the CLI. - [`mise cfg|config`](/cli/config) – A bunch of commands for working with `mise.toml` files via the CLI.
- [`mise exec|x`](/cli/exec) – Execute a command in the mise environment without activating mise. - [`mise x|exec`](/cli/exec) – Execute a command in the mise environment without activating mise.
- [`mise generate|g`](/cli/generate) – Generates things like git hooks, task documentation, GitHub actions, and more for your project. - [`mise g|generate`](/cli/generate) – Generates things like git hooks, task documentation, GitHub actions, and more for your project.
- [`mise install|i`](/cli/install) – Install tools. - [`mise i|install`](/cli/install) – Install tools.
- [`mise link`](/cli/link) – Symlink a tool installed by some other means into the mise. - [`mise link`](/cli/link) – Symlink a tool installed by some other means into the mise.
- [`mise ls-remote`](/cli/ls-remote) – List all available versions of a tool. - [`mise ls-remote`](/cli/ls-remote) – List all available versions of a tool.
- [`mise ls`](/cli/ls) – Lists information about installed/active tools. - [`mise ls`](/cli/ls) – Lists information about installed/active tools.
- [`mise outdated`](/cli/outdated) – Informs you of any tools with newer versions available. - [`mise outdated`](/cli/outdated) – Informs you of any tools with newer versions available.
- [`mise plugin`](/cli/plugins) – Plugins can extend mise with new functionality like extra tools or environment variable management. Commonly, these are simply asdf/vfox plugins. - [`mise plugin`](/cli/plugins) – Plugins can extend mise with new functionality like extra tools or environment variable management. Commonly, these are simply asdf/vfox plugins.
- [`mise run|r`](/cli/run) – Run a task defined in `mise.toml` or `mise-tasks`. - [`mise r|run`](/cli/run) – Run a task defined in `mise.toml` or `mise-tasks`.
- [`mise self-update`](/cli/self-update) – Update mise to the latest version. Don't use this if you installed mise via a package manager. - [`mise self-update`](/cli/self-update) – Update mise to the latest version. Don't use this if you installed mise via a package manager.
- [`mise settings`](/cli/settings) – CLI access to get/set configuration settings. - [`mise settings`](/cli/settings) – CLI access to get/set configuration settings.
- [`mise uninstall|rm`](/cli/uninstall) – Uninstall a tool. - [`mise rm|uninstall`](/cli/uninstall) – Uninstall a tool.
- [`mise upgrade|up`](/cli/upgrade) – Upgrade tool versions. - [`mise up|upgrade`](/cli/upgrade) – Upgrade tool versions.
- [`mise use|u`](/cli/use) – Install and activate tools. - [`mise u|use`](/cli/use) – Install and activate tools.
- [`mise watch|w`](/cli/watch) – Watch for changes in a project and run tasks when they occur. - [`mise w|watch`](/cli/watch) – Watch for changes in a project and run tasks when they occur.
## Final Thoughts ## Final Thoughts