https://github.com/websublime/adr
Architecture Decision Records
https://github.com/websublime/adr
adr cli markdown nodejs
Last synced: 12 days ago
JSON representation
Architecture Decision Records
- Host: GitHub
- URL: https://github.com/websublime/adr
- Owner: websublime
- Created: 2021-02-11T11:30:12.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-05-08T00:36:14.000Z (over 3 years ago)
- Last Synced: 2025-03-12T18:42:52.265Z (10 months ago)
- Topics: adr, cli, markdown, nodejs
- Language: TypeScript
- Homepage:
- Size: 111 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ADR (Architecture Decision Records）
Create ADR markdown documents to register architecture decisions in your project. Current support languages EN and PT.
## Installation
```bash
yarn global add @websublime/adr
or
npm install -g @websublime/adr
```
## Usage
```bash
adr
Usage: adr [options]
Options:
-V, --version output the version number
-init, init Initiate project to support ADR, like: `adr init en`
-c, create Create a new ADR markdown. Surround your tilte always with quotes, like adr create `Use a new tool`
-l, log Show logging of all files
-s, status Set new state to ADR
-h, --help output usage information
adr init
adr new
adr list
adr generate toc
adr update
adr export
adr search
```