{"id":22511940,"url":"https://github.com/jandev/adr-cli","last_synced_at":"2025-08-03T15:30:47.083Z","repository":{"id":45325100,"uuid":"300167125","full_name":"Jandev/adr-cli","owner":"Jandev","description":"A Windows equivalent of adr-tools (https://github.com/npryce/adr-tools). Original on https://github.com/GingerTommy/adr-cli, but appears to be abandonned.","archived":false,"fork":false,"pushed_at":"2022-03-29T13:32:30.000Z","size":59,"stargazers_count":12,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-01T13:04:41.429Z","etag":null,"topics":["adr","architecture","documentation"],"latest_commit_sha":null,"homepage":"","language":"C#","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/Jandev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-01T06:12:51.000Z","updated_at":"2024-02-22T07:19:02.000Z","dependencies_parsed_at":"2022-09-17T04:22:17.507Z","dependency_job_id":null,"html_url":"https://github.com/Jandev/adr-cli","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jandev%2Fadr-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jandev%2Fadr-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jandev%2Fadr-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jandev%2Fadr-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jandev","download_url":"https://codeload.github.com/Jandev/adr-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228548555,"owners_count":17935226,"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":["adr","architecture","documentation"],"created_at":"2024-12-07T02:14:36.762Z","updated_at":"2024-12-07T02:14:37.457Z","avatar_url":"https://github.com/Jandev.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ADR CLI tooling\r\n\r\nA command-line tool for working with Architecture Decision Records (ADRs).\r\n\r\n# Installation\r\n\r\n* Download the latest version of the adr-cli tool from the [Releases page](https://github.com/Jandev/adr-cli/releases)  \r\nIt's available for both Windows \u0026 Linux.\r\n\r\n* Copy the executable to a location mentioned in the PATH of your system.\r\n\r\n# Usage\r\n\r\nYou can use this tool to create a directory for your ADR documents to be stored in and create new ADR files.  \r\nAn index file will also be created on initial setup.\r\n\r\n## Init\r\n`adr-cli init` \r\n\r\nThis will create the necessary folder (`/docs/adr`) from where you are running the command, including the initial document (`0001-record-architecture-decisions.md`) and the index file (`0000-index.md`).  \r\nOnce created, it will try to open the initial file in your Markdown editor.\r\n\r\n## List\r\n`adr-cli init` \r\n\r\nPlaceholder, does nothing yet.  \r\nThis command is inherited from the previous implementation and can be deleted.\r\n\r\n## New\r\n`adr-cli new \"New decision\"` \r\n\r\nWill create a new ADR document with the mentioned title and a follow-up number.  \r\nThe document will have the `Proposed` status.\r\n\r\nThe `-s` flag (supercedes) can be used like the following:\r\n\r\n```\r\n ./adr-cli new \"Superseded decision\" -s \"0003-another-decision.md\"\r\n```\r\nThis will result in an index like the following example:\r\n```\r\n# Index\r\n\r\n| Number | Title | Superseded by |\r\n| ------ | ----- | ------------- |\r\n| 1 | [Record Architecture Decisions](./0001-record-architecture-decisions.md)| |\r\n| 2 | [new-decision](./0002-new-decision.md)| |\r\n| 3 | ~~[Another decision](./0003-another-decision.md)~~| [5 - superseded-decision](./0005-superseded-decision.md) |\r\n| 4 | [Another decision](./0004-another-decision.md)| |\r\n| 5 | [superseded-decision](./0005-superseded-decision.md)| |\r\n\r\n```\r\n\r\n## Link\r\n\r\nPlaceholder, does nothing yet.  \r\nThis command is inherited from the previous implementation and can be deleted.\r\n\r\n## Generate\r\n\r\nPlaceholder, does nothing yet.  \r\nThis command is inherited from the previous implementation and can be deleted.\r\n\r\n\r\n# Publishing\r\n\r\nIf you don't want to use the [Releases published in this repository](https://github.com/Jandev/adr-cli/releases), you can also publish them yourselves.\r\n\r\nThe `FolderProfile` in this solution is set up to do this.\r\n\r\nIf you're a fan of the dotnet CLI, publish using the following command:\r\n\r\n```powershell\r\ndotnet publish -r win-x64 -c Release /p:PublishSingleFile=true /p:PublishTrimmed=true\r\n```\r\n\r\n# Credits\r\n\r\nThis tool was originally started by [GingerTommy](https://github.com/GingerTommy/adr-cli). After having waited for a couple of months for my PR's to get approved, I've decided to create a new repository for the tool and use the original as a base.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjandev%2Fadr-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjandev%2Fadr-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjandev%2Fadr-cli/lists"}