Skip to main content

Module rules

Module rules 

Source
Expand description

.caliban/rules/<topic>.md — path-scoped rule files with optional paths: glob frontmatter.

Part of ADR 0036. Rules behave like miniature CLAUDE.md addendums that the agent activates lazily once the model touches a matching file (or eagerly at startup when paths: is absent).

Structs§

Rule
A loaded rule file (frontmatter parsed; body raw).
RuleSet
A set of loaded rules with a pre-built GlobSet for fast path matching.

Enums§

RuleScope
Whether the rule was loaded from the user dir (~/.caliban/rules/) or the project dir (<workspace>/.caliban/rules/).

Functions§

scan_caliban_rules
Scan both the user dir (~/.caliban/rules/) and the project dir (<workspace>/.caliban/rules/) for *.md rule files. Malformed files are skipped with a warning.