Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mulerun.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The CLI is published to npm as @mulerunai/cli. It bundles the right native binary for your platform automatically (macOS arm64/x64, Linux arm64/x64). Node.js 20+ is required.

​
Global install

The recommended setup. The mulerun binary becomes available everywhere on your PATH. 
npm install -g @mulerunai/cli
Verify the install: 
mulerun --version
mulerun --help

​
Run on demand

For one-off use, run through npx or bunx without installing: 
npx -y @mulerunai/cli --version
npx -y @mulerunai/cli login
bunx @mulerunai/cli computer list
The package is cached locally; subsequent invocations reuse the same install.

​
Per-project install

If you want the version pinned to a single repository (recommended for CI): 
npm install --save-dev @mulerunai/cli
Then call it through your package runner: 
npx mulerun computer list

​
Upgrading

The CLI can upgrade itself in place: 
mulerun upgrade           # install latest
mulerun upgrade --check   # only print current vs latest
It will also auto-upgrade in the background on routine commands unless you opt out: 
export MULERUN_NO_AUTO_UPGRADE=1
See the upgrade command page for full details.

​
Uninstall

npm uninstall -g @mulerunai/cli
# or
bun remove -g @mulerunai/cli

​
Next step

Head to Configuration to set your token and any optional proxy or base URL.