Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

status

Change an ADR's status.

Usage

adrs status <NUMBER> <STATUS>
adrs status <NUMBER> superseded --by <NUMBER>

Arguments

ArgumentDescription
NUMBERThe ADR number to update
STATUSNew status value

Options

OptionDescription
--by <NUMBER>For 'superseded' status: the ADR number that supersedes this one

Standard Statuses

  • proposed - Decision is proposed but not yet accepted
  • accepted - Decision has been accepted
  • deprecated - Decision is deprecated but not replaced
  • superseded - Decision has been replaced by another ADR

You can also use custom status values for your workflow (e.g., draft, rejected, on-hold).

Examples

Accept a proposed ADR

adrs status 5 accepted

Deprecate an ADR

adrs status 3 deprecated

Supersede an ADR

When superseding, use --by to create a bidirectional link:

adrs status 2 superseded --by 5

This updates ADR 2's status and creates links:

Custom status

adrs status 4 "on-hold"

Notes

  • The status command updates the ADR file in place
  • For superseded status, using --by is recommended to maintain traceability
  • Status values are case-insensitive when parsing but preserved as written