adr-setup

An interactive setup wizard for ADRs, or Architecture Decision Records—short documents that record important technical choices and their reasons. It configures where these records live and how they are formatted.

In plain words
What is it for?
Use it to start or adjust ADR management in a project, choose a storage directory and template style, set numbering preferences, and optionally create the first decision record.
Why use it?
It removes the need to create the ADR folder, configuration, index, and templates by hand. It also checks whether the project already has ADR settings or documents.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/zircote-plugins/adr/adr-setup
Clone the repo
git clone --depth 1 https://github.com/zircote-plugins/adr
Per session 12 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 823 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00012 $0.00823
Opus 5 $0.00006 $0.00411
Sonnet 5 $0.00002 $0.00165
Haiku 4.5 $0.00001 $0.00082

Measured yesterday against content hash 9acacb63460c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

adr-setup scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

commands/adr-setup.md · 165 lines

How it starts

The opening of the file, as written. The whole thing — 165 lines — stays where its author put it; the contents beside it link to each section on GitHub.

ADR Setup

Interactive configuration wizard for setting up ADR management in the current project.

Process

  1. Check for existing configuration
  2. Gather preferences through interactive questions
  3. Create configuration file (.claude/adr.local.md)
  4. Create ADR directory if needed
  5. Initialize README.md index
  6. Create first ADR (optional)

Existing Configuration Check

Check for:

  • .claude/adr.local.md - Plugin configuration
  • docs/adr/ or other ADR directories
  • Existing ADRs

If found, ask:

  • Update existing configuration?
  • Keep current settings and just fill gaps?

Configuration Questions

Use AskUserQuestion for structured input:

ADR Directory

"Where should ADRs be stored?"

  • docs/adr/ (recommended)
  • docs/decisions/
  • architecture/decisions/
  • Custom path

Template Format

"Which ADR template format?"

  • MADR (recommended)
  • Structured MADR (comprehensive with frontmatter and audit sections)
  • Nygard
  • Y-Statement
  • Alexandrian
  • Business Case
  • Tyree-Akerman

MADR Variant (if MADR selected, not applicable for Structured MADR)

"Which MADR template variant?"

  • Full (recommended)
  • Minimal
  • Bare
  • Bare-minimal

Numbering

"How should ADRs be numbered?"

  • 4-digit sequential (recommended): 0001, 0002
  • 3-digit sequential: 001, 002
  • Date-based: 20250115
  • Custom pattern

Status Workflow

"Which status workflow?"

  • Standard: proposed → accepted → deprecated → superseded
  • Simple: draft → accepted → superseded
  • Extended: include rejected, implemented
  • Custom

Git Integration

"Enable git integration?"

  • Yes - track changes, suggest commits
  • No - manual git management

Create Configuration

Generate .claude/adr.local.md:

---
adr_paths:
  - {chosen_path}

default_format: {format}
madr_variant: {variant}

numbering:
  pattern: "{pattern}"
  start_from: 1

statuses:
  workflow:
    - proposed
    - accepted
    - deprecated
    - superseded
  allow_rejected: true

git:
  enabled: {true/false}
  auto_commit: false
  commit_template: "docs(adr): {action} ADR-{id} {title}"
---

# Project ADR Context

{Project name} Architecture Decision Records

## Decision Process

- ADRs are proposed via pull request
- Team review required before acceptance
- Architecture lead has final approval

Read the full file on GitHub · 165 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 165 lines · 12 tokens per session scan A 9acacb63460c

Subscribe to this mod's changes

adr-setup is a command published in the GitHub repository zircote-plugins/adr (5 stars, last pushed 15d ago), licensed MIT. It adds 12 tokens to every session and 823 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.