documentation

English · Español

becwright documentation

Documentation for becwright. For the project overview, see the main README. Every page starts with a plain-language summary and then goes deeper, so you can stop wherever it stops being useful to you — no prior background assumed.

Start here

• Usage — install, the commands, and how to write a rule. Read this first.
• Recipes — copy-paste rules for common jobs: gitleaks/ruff/semgrep as checks, frozen paths, architecture boundaries, CI, Husky.
• Writing checks — the no-code forbid shortcut, then custom checks in any language.
• Portability — share a rule between projects with export/import.

Go deeper

• Architecture — how becwright works inside and the exact check flow.
• MCP & JSON output — structured results for AI agents (check --json, the MCP server).

Maintainers

• Releasing — how the npm + PyPI release is built and published.