mise/docs/registry.md

3.1 KiB

editLink
false

Registry

List of all tools aliased by default in mise.

You can use these shorthands with mise use. This allows you to use a tool without needing to know the full name. For example, to use the aws-cli tool, you can do the following:

mise use aws-cli

instead of

mise use aqua:aws/aws-cli

If a tool is not available in the registry, you can install it by its full name. ubi and aqua give you for example access to almost all programs available on GitHub.

Backends

In addition to built-in core tools, mise supports a variety of backends to install tools.

In general, the preferred backend to use for new tools is the following:

  • aqua - offers the most features and security while not requiring plugins
  • ubi - Universal Binary Installer, offers a simple way to install tools from any GitHub/GitLab repo
  • pipx - only for python tools, requires python to be installed but this generally would always be the case for python tools
  • npm - only for node tools, requires node to be installed but this generally would always be the case for node tools
  • vfox - only for tools that have unique installation requirements or need to modify env vars
  • asdf - only for tools that have unique installation requirements or need to modify env vars, doesn't support windows
  • go - only for go tools, requires go to be installed to compile. Because go tools can be distributed as a single binary, aqua/ubi are definitely preferred.
  • cargo - only for rust tools, requires rust to be installed to compile. Because rust tools can be distributed as a single binary, aqua/ubi are definitely preferred.
  • dotnet - only for dotnet tools, requires dotnet to be installed to compile. Because dotnet tools can be distributed as a single binary, aqua/ubi are definitely preferred.

Backends Priority

Each tool can define its own priority if it has more than one backend it supports. If you would like to disable a backend, you can do so with the following command:

mise settings disable_backends=asdf

This will disable the asdf backend. See Aliases for a way to set a default backend for a tool. Note that the asdf backend is disabled by default on Windows.

You can also specify the full name for a tool using mise use aqua:1password/cli if you want to use a specific backend.

Source: https://github.com/jdx/mise/blob/main/registry.toml

Tools

Note that mise registry can be used to list all tools in the registry. mise use without any arguments will show a tui to select a tool to install.