https://github.com/keremciu/adr-tool
A simple CLI for Architectural Decision Records.
https://github.com/keremciu/adr-tool
adr architectural-decision-records cli
Last synced: 10 months ago
JSON representation
A simple CLI for Architectural Decision Records.
- Host: GitHub
- URL: https://github.com/keremciu/adr-tool
- Owner: keremciu
- Created: 2021-04-14T13:56:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-31T22:17:19.000Z (over 3 years ago)
- Last Synced: 2025-03-10T13:06:15.467Z (10 months ago)
- Topics: adr, architectural-decision-records, cli
- Language: TypeScript
- Homepage: https://adr.github.io
- Size: 1.44 MB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
adr-tool
========
easy CLI for ADR docs
[](https://oclif.io)
[](https://npmjs.org/package/adr-tool)
[](https://npmjs.org/package/adr-tool)
[](https://github.com/keremciu/adr-tool/blob/main/package.json)
* [Demo](#demo)
* [Usage](#usage)
* [Commands](#commands)
# Demo
# Usage
You can install it globally (`npm install -g adr-tool`) or use it with [npx](https://docs.npmjs.com/cli/v7/commands/npx)
```sh-session
$ npx adr-tool init
./docs/adr folder is created!
$ npx adr-tool create Use Markdown Architectural Decision Records
a decision created on ./docs/adr/0000-use-markdown-architectural-decision-records.md
```
# Commands
* [`adr-tool create [TITLE]`](#adr-tool-create-title)
* [`adr-tool help [COMMAND]`](#adr-tool-help-command)
* [`adr-tool init`](#adr-tool-init)
* [`adr-tool toc`](#adr-tool-toc)
## `adr-tool create [TITLE]`
create a new decision and log it into docs/adr/README.md file
```
USAGE
$ adr-tool create [TITLE]
ARGUMENTS
TITLE title of the decision
OPTIONS
-h, --help show CLI help
-t, --ticket=ticket technical ticket
--status=accepted|deprecated|superseded
EXAMPLE
$ adr-tool create Use ADR Tool
a decision created on ./docs/adr/0000-use-adr-tool.md
```
_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.3.0/src/commands/create.ts)_
## `adr-tool help [COMMAND]`
Display help for adr-tool.
```
USAGE
$ adr-tool help [COMMAND]
ARGUMENTS
COMMAND Command to show help for.
OPTIONS
-n, --nested-commands Include all nested commands in the output.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
## `adr-tool init`
create docs/adr folder and copies template.md and README.md
```
USAGE
$ adr-tool init
OPTIONS
-h, --help show CLI help
EXAMPLE
$ adr-tool init
./docs/adr folder is created!
```
_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.3.0/src/commands/init.ts)_
## `adr-tool toc`
create docs/adr/README.md file
```
USAGE
$ adr-tool toc
OPTIONS
-h, --help show CLI help
EXAMPLE
$ adr-tool toc
./docs/adr/README.md file is created!
```
_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.3.0/src/commands/toc.ts)_