Adrkit Validate

Use when checking whether ADR files follow the ADR Kit format, especially before accepting a proposal or committing.

luochang212 Updated
ADR Kit

File contents

ADR Kit Validate

Overview

Run the machine checks for one record or the whole repository.

Steps

adrkit validate [name] [--all] [--json]
  • With no name, the whole repository is validated.
  • name resolves by title, file name, or decision number.

Rules

  • Treat any non-OK output as a blocker for adrkit accept.
  • adrkit validate checks durable decisions only; a draft in adr/.drafts/ is validated by adrkit accept right before it is promoted.

luochang212/adr-kit commit f110955800

Frequently asked questions

npx get-skill add luochang212/adrkit-validate