mise plugins install
- Usage:
mise plugins install [FLAGS] [NEW_PLUGIN] [GIT_URL] - Aliases:
i,a,add - Effect: modifies state
- Source code:
src/cli/plugins/install.rs
Install plugins from a configured source, Git URL, or archive
Most registry tools use built-in backends and need no plugin. When a tool's backend requires a plugin, mise installs it with the tool. Use this command to install one ahead of time or from a custom source.
Pass a name that the registry or a [plugins] entry knows, a name and a URL, or only a URL. With only a URL, the plugin is named after the repository without an asdf-, mise-, or vfox- prefix. Pass several names to install several plugins. Prefix a name with vfox:, vfox-backend:, package:, or asdf: to choose the plugin type.
A Git URL may end in #ref to select a plugin commit, tag, or branch. This selects the plugin code, separately from the tool version mise use installs.
Arguments
[NEW_PLUGIN]— The plugin to install, or a URL to infer its name from[GIT_URL]— Where to install from: a Git URL (optionally ending in #ref) or an archive URL
Flags
-a --all— Install every plugin the current config needs that is not installed yetOnly plugins with a registry shorthand or a
[plugins]entry can be installed this way.-f --force— Reinstall even if the plugin is already installed-j --jobs <JOBS>— Number of plugins to install in parallel (default: thejobssetting)-v --verbose— Show installation output-h --help— Print help
Examples
Install a plugin from a Git repository
mise plugins install my-tool https://github.com/your-org/mise-my-toolPin the plugin to a tag
mise plugins install my-tool 'https://github.com/your-org/mise-my-tool#v1.2.0'Name the plugin after its repository (my-tool)
mise plugins install https://github.com/your-org/vfox-my-toolUse a local plugin repository at a tag you created
mise plugins install my-tool file:///path/to/mise-my-tool#v1.0.0Install the plugins that the current config needs
mise plugins install --all