Installation¶
Choose the installation method that works best for your workflow.
Package Managers¶
# Install globally
npm install -g rumdl
# Or as a project dev dependency
npm install --save-dev rumdl
# Or run without installing
npx rumdl check .
The npm package pulls in a prebuilt binary for your platform (Linux, macOS
and Windows), so nothing is compiled on install. The rumdl command it
installs is a small Node wrapper that runs that binary, and it needs
Node.js 18 or newer.
Platform-Specific¶
Download Binary¶
Download pre-built binaries from GitHub Releases.
# Linux x86_64
curl -LsSf https://github.com/rvben/rumdl/releases/latest/download/rumdl-linux-x86_64.tar.gz | tar xzf - -C /usr/local/bin
# macOS x86_64
curl -LsSf https://github.com/rvben/rumdl/releases/latest/download/rumdl-darwin-x86_64.tar.gz | tar xzf - -C /usr/local/bin
# macOS ARM64 (Apple Silicon)
curl -LsSf https://github.com/rvben/rumdl/releases/latest/download/rumdl-darwin-arm64.tar.gz | tar xzf - -C /usr/local/bin
Verify Installation¶
VS Code Extension¶
Install the VS Code extension for real-time linting:
See VS Code Integration for more details.
Next Steps¶
- Quick Start - Get started with rumdl
- CLI Commands - Learn all available commands
- Configuration - Customize rumdl for your project