Configuration

.rqtk/config.toml sets the project’s vocabulary and policy. rqtk init writes a starting point; rqtk schema config prints the JSON Schema.

Fields

Field	Type	Required	Description
`categories`	table of `Category`	yes
`criticality`	`CriticalityPolicy`	yes
`identification`	`IdentificationScheme`	yes
`lifecycle`	`LifecyclePolicy`	yes
`priority`	`PriorityPolicy`	yes
`project`	`ProjectMeta`	yes
`repository`	`RepositoryLayout`
`scan`	`ScanConfig`
`schema_version`	integer	yes	File format version; must equal the version supported by this build of rqtk.
`standards`	list of `Standard`
`types`	`TypePolicy`	yes
`validation`	`ValidationRules`	yes
`verification`	`VerificationPolicy`	yes

Category

Field	Type	Required	Description
`description`	string (optional)
`is_root`	boolean		Marks this category as a traceability root. At least one category should set this to `true` for orphan detection to work.
`level`	integer	yes
`name`	string	yes

CriticalityPolicy

Field	Type	Required	Description
`levels`	list of string	yes

IdentificationScheme

Field	Type	Required	Description
`id_pattern`	string (optional)		Regular expression every requirement ID must match (RQ001). When omitted, it is derived from `prefix`, `id_separator`, the category keys and `zero_padding`, so a new category needs no pattern change.
`id_separator`	string
`prefix`	string
`zero_padding`	integer

LifecyclePolicy

Field	Type	Required	Description
`default_state`	string	yes
`states`	list of string	yes

PriorityPolicy

Field	Type	Required	Description
`levels`	list of string	yes

ProjectMeta

Field	Type	Required	Description
`classification`	string (optional)
`created`	string (optional)
`description`	string (optional)
`mission_phase`	string (optional)
`name`	string	yes
`organization`	`ProjectOrganization` (optional)
`risk_posture`	string (optional)
`short_name`	string (optional)
`updated`	string (optional)
`version`	string	yes

RepositoryLayout

Field	Type	Required	Description
`needs_dir`	string
`required_dirs`	list of string
`required_files`	list of string
`requirements_dir`	string
`stakeholders_dir`	string

ScanConfig

Where rqtk scan looks for verifies annotations in source code.

Field	Type	Required	Description
`exclude`	list of string		Glob patterns (gitignore syntax) to skip, e.g. `"tests/fixtures/**"`.
`extensions`	list of string		File extensions to read.
`paths`	list of string		Directories to scan, relative to the repository root. `.gitignore` is honoured.

Standard

Field	Type	Required	Description
`id`	string	yes
`revision`	string (optional)
`title`	string	yes

TypePolicy

Field	Type	Required	Description
`allowed`	list of string	yes

ValidationRules

Field	Type	Required	Description
`allow_tbd`	boolean	yes
`allow_tbr`	boolean	yes
`forbid_circular_traces`	boolean	yes
`forbid_orphans`	boolean	yes
`forbidden_keywords`	list of string
`require_parent_for_categories`	list of string		Category keys whose requirements must have at least one parent (RQ012). `require_parent_for_levels` is accepted as an older name.
`require_rationale`	boolean	yes
`require_verification_method`	boolean	yes
`shall_keywords`	list of string

VerificationPolicy

Field	Type	Required	Description
`levels`	list of string	yes
`methods`	list of string	yes
`phases`	list of string	yes

ProjectOrganization

Field	Type	Required	Description
`center`	string (optional)
`cognizant_authority`	string (optional)
`program`	string (optional)
`responsible_engineer`	string (optional)