Installation
muxa can be installed globally using your preferred package manager.
Package Managers
bun install -g @den-ai/muxa
npm install -g @den-ai/muxa
pnpm add -g @den-ai/muxa
yarn global add @den-ai/muxa
Requirements
- Node.js >= 16.0.0
- mprocs (automatically installed as dependency)
Verify Installation
After installation, verify that muxa is available:
muxa --version
You should see the version number displayed.
Platform Support
muxa works on:
- ✅ macOS
- ✅ Linux
- ✅ Windows (with WSL)
Note for Windows users: muxa relies on Unix-style shell commands. For the best experience on Windows, use WSL (Windows Subsystem for Linux).
Troubleshooting
Command not found
If you get a "command not found" error after installation, you may need to add the global bin directory to your PATH:
# Find npm global bin directory
npm bin -g
# Add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
export PATH="$PATH:$(npm bin -g)"
# Find yarn global bin directory
yarn global bin
# Add to your shell profile
export PATH="$PATH:$(yarn global bin)"
# Find pnpm global bin directory
pnpm bin -g
# Add to your shell profile
export PATH="$PATH:$(pnpm bin -g)"
Permission errors
If you encounter permission errors during global installation:
- Recommended: Configure npm to use a different directory for global packages
- Alternative: Use a Node version manager like nvm, fnm, or volta
- Not recommended: Use sudo (can cause permission issues later)
Next Steps
Once installed, check out the Getting Started guide to learn how to use muxa.