{"id":13550734,"url":"https://github.com/marouni/adr","last_synced_at":"2025-04-03T00:34:47.297Z","repository":{"id":39990660,"uuid":"146197181","full_name":"marouni/adr","owner":"marouni","description":"A minimalist command line tool written in Go to work with Architecture Decision Records","archived":false,"fork":false,"pushed_at":"2022-11-22T23:28:04.000Z","size":15,"stargazers_count":112,"open_issues_count":7,"forks_count":24,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-03T20:36:02.276Z","etag":null,"topics":["architecture","architecture-decision-records","architecture-doc","documentation","documentation-generator","documentation-tool"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marouni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-26T16:27:57.000Z","updated_at":"2024-10-17T22:42:54.000Z","dependencies_parsed_at":"2022-08-25T14:51:40.670Z","dependency_job_id":null,"html_url":"https://github.com/marouni/adr","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marouni%2Fadr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marouni%2Fadr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marouni%2Fadr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marouni%2Fadr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marouni","download_url":"https://codeload.github.com/marouni/adr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246916735,"owners_count":20854511,"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","architecture-doc","documentation","documentation-generator","documentation-tool"],"created_at":"2024-08-01T12:01:36.791Z","updated_at":"2025-04-03T00:34:42.285Z","avatar_url":"https://github.com/marouni.png","language":"Go","funding_links":[],"categories":["Go","documentation"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.com/marouni/adr.svg?branch=master)](https://travis-ci.com/marouni/adr)\n\n# ADR Go\nA minimalist command line tool written in Go to work with [Architecture Decision Records](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) (ADRs).\n\nGreatly inspired by the [adr-tools](https://github.com/npryce/adr-tools) with all of the added benefits of using the Go instead of Bash.\n\n# Quick start\n## Installing adr\nGo to the [releases page](https://github.com/marouni/adr/releases) and grab one of the binaries that corresponds to your platform.\n\nAlternatively, if you have a Go developement environment setup you can install it directly using :\n```bash\ngo get github.com/marouni/adr \u0026\u0026 go install github.com/marouni/adr\n```\n\n\n## Initializing adr\nBefore creating any new ADR you need to choose a folder that will host your ADRs and use the `init` sub-command to initialize the configuration :\n\n```bash\nadr init /home/user/my_adrs\n```\n\n## Creating a new ADR\n\nAs simple as :\n```bash\nadr new my awesome proposition\n```\nthis will create a new numbered ADR in your ADR folder :\n`xxx-my-new-awesome-proposition.md`.\nNext, just open the file in your preferred markdown editor and starting writing your ADR.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarouni%2Fadr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarouni%2Fadr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarouni%2Fadr/lists"}