{"id":13452427,"url":"https://github.com/npryce/adr-tools","last_synced_at":"2025-05-14T01:10:29.847Z","repository":{"id":37732953,"uuid":"51087740","full_name":"npryce/adr-tools","owner":"npryce","description":"Command-line tools for working with Architecture Decision Records","archived":false,"fork":false,"pushed_at":"2024-04-25T18:22:02.000Z","size":131,"stargazers_count":4823,"open_issues_count":65,"forks_count":595,"subscribers_count":88,"default_branch":"master","last_synced_at":"2025-04-03T01:38:25.932Z","etag":null,"topics":["architecture","architecture-decision-records","documentation","markdown"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/npryce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-04T16:11:31.000Z","updated_at":"2025-04-02T13:36:38.000Z","dependencies_parsed_at":"2023-02-16T21:30:49.476Z","dependency_job_id":"80a8182b-baee-4330-8c21-1b54ce352f76","html_url":"https://github.com/npryce/adr-tools","commit_stats":{"total_commits":136,"total_committers":18,"mean_commits":7.555555555555555,"dds":0.3161764705882353,"last_synced_commit":"b3279baf9be2207d1a4f4bbd608fd0b591c72aee"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npryce%2Fadr-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npryce%2Fadr-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npryce%2Fadr-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npryce%2Fadr-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/npryce","download_url":"https://codeload.github.com/npryce/adr-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248154645,"owners_count":21056541,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture","architecture-decision-records","documentation","markdown"],"created_at":"2024-07-31T07:01:23.918Z","updated_at":"2025-04-10T03:40:07.322Z","avatar_url":"https://github.com/npryce.png","language":"Shell","readme":"ADR Tools\n=========\n\nA command-line tool for working with a log of [Architecture Decision Records][ADRs] (ADRs).\n\n[![Build Status](https://travis-ci.org/npryce/adr-tools.svg?branch=master)](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's 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","funding_links":[],"categories":["Shell","Techniques","ADR","Tool Collection","documentation","architecture"],"sub_categories":["Architecture Decision Records","Search"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnpryce%2Fadr-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnpryce%2Fadr-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnpryce%2Fadr-tools/lists"}