Usage

rsspell is easy to use from the command line. Below are the most common commands and flags.

Scanning for Typos

To scan all Markdown and SVG files in the current directory (and its subdirectories):

rsspell scan

To scan a specific directory or file:

rsspell scan path/to/your/files

To specify a language (e.g., for installed dictionaries):

rsspell scan --lang de-DE

To ignore specific words via the command line:

rsspell scan --ignore word1 word2

.rsspellignore File

You can also create a .rsspellignore file in the root of your project to skip words automatically. Each line should contain one word to ignore. Lines starting with # are treated as comments.

Example .rsspellignore:

# Project-specific technical terms
rsspell
zspell
veltzer

Managing Dictionaries

rsspell includes a built-in en-US dictionary. You can manage additional dictionaries with the dicts subcommand.

List Installed Dictionaries

rsspell dicts list

List Dictionaries Available for Download

rsspell dicts list-remote

Install a New Dictionary

To install a dictionary from the wooorm/dictionaries repository:

rsspell dicts install de-DE

Show Dictionary Path

To see where dictionaries are stored on your system:

rsspell dicts path

Other Commands

Show Version Information

rsspell version

Generate Shell Completions

rsspell complete <SHELL>

Where <SHELL> is one of bash, elvish, fish, powershell, or zsh.