Skip to content
Rigor

The Rigor User Manual

How to install, run, configure, and operate Rigor. Where the handbook teaches the type model — what carriers Rigor infers and why — this manual is the operational reference: the command line, the configuration file, the diagnostic catalogue, and the workflows for adopting Rigor on a real project.

The two are companions. Reach for the handbook to understand what a diagnostic means; reach for the manual to look up the flag, key, or command that acts on it.

Contents

Section titled “Contents”

Getting started

Section titled “Getting started”
  1. Installing Rigor — mise, asdf, gem install, Nix, and the dev-container guidance. Rigor is a tool, not a project dependency.
  2. Rigor for Rails — step-by-step setup with mise — install Ruby 4.0 + Rigor via mise, activate the Rails plugin set, run rigor check, and share the config with your team in about ten minutes.

Reference

Section titled “Reference”
  1. CLI command reference — every subcommand (check, annotate, type-of, sig-gen, baseline, triage, lsp, …), its flags, and its exit codes.
  2. Configuration — the .rigor.yml key reference, config discovery, and includes: layering.
  3. Diagnostics — the rule-ID catalogue, severity profiles, and # rigor:disable suppression.
  4. Inspecting inferred types — the assert_type / dump_type source helpers and the rigor annotate / rigor type-of commands.

Adopting Rigor on a project

Section titled “Adopting Rigor on a project”
  1. Baselines — .rigor-baseline.yml, the rigor baseline subcommands, and rigor triage.
  2. Using plugins — activating framework and gem plugins through the plugins: config key. Per-plugin user docs live under Plugin reference.
  3. Provided skills — the bundled Agent Skills for onboarding and baseline reduction.

Integration and operations

Section titled “Integration and operations”
  1. Editor integration — wiring rigor lsp into Neovim, VS Code, Helix, and Emacs.
  2. MCP server — exposing Rigor’s analysis tools to AI coding agents (Claude Code, Cursor, Cline, …) via rigor mcp.
  3. Running Rigor in CI — a clean CI job, a minimal GitHub Actions workflow, and version pinning.
  4. Caching — where the cache lives, what invalidates it, and how to clear it.
  5. Troubleshooting — common problems and their fixes.

See also

Section titled “See also”

© 2026 TypedDuck. Licensed under CC BY-SA 4.0.