Skip to content

Rule schema

Auto-generated from the dataclasses in kuroi.core.rules. This page is the source of truth for what a rule pack YAML file may contain. The Writing rule packs guide walks through using these fields end-to-end.

RuleSet

Field Type Description
name str
display_name str
description str
version int
categories tuple[Category, ...]

Category

Field Type Description
id str
label str
detection DetectionKind
confidence Confidence
pattern str | None
model str | None

Refer to kuroi.core.rules for the live definitions and helper functions (load_rule_set, apply_regex_rules).