mise/man/man1/mise.1

201 lines
4.9 KiB
Groff

.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH mise 1 "mise 2024.9.8"
.SH NAME
mise \- The front\-end to your dev env
.SH SYNOPSIS
\fBmise\fR [\fB\-C\fR|\fB\-\-cd\fR] [\fB\-P\fR|\fB\-\-profile\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
.SH DESCRIPTION
mise is a tool for managing runtime versions. https://github.com/jdx/mise
.PP
It\*(Aqs a replacement for tools like nvm, nodenv, rbenv, rvm, chruby, pyenv, etc.
that works for any language. It\*(Aqs also great for managing linters/tools like
jq and shellcheck.
.PP
It is inspired by asdf and uses asdf\*(Aqs plugin ecosystem under the hood:
https://asdf\-vm.com/
.SH OPTIONS
.TP
\fB\-C\fR, \fB\-\-cd\fR=\fIDIR\fR
Change directory before running command
.TP
\fB\-P\fR, \fB\-\-profile\fR=\fIPROFILE\fR
Set the profile (environment)
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Suppress non\-error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Show extra output (use \-vv for even more)
.TP
\fB\-y\fR, \fB\-\-yes\fR
Answer yes to all confirmation prompts
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version
.SH SUBCOMMANDS
.TP
mise\-activate(1)
Initializes mise in the current shell session
.TP
mise\-alias(1)
Manage aliases
.TP
mise\-backends(1)
Manage backends
.TP
mise\-bin\-paths(1)
List all the active runtime bin paths
.TP
mise\-cache(1)
Manage the mise cache
.TP
mise\-completion(1)
Generate shell completions
.TP
mise\-config(1)
[experimental] Manage config files
.TP
mise\-current(1)
Shows current active and installed runtime versions
.TP
mise\-deactivate(1)
Disable mise for current shell session
.TP
mise\-direnv(1)
Output direnv function to use mise inside direnv
.TP
mise\-doctor(1)
Check mise installation for possible problems
.TP
mise\-env(1)
Exports env vars to activate mise a single time
.TP
mise\-exec(1)
Execute a command with tool(s) set
.TP
mise\-generate(1)
[experimental] Generate files for various tools/services
.TP
mise\-implode(1)
Removes mise CLI and all related data
.TP
mise\-install(1)
Install a tool version
.TP
mise\-latest(1)
Gets the latest available version for a plugin
.TP
mise\-link(1)
Symlinks a tool version into mise
.TP
mise\-ls(1)
List installed and active tool versions
.TP
mise\-ls\-remote(1)
List runtime versions available for install
.TP
mise\-outdated(1)
Shows outdated tool versions
.TP
mise\-plugins(1)
Manage plugins
.TP
mise\-prune(1)
Delete unused versions of tools
.TP
mise\-registry(1)
[experimental] List available tools
.TP
mise\-reshim(1)
rebuilds the shim farm
.TP
mise\-run(1)
[experimental] Run a tasks
.TP
mise\-self\-update(1)
Updates mise itself
.TP
mise\-set(1)
Manage environment variables
.TP
mise\-settings(1)
Manage settings
.TP
mise\-shell(1)
Sets a tool version for the current session
.TP
mise\-sync(1)
Add tool versions from external tools to mise
.TP
mise\-tasks(1)
[experimental] Manage tasks
.TP
mise\-trust(1)
Marks a config file as trusted
.TP
mise\-uninstall(1)
Removes runtime versions
.TP
mise\-unset(1)
Remove environment variable(s) from the config file
.TP
mise\-upgrade(1)
Upgrades outdated tool versions
.TP
mise\-usage(1)
Generate a usage CLI spec
.TP
mise\-use(1)
Install tool version and add it to config
.TP
mise\-version(1)
Show mise version
.TP
mise\-watch(1)
[experimental] Run a tasks watching for changes
.TP
mise\-where(1)
Display the installation path for a runtime
.TP
mise\-which(1)
Shows the path that a bin name points to
.TP
mise\-help(1)
Print this message or the help of the given subcommand(s)
.SH EXTRA
Examples:
$ mise install node@20.0.0 Install a specific node version
$ mise install node@20 Install a version matching a prefix
$ mise install node Install the node version defined in config
$ mise install Install all plugins/tools defined in config
$ mise install cargo:ripgrep Install something via cargo
$ mise install npm:prettier Install something via npm
$ mise use node@20 Use node\-20.x in current project
$ mise use \-g node@20 Use node\-20.x as default
$ mise use node@latest Use latest node in current directory
$ mise use \-g node@system Use system node everywhere unless overridden
$ mise up \-\-interactive Show a menu to upgrade tools
$ mise x \-\- npm install `npm install` w/ config loaded into PATH
$ mise x node@20 \-\- node app.js `node app.js` w/ config + node\-20.x on PATH
$ mise set NODE_ENV=production Set NODE_ENV=production in config
$ mise run build Run `build` tasks
$ mise watch build Run `build` tasks repeatedly when files change
$ mise settings Show settings in use
$ mise settings set color 0 Disable color by modifying global config file
.SH VERSION
v2024.9.8
.SH AUTHORS
Jeff Dickey <@jdx>