Skip to content
Critiq Docs

Search docs

Search documentation pages and rules

Overview

Critiq Documentation

Install the Critiq CLI, run deterministic checks locally or in CI, and inspect the public rule catalog.

Critiq is an open source static analysis CLI for developers who want high-signal review checks before code reaches production. Run npx @critiq/cli check from any repo: interactive terminals prompt to install the rules catalog when it is missing. Pin both packages in package.json for CI and repeatable local runs.

bash
npx @critiq/cli check .
npm install -D @critiq/cli @critiq/rules
npx @critiq/cli check . --base origin/main --head HEAD
Get startedBrowse rulesView repository
Install and scanAdd the CLI, run your first repository check, and read exit codes.Browse rulesFilter the generated OSS catalog by language, preset, and severity.Wire up CIUse critiq-action for pull request scans and inline review comments.Use with AI agentsInstall agent skills for Cursor, Claude Code, Codex, and Copilot.

#What is Critiq?

Critiq runs explicit rules and reports deterministic findings instead of opaque generated review comments. Every result is tied to a rule id, a concrete location, and a repeatable execution model you can use locally and in CI.

#How does it fit into review?

Developers run Critiq before or alongside human review. The same rule set can run again in CI so the signal stays consistent between a workstation and a branch protection check.

#What's new

  • Dedicated secret-pattern audit: critiq audit secrets with --staged and diff scope. See the Audit Secrets guide.
  • --format sarif and --format html exports on critiq check for security platforms and review handoff.
  • Polyglot rule parity for Go, Java, PHP, Python, Ruby, and Rust on top of the deeper TypeScript and JavaScript catalog.
  • Official GitHub Action for PR checks: GitHub Actions guide.
  • Shipped and pending updates on the Changelog timeline.

#What does Critiq check?

1243generated OSS rules
172rule categories
10language surfaces

The public catalog covers security, correctness, performance, maintainability, and quality checks. TypeScript and JavaScript have the deepest support today, with narrower phase-one adapters for Go, Java, PHP, Python, Ruby, and Rust.

#What is in the OSS release?

The open source distribution includes the CLI, public rule catalog, configuration support, rule inspection, and the command surface needed to validate and test rules. These docs follow that workflow: install, scan, configure, browse rules, and read each CLI command.

#Packages

  • @critiq/cli provides the command surface.
  • @critiq/rules provides the public OSS rule catalog.

#Next steps

Install and scanConfigure CritiqCLI reference