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

edit

Edit an existing Architecture Decision Record.

Usage

adrs edit [OPTIONS] <ADR>

Arguments

ArgumentDescription
<ADR>ADR to edit (number or search term)

Options

OptionDescription
--ngUse NextGen mode
-C, --cwd <DIR>Working directory
-h, --helpPrint help

Description

Opens an existing ADR in your editor. The ADR can be specified by:

  • Number (e.g., 1, 12)
  • Partial title match (fuzzy search)

Examples

By Number

adrs edit 1

Opens 0001-record-architecture-decisions.md in your editor.

By Title

adrs edit postgresql

Finds and opens the ADR with "postgresql" in its title.

Fuzzy Matching

adrs edit "database"

Opens the best matching ADR containing "database".

Editor

Uses the $EDITOR environment variable. See new for configuration.

  • new - Create a new ADR
  • list - List ADRs to find the one to edit