bim-rules

Check a building model against generic multi-authority rulesets -- code, zoning, ADA, life safety, client and office standards. Pass site or model facts and a ruleset; get verdicts with measured vs required and a citation.

Verbs

Verb	What it does
bim rules describe	Describe the driver surface bim-cli can rely on.
bim rules doctor	Run driver self-checks and report whether the solver is healthy.
bim rules check [--facts <file>] [--site <file>] --ruleset <dir> [--floor-area <n>] [--accept-project-rules]	Check proposal or site facts against a ruleset and report verdicts.
bim rules entail [--facts <file>] [--site <file>] --ruleset <dir> [--accept-project-rules]	Derive a requirement envelope from site facts alone.
bim rules profile --ruleset <dir>	Report the extractor contract for a ruleset.
bim rules refresh-citations [--root <dir>]	Refresh citation snapshots and sha256 pins for shipped rulesets.

describe

bim rules describe

Describe the driver surface bim-cli can rely on.

doctor

bim rules doctor

Run driver self-checks and report whether the solver is healthy.

check

bim rules check [--facts <file>] [--site <file>] --ruleset <dir> [--floor-area <n>] [--accept-project-rules]

Check proposal or site facts against a ruleset and report verdicts.

• --facts <file> -- IR facts file; must be a path (not -) under JSON-RPC dispatch
• --site <file> -- site lookup result JSON; bim-site zoning.lookup output
• --ruleset <dir> (required) -- ruleset directory; pass base-first overlay-last
• --floor-area <n> -- proposed floor area in square feet
• --accept-project-rules -- apply a discovered sibling rules/rules.json project ruleset

entail

bim rules entail [--facts <file>] [--site <file>] --ruleset <dir> [--accept-project-rules]

Derive a requirement envelope from site facts alone.

• --facts <file> -- IR facts file; must be a path (not -) under JSON-RPC dispatch
• --site <file> -- site lookup result JSON
• --ruleset <dir> (required) -- ruleset directory
• --accept-project-rules -- apply a discovered sibling project ruleset

profile

bim rules profile --ruleset <dir>

Report the extractor contract for a ruleset.

• --ruleset <dir> (required) -- ruleset directory (exactly one)

refresh-citations

bim rules refresh-citations [--root <dir>]

Refresh citation snapshots and sha256 pins for shipped rulesets.

• --root <dir> -- repo root to scan; defaults to .