Developer Resources · CLI
Install the CLI
Install monime on macOS, Linux or Windows, keep it up to date and turn on shell completion.
Each release of the Monime CLI is published for macOS, Linux and Windows, on both amd64 and arm64. The install scripts download the release for your platform, check it against the release's SHA-256 checksums, and install it without needing administrator rights.
Install
curl -fsSL https://cli.monime.io/install.sh | shThe script installs monime to ~/.local/bin. If that folder is not on your PATH, it adds it in your shell's startup file (~/.zshrc, ~/.bashrc, ~/.bash_profile on macOS, fish's conf.d, or ~/.profile). Set MONIME_NO_MODIFY_PATH=1 to leave your startup files alone.
In PowerShell:
irm https://cli.monime.io/install.ps1 | iexThe script installs monime.exe to %LOCALAPPDATA%\Programs\monime and adds that folder to your user PATH.
Download the archive for your platform from the latest release, extract it and put monime (or monime.exe) on your PATH.
Each release lists its SHA-256 checksums in monime_<version>_checksums.txt, so you can verify the download yourself.
Choose a version or folder
Both install scripts read MONIME_VERSION and MONIME_INSTALL_DIR:
curl -fsSL https://cli.monime.io/install.sh \
| MONIME_VERSION=0.1.0 MONIME_INSTALL_DIR="$HOME/bin" sh$env:MONIME_VERSION = "0.1.0"
$env:MONIME_INSTALL_DIR = "C:\tools\monime"
irm https://cli.monime.io/install.ps1 | iexCheck the installation
Open a new terminal so your updated PATH is picked up, then run:
monime versionUpdate
The CLI tells you when a new release is out. To update, run:
monime updatemonime update downloads the release, checks it against the release's checksums, and then replaces itself.
| Command | What it does |
|---|---|
monime update | Update to the latest release |
monime update --check | Only check whether a newer release is available |
monime update --version 0.1.0 | Install a specific version |
Shell completion
monime completion prints a completion script for your shell, so you can press Tab to complete commands, flags and arguments.
# This session only
source <(monime completion zsh)
# Every new session (macOS with Homebrew)
monime completion zsh > $(brew --prefix)/share/zsh/site-functions/_monime
# Every new session (Linux)
monime completion zsh > "${fpath[1]}/_monime"# This session only
source <(monime completion bash)
# Every new session (macOS with Homebrew)
monime completion bash > $(brew --prefix)/etc/bash_completion.d/monime
# Every new session (Linux)
monime completion bash > /etc/bash_completion.d/monime# This session only
monime completion fish | source
# Every new session
monime completion fish > ~/.config/fish/completions/monime.fishmonime completion powershell | Out-String | Invoke-ExpressionTo load completion in every session, add that line to your PowerShell profile.
Start a new shell for the setup to take effect.