Developer documentation
The groundrule CLI, the agent files it writes, the MCP server for coding agents, the rule format, and every command and option. The CLI is open source and works offline; connecting it to your organization adds the shared rulebook.
Connect and run
Section titled “Connect and run”Install the CLInpx, a global install, or a project dependency; Node.js 22 or later.
QuickstartSign in, connect a repository, sync agent files and run your first check.
Check your changesChanged lines or the whole repository, baselines, exit codes, output formats.
Run it in CIGitHub Actions, GitLab CI and any other runner, with a token.
Coding agents
Section titled “Coding agents”Agent instruction filesWhat sync writes into AGENTS.md, CLAUDE.md, Cursor and Copilot, and what it never touches.
The MCP serverlist_standards and propose_rule for Claude Code, Cursor, VS Code and any MCP client.
Rules as code
Section titled “Rules as code”The rule formatEvery field of a standard, with examples, scope and agent wording.
Checksregex, files, dependencies, change-set and semgrep, with their options.
Overrides and exceptionsTune pack rules in a repository, and record the code a rule doesn't apply to.
PacksEvery bundled pack and the standards in it.
Reference
Section titled “Reference”Command referenceEvery command and option, with exit codes.
Configuration.groundrule/config.yaml, field by field.
Environment and filesGROUNDRULE_TOKEN, GROUNDRULE_URL, where credentials live.
Output formatsTerminal, JSON, SARIF and Markdown reports.