new

Create a new Architecture Decision Record.

Usage

adrs new [OPTIONS] <TITLE>

Argument	Description
`<TITLE>`	Title of the new ADR

Option	Description
`-f, --format <FORMAT>`	Template format: `nygard` or `madr` (default: `nygard`)
`-v, --variant <VARIANT>`	Template variant: `full`, `minimal`, or `bare` (default: `full`)
`--status <STATUS>`	Initial status (default: `Proposed`)
`-s, --supersedes <N>`	ADR number(s) this supersedes
`-l, --link <LINK>`	Link to another ADR
`--ng`	Use NextGen mode (YAML frontmatter)
`-C, --cwd <DIR>`	Working directory
`-h, --help`	Print help

Creates a new ADR file with the next available number. Opens your $EDITOR to edit the document. The ADR is saved when you close the editor.

adrs new "Use PostgreSQL for persistence"

Creates 0002-use-postgresql-for-persistence.md and opens it in your editor.

adrs new --format madr "Use PostgreSQL for persistence"

adrs new --variant minimal "Use PostgreSQL for persistence"

adrs new --status Accepted "Use PostgreSQL for persistence"

adrs new --supersedes 2 "Use MySQL instead of PostgreSQL"

This creates a new ADR and:

adrs new --supersedes 2 --supersedes 3 "Consolidated database decision"

adrs new --link "2:Amends:Amended by" "Clarify database choice"

The link format is TARGET:KIND:REVERSE_KIND:

Common link types:

adrs new --link "2:Amends:Amended by" --link "3:Extends:Extended by" "Combined decision"

adrs new --ng --format madr "Use PostgreSQL for persistence"

Creates an ADR with YAML frontmatter:

---
status: proposed
date: 2024-01-15
---

# Use PostgreSQL for Persistence

## Context and Problem Statement
...

The new command uses the $EDITOR environment variable. If not set, it tries common editors:

Set your preferred editor:

export EDITOR="code --wait"  # VS Code
export EDITOR="nano"         # Nano
export EDITOR="vim"          # Vim

ADR files are named using the pattern:

NNNN-title-in-kebab-case.md

Where:

Examples: