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

template

Manage ADR templates.

Usage

adrs template <COMMAND>

Subcommands

CommandDescription
listList available templates
showShow a template's content

list

List all available template formats and variants.

adrs template list

Output:

Available templates:

nygard (default)
  Variants: full (default), minimal, bare

madr
  Variants: full (default), minimal, bare

show

Display the content of a specific template.

adrs template show <FORMAT> [--variant <VARIANT>]

Options

OptionDescription
-v, --variant <VARIANT>Template variant: full, minimal, bare

Examples

# Show default Nygard template (full variant)
adrs template show nygard

# Show minimal MADR template
adrs template show madr --variant minimal

# Show bare template
adrs template show nygard --variant bare

Template Formats

Nygard (Classic)

The original ADR format by Michael Nygard with sections:

  • Status
  • Context
  • Decision
  • Consequences

MADR 4.0.0

Markdown Any Decision Record format with additional sections:

  • Status
  • Deciders
  • Date
  • Context and Problem Statement
  • Decision Drivers
  • Considered Options
  • Decision Outcome
  • Consequences

Template Variants

VariantDescription
fullComplete template with all sections and guidance
minimalEssential sections only
bareMinimal structure, just headings

See Also

  • new - Create ADRs using templates
  • Templates - Template customization guide