rumdl 0.1.70

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

---
icon: lucide/download
---

# Installation

Choose the installation method that works best for your workflow.

## Package Managers

=== "Homebrew"

    ```bash
    brew install rvben/tap/rumdl
    ```

=== "Cargo"

    ```bash
    cargo install rumdl
    ```

=== "pip"

    ```bash
    pip install rumdl
    ```

=== "uv"

    ```bash
    # Install as a tool
    uv tool install rumdl

    # Or run without installing
    uvx rumdl check .
    ```

=== "mise"

    ```bash
    # List available versions
    mise ls-remote rumdl

    # Install the latest version
    mise install rumdl

    # Use a specific version for the project
    mise use rumdl@latest
    ```

=== "Nix"

    ```bash
    nix-channel --update
    nix-env --install --attr nixpkgs.rumdl
    ```

    Or use flakes to run without installation:

    ```bash
    nix run nixpkgs#rumdl -- --version
    ```

## Platform-Specific

=== "Arch Linux"

    ```bash
    pacman -S rumdl
    ```

=== "Android (Termux)"

    ```bash
    # Enable TUR repo first
    pkg install tur-repo

    # Then install rumdl
    pkg install rumdl
    ```

## Download Binary

Download pre-built binaries from [GitHub Releases](https://github.com/rvben/rumdl/releases/latest).

=== "Linux / macOS"

    ```bash
    # 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
    ```

=== "Windows"

    ```powershell
    # PowerShell
    Invoke-WebRequest -Uri "https://github.com/rvben/rumdl/releases/latest/download/rumdl-windows-x86_64.zip" -OutFile "rumdl.zip"
    Expand-Archive -Path "rumdl.zip" -DestinationPath "$env:USERPROFILE\.rumdl"
    # Add to PATH manually
    ```

## Verify Installation

```bash
rumdl --version
```

## VS Code Extension

Install the VS Code extension for real-time linting:

```bash
# Install the extension
rumdl vscode

# Check installation status
rumdl vscode --status
```

See [VS Code Integration](../vscode-extension.md) for more details.

## Next Steps

- [Quick Start](quickstart.md) - Get started with rumdl
- [CLI Commands](../usage/cli.md) - Learn all available commands
- [Configuration](../global-settings.md) - Customize rumdl for your project