docs/cli/generate/install-script.md
mise generate install-scriptmise generate install-script [FLAGS]src/cli/generate/install_script.rsGenerate a script to download+execute mise
This is designed to be used in a project where contributors may not have mise installed.
Renamed from mise generate bootstrap, which read as a form of mise bootstrap (machine
setup). The old name still works but is deprecated and will be removed in mise 2027.9.0.
-l --localizeSandboxes mise internal directories like MISE_DATA_DIR and MISE_CACHE_DIR into a .mise directory in the project
This is necessary if users may use a different version of mise outside the project.
-V --version <VERSION>Specify mise version to fetch
-w --write [WRITE]instead of outputting the script to stdout, write to a file and make it executable
--localized-dir <LOCALIZED_DIR>Directory to put localized data into
Default: .mise
--windowsAlso write a Windows launcher, <WRITE>.cmd
Windows cannot execute the #!/usr/bin/env bash script, so a contributor who clones the
project on Windows has nothing to run without this.
Generated on every host, not only on Windows: the file is committed, and whoever runs it
on Windows is not the person who generated it. Requires --write, since stdout cannot
carry two files.
Examples:
$ mise generate install-script --write ./bin/mise
$ ./bin/mise install # downloads mise to .mise if not already installed
# add a launcher for contributors who clone the project on Windows
$ mise generate install-script --write ./bin/mise --windows # also writes bin/mise.cmd
$ .\bin\mise.cmd install