ADR(1)

✨ NAME ✨

Okay bestie, welcome to the adr manual page 💖 It's a tool for working with Architecture Decision Records (ADRs) and it is so good at it 💅

🦋 SYNOPSIS 🦋

adr command [...]

💖 DESCRIPTION 💖

The tool adr simplifies maintaining ADR documents. Literally built to make your ADR life easier ✨

---

🌈 COMMANDS 🌈

adr is a multiplexer into individual miniature tools for specific operations. So basically one main command that fans out to a bunch of tiny helpers 🧚

🌸 init

Initialize a directory of ADR documents. Setup energy 🎀

🎀 new

new [-s SUPERSEDED] [-l TARGET:LINK:REVERSE-LINK] TITLE_TEXT...

Creates a brand-new numbered ADR. Every bit of TITLE_TEXT gets stuck together to form the title ✨

• -s SUPERSEDED — takes a SUPERSEDED value 🫶
• -l TARGET:LINK:REVERSE-LINK — takes a TARGET:LINK:REVERSE-LINK value 🔗

🔗 link

link SOURCE LINK TARGET REVERSE-LINK

Creates a link between two ADRs, going from SOURCE to TARGET. Both SOURCE and TARGET are references to an ADR, either a number or a partial filename. Main character link energy 🦋

LINK is the description of the link that gets created in the SOURCE, and REVERSE-LINK is the description of the link that gets created in the TARGET 💜

📜 list

Lists all ADRs. Every single one, no cap 👀

🆙 upgrade-repository

Upgrades your ADR documents to the latest format. Glow-up era 🌟

🗂️ generate toc

Generates a table of contents in Markdown format. So organized, it's giving 🍓

🕸️ generate graph

Generates a visualization of the links between decision records in Graphviz format. The way this is so iconic for seeing how your decisions connect 🌸

---

💀 BUGS 💀

This manual page is a stub 😭 For the real tea, check out the built-in help system by running adr help.

👑 AUTHORS 👑

Zygmunt Krynicki <me@zygoon.pl> — the queen who made this whole thing 🫶

---

That's the whole page, bestie! 🎀 It came from adr-tools 3.0.0-1, dated Jul 18, 2021, and it's the adr(1) manual 🌈✨