{"id":14063965,"url":"https://github.com/rdagumampan/adr-ps","last_synced_at":"2025-04-19T18:13:00.035Z","repository":{"id":100125247,"uuid":"147734754","full_name":"rdagumampan/adr-ps","owner":"rdagumampan","description":"A Powershell-based lightweight Architecture Decision Records (ADR) tool","archived":false,"fork":false,"pushed_at":"2018-09-08T17:37:39.000Z","size":18,"stargazers_count":6,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T11:34:29.359Z","etag":null,"topics":["adr","adr-powershell","adr-ps","agile-documentation","architecture-decision-records"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rdagumampan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2018-09-06T21:17:31.000Z","updated_at":"2023-09-05T21:52:39.000Z","dependencies_parsed_at":"2023-05-12T11:15:10.725Z","dependency_job_id":null,"html_url":"https://github.com/rdagumampan/adr-ps","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdagumampan%2Fadr-ps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdagumampan%2Fadr-ps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdagumampan%2Fadr-ps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdagumampan%2Fadr-ps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rdagumampan","download_url":"https://codeload.github.com/rdagumampan/adr-ps/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249760135,"owners_count":21321843,"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","adr-powershell","adr-ps","agile-documentation","architecture-decision-records"],"created_at":"2024-08-13T07:03:35.952Z","updated_at":"2025-04-19T18:13:00.014Z","avatar_url":"https://github.com/rdagumampan.png","language":"PowerShell","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"readme":"# ADR-PS\n\nA Powershell based command-line tool for working with [Lighweight Architecture Decision Records (ADRs)](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).\n\n\u003e\"Lightweight Architecture Decision Records is a technique for capturing important architectural decisions along with their context and consequences. We recommend storing these details in source control, instead of a wiki or website, as then they can provide a record that remains in sync with the code itself. - Thoughtworks\"\n\n## Quick Start\n\nADR-PS is a powershell module you can import in a normal powershell session. The default destination directory is `doc\\adr`.\n\n1. Copy the adr.psm1 into your solution folder and change the `doc\\adr` into your desired directory.\n2. Open Powershell CLI and import module\n\n\t```powershell\n\t/ powershell –ExecutionPolicy Bypass\n\t/ Import-Module .\\adr.psm1\n\t```\n3. Create an ADR repository in the current script location\n\t```powershell\n\t/ Adr-Init\n\t```\t\n4. Create architecture decision record\n\t```powershell\n\t/ Adr-New \"Record architecture decisions\"\t\n\t```\n\t\n\t```powershell\n\tDirectory: C:\\play\\adr-ps\\doc\\adr\n\n\tMode           LastWriteTime         \t     Length Name\n\t----           -------------         \t     ------ ----\n\t-a----         9/8/2018     07:50            419 0001-record-architecture-decisions.md\n\t-a----         9/8/2018     07:43            125 ReadMe.md\t\n\t```\n5. Help\n\t```powershell\n\t/ Adr-Help\n\t```\n\n## Updating module\n\n```powershell\n/ powershell –ExecutionPolicy Bypass\n/ Remove-Module adr\n/ Import-Module .\\adr.psm1\n```\n\n## Motivation\n\nADR-PS aims to help document architecturally significant functional and non-functional decisions through out solution lifetime to benefit current and future teams. I also hope to promote ADR-technique into greater audience with more choice of tools.\n\nThe decisions on this tool are recorded as [architecture decision records in repository](https://github.com/rdagumampan/adr-ps/tree/master/doc/adr)\n## References\n\n- http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions\n- https://www.thoughtworks.com/radar/techniques/lightweight-architecture-decision-records\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdagumampan%2Fadr-ps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frdagumampan%2Fadr-ps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdagumampan%2Fadr-ps/lists"}