adr-tools
brew install adr-tools
v3.0.0
CC-BY-4.0
CLI tool for working with Architecture Decision Records
178
30-day installs · #2740
520
90-day · #2851
1.9k
365-day · #2876
5.5k
★ GitHub stars · updated 2y ago
GitHub topics
architecture
architecture-decision-records
documentation
markdown
Links
- https://github.com/npryce/adr-tools
- GitHub: npryce/adr-tools
- Brew formula source: Formula/a/adr-tools.rb
Raw metadata
{
"aliases": [],
"alternatives": [],
"build_dependencies": [],
"categories": [],
"caveats": null,
"conflicts_with": [],
"dependencies": [],
"deprecated": 0,
"deprecation_reason": null,
"desc": "CLI tool for working with Architecture Decision Records",
"disable_reason": null,
"disabled": 0,
"enrichment_fetched_at": "2026-06-20T23:35:18+00:00",
"first_seen": "2026-06-20T23:34:18+00:00",
"full_name": "adr-tools",
"github_default_branch": "master",
"github_last_commit_at": "2024-04-25T18:22:02Z",
"github_readme_excerpt": "ADR Tools\n=========\n\nA command-line tool for working with a log of [Architecture Decision Records][ADRs] (ADRs).\n\n[](https://travis-ci.org/npryce/adr-tools)\n\nQuick Start\n-----------\n\n[Install ADR Tools](INSTALL.md).\n\nUse the `adr` command to manage ADRs. Try running `adr help`.\n\nADRs are stored in a subdirectory of your project as Markdown files. \nThe default directory is `doc/adr`, but you can specify the directory\nwhen you initialise the ADR log.\n\n1. Create an ADR directory in the root of your project:\n\n adr init doc/architecture/decisions\n\n This will create a directory named `doc/architecture/decisions` \n containing the first ADR, which records that you are using ADRs\n to record architectural decisions and links to \n [Michael Nygard\u0027s article on the subject][ADRs].\n\n2. Create Architecture Decision Records\n\n adr new Implement as Unix shell scripts\n\n This will create a new, numbered ADR file and open it in your\n editor of choice (as specified by the VISUAL or EDITOR environment\n variable).\n\n To create a new ADR that supercedes a previous one (ADR 9, for example),\n use the -s option.\n\n adr new -s 9 Use Rust for performance-critical functionality\n\n This will create a new ADR file that is flagged as superceding\n ADR 9, and changes the status of ADR 9 to indicate that it is\n superceded by the new ADR. It then opens the new ADR in your\n editor of choice.\n \n3. For further information, use the built in help:\n\n adr help\n\n\nSee the [tests](tests/) for detailed examples.\n\nThe decisions for this tool are recorded as [architecture decision records in the project repository](doc/adr/). \n\n[ADRs]: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions\n",
"github_repo": "npryce/adr-tools",
"github_stars": 5525,
"github_topics": [
"architecture",
"architecture-decision-records",
"documentation",
"markdown"
],
"homepage": "https://github.com/npryce/adr-tools",
"homepage_og_description": null,
"homepage_og_image": null,
"homepage_title": null,
"installs_30d": 178,
"installs_365d": 1929,
"installs_90d": 520,
"keg_only": 0,
"keg_only_reason": null,
"last_seen": "2026-06-20T23:34:18+00:00",
"license": "CC-BY-4.0",
"llm_generated_at": null,
"llm_model": null,
"name": "adr-tools",
"oldnames": [],
"one_liner": null,
"optional_dependencies": [],
"rank_30d": 2740,
"rank_365d": 2876,
"rank_90d": 2851,
"raw_hash": "788fb451351e9833",
"recommended_dependencies": [],
"revision": 0,
"ruby_source_path": "Formula/a/adr-tools.rb",
"tap": "homebrew/core",
"test_dependencies": [],
"uses_from_macos": [],
"version_head": null,
"version_stable": "3.0.0",
"versioned_formulae": [],
"why_use_this": null
}