Start
Install the CLI
Install the cumaru binary once per machine. At the end, cumaru --version prints the installed version.
Before you start
- macOS or Linux, on ARM64 or x86_64.
- Bash, cURL, and Git on your
PATH. - Linux ARM64 needs a CPU with FP16 instruction support.
- For npm: Node.js 18 or later. Windows is not supported.
1. Install
Choose one method. Keep only one installation on your machine.
Script
curl -fsSL https://raw.githubusercontent.com/rntgspr/cumaru/main/src/install.sh | bash Installs to /usr/local/bin and may ask for sudo.
Homebrew
brew install rntgspr/tap/cumaru Brew then owns upgrades and removal.
npm
npm install --global @cumaru/cumaru Needs Node.js 18 or later. npm then owns upgrades and removal.
npm without a global install
Run the CLI once with npx, or pin it as a project dev dependency.
npx @cumaru/cumaru help npm install --save-dev @cumaru/cumaru
npx cumaru doctor The package is a thin wrapper. npm installs only the binary for your OS and CPU.
2. Check the install
cumaru --version The command prints the build version. cumaru help lists every command.
Troubleshooting
- A different cumaru runs:
type -a cumarushows every copy on yourPATH. Remove or reorder the older one yourself. - Upgrades: with the script, run
cumaru upgrade --check, thencumaru upgrade. With Homebrew, runbrew upgrade rntgspr/tap/cumaru; barecumaru upgradeis blocked. With npm, runnpm update --global @cumaru/cumaru. - Prebuilt assets: download them from GitHub Releases if you cannot run the installer.
Next
Sources: README, upgrade, Homebrew packaging, cumaru-node README, npm package at revision 37ad79f.