{"id":45822877,"url":"https://github.com/adoble/adr-j","last_synced_at":"2026-02-26T21:03:57.212Z","repository":{"id":41463495,"uuid":"97854497","full_name":"adoble/adr-j","owner":"adoble","description":"Java based command-line tool for working with Architecture Decision Records","archived":false,"fork":false,"pushed_at":"2026-02-08T14:48:05.000Z","size":4119,"stargazers_count":62,"open_issues_count":5,"forks_count":19,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-08T20:56:43.049Z","etag":null,"topics":["adr","architecture","architecture-decision-records","architecture-doc","documentation","java","tool"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adoble.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-07-20T16:03:29.000Z","updated_at":"2026-02-08T14:48:09.000Z","dependencies_parsed_at":"2024-10-25T19:35:39.435Z","dependency_job_id":"0dc65546-c839-4065-ade0-106795b81bf7","html_url":"https://github.com/adoble/adr-j","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/adoble/adr-j","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoble%2Fadr-j","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoble%2Fadr-j/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoble%2Fadr-j/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoble%2Fadr-j/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adoble","download_url":"https://codeload.github.com/adoble/adr-j/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoble%2Fadr-j/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29872674,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T21:01:59.805Z","status":"ssl_error","status_checked_at":"2026-02-26T21:00:42.555Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["adr","architecture","architecture-decision-records","architecture-doc","documentation","java","tool"],"created_at":"2026-02-26T21:03:51.339Z","updated_at":"2026-02-26T21:03:57.205Z","avatar_url":"https://github.com/adoble.png","language":"Java","readme":"\r\n# ADR-J Tool\r\n![Release](https://img.shields.io/github/v/release/adoble/adr-j)\r\n![Build Status](https://github.com/adoble/adr-j/actions/workflows/gradle.yml/badge.svg)\r\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\r\n\r\n\r\nA Java based command-line tool for working with [Architecture Decision Records][ADRs] (ADRs). More information about what ADRs are and why to use them can be found in this [article](https://adr.github.io/).\r\n\r\nADR-J is based on the [script based tools from Nat Pryce](https://github.com/npryce/adr-tools). It has been extended so that:\r\n\r\n- Custom ADR templates can be created that fit into either in-house development guidelines or standard templates such as the [Nyquest form](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) or [MADR](https://www.ozimmer.ch/practices/2022/11/22/MADRTemplatePrimer.html) or **any other**.\r\n\r\n- Different markup formats can be used in the templates (for instance **Markdown** and **AsciiDoc**) meaning that the ADRs can be used with different in-house documentation tools.  \r\n\r\n# Quick Start\r\n\r\n[Install ADR-J tool](./doc/usage/INSTALL.md)\r\n\r\nUse the `adr` command to manage ADRs.  Try running `adr help`.\r\n\r\nADRs are stored in your project as markup files in the `doc/adr` directory.\r\n\r\n\r\n1. Create an ADR directory in the root of your project:\r\n\r\n        adr init \r\n\r\n    This will create the first ADR recording that you are using ADRs\r\n    to record architectural decisions and linking to\r\n    [Michael Nygard's article on the subject][ADRs]. The default is to use the Nygard template, GitHub markdown and the relative directory `doc/adr`. \r\n \r\n    To use a different template to the default, specify the path of a template:\r\n\r\n       adr init -t ~/standards/madr.md \r\n\r\n    A guide to writing templates can be found [here](./doc/usage/Writing_Templates.md). Example templates can be found [here](./doc/example_templates).\r\n\r\n    To use a different directory for the created ADRs specify the directory:\r\n\r\n       adr init doc/architecture/decisions\r\n\r\n    To combine these both use:\r\n\r\n        adr init -t ~/standards/madr.md doc/architecture/decisions\r\n\r\n    After initialisation, a [properties file](./doc/usage/properties_file.md) is created in the directory `.adr`.\r\n\r\n\r\n2. Create Architecture Decision Records\r\n\r\n        adr new Implement as Unix shell scripts\r\n\r\n    This will create a new, numbered ADR file and open it in your\r\n    editor of choice (as specified by the ADR_EDITOR environment\r\n    variable).\r\n\r\n    To create a new ADR that supersedes a previous one (ADR 9, for example), use the -s option.\r\n\r\n        adr new -s 9 Use Rust for performance-critical functionality\r\n\r\n    This will create a new ADR file that is flagged as superseding\r\n    ADR 9.  It then opens the new ADR in your\r\n    editor of choice.\r\n\r\n    To create a new ADR that references another ADR, use the -l option.\r\n\r\n       adr new -l 4:\"Links to\" Use JMS interface for messaging\r\n\r\n   This will create a new ADR that references ADR 4 and inserts the message\r\n   \"Links to\" in the new ADR.  \r\n\r\n3. For further information, see the [man pages](doc/man/adr.md) or use the built in help:\r\n\r\n        adr help\r\n\r\n\r\n\r\n# Architecture Decisions\r\n\r\nThe decisions for this tool are recorded as [architecture decision records in the project repository](doc/adr/).\r\n\r\n# Build\r\n\r\n\r\nThis project uses Gradle to build. Execute following command to generate `build/release/adr-j.jar`\r\n\r\n    gradlew releaseJar\r\n\r\n[ADRs]: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadoble%2Fadr-j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadoble%2Fadr-j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadoble%2Fadr-j/lists"}