Saigkill.adr-tool.CLI
1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet tool install --global Saigkill.adr-tool.CLI --version 1.0.0
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local Saigkill.adr-tool.CLI --version 1.0.0
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Saigkill.adr-tool.CLI&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Saigkill.adr-tool.CLI --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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
To install the tool, run the following command in the powershell or cmd:
dotnet tool install --global Saigkill.AdrTool.CLI
Usage
To initialize the ADR directory, run the following command in the powershell or cmd:
adr-tool init
To create a new ADR, run the following command in the powershell or cmd:
adr-tool new "Title of the ADR"
To list all ADRs, run the following command in the powershell or cmd:
adr-tool list
To supersede an ADR, run the following command in the powershell or cmd:
adr-tool new "Title of the ADR" -s <ADR number>
This will create a new ADR file in the docs/adr directory with the title as the filename. Then just open and edit it in any editor or IDE.
| 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.