Saigkill.adr-tool.CLI
1.1.0
dotnet tool install --global Saigkill.adr-tool.CLI --version 1.1.0
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local Saigkill.adr-tool.CLI --version 1.1.0
#tool dotnet:?package=Saigkill.adr-tool.CLI&version=1.1.0
nuke :add-package Saigkill.adr-tool.CLI --version 1.1.0
adr-cli
A command-line tool for working with Architecture Decision Records (ADRs). This is a fork of the original adr-cli just delivered as dotnet tool.
Badges
What | Status |
---|---|
Language | C# |
Framework | .NET 8 |
Continuous Integration Prod | |
Continuous Integration Stage | |
Bugreports | |
Bugreports | |
Blog |
File a bug report on Github.
File a bug report on Azure DevOps.
Installation
Alternate to the NuGet.org packaage, you can use the Azure Feed: https://pkgs.dev.azure.com/saigkill/AdrTool/_packaging/SaigkillsAdrFeed/nuget/v3/index.json
To install the tool, run the following command in the powershell or cmd:
dotnet tool install --global Saigkill.adr-tool.CLI
Usage
To initialize the ADR directory, run the following command in the powershell or cmd:
adr init
To create a new ADR, run the following command in the powershell or cmd:
adr new "Title of the ADR"
To list all ADRs, run the following command in the powershell or cmd:
adr list
This will create a new ADR file in the docs/adr
directory with the title as the filename. It will openened in the default editor.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
This package has no dependencies.