https://github.com/nicholassynovic/tool_rad
Record Architecture Designs - a tool to facilitate ADR creation and management
https://github.com/nicholassynovic/tool_rad
adr architecture tools
Last synced: 5 days ago
JSON representation
Record Architecture Designs - a tool to facilitate ADR creation and management
- Host: GitHub
- URL: https://github.com/nicholassynovic/tool_rad
- Owner: NicholasSynovic
- License: agpl-3.0
- Created: 2024-09-26T21:30:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T23:58:12.000Z (about 1 year ago)
- Last Synced: 2024-10-24T10:24:04.508Z (about 1 year ago)
- Topics: adr, architecture, tools
- Language: Makefile
- Homepage:
- Size: 679 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Governance: .github/GOVERNANCE.md
Awesome Lists containing this project
README
# `rad` - Record Architecture Decisions
> A small tool to help you record your architecture decisions
## Table of Contents
- [`rad` - Record Architecture Decisions](#rad---record-architecture-decisions)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [How To Install](#how-to-install)
- [How To Configure `rad`](#how-to-configure-rad)
- [ADR Formats](#adr-formats)
## About
This project is a continuation of the [`talo`](https://github.com/canpolat/talo)
project in the sense to provide a single tool to manage Architecture Decision
Reports (ADRs) within projects. Unlike `talo`, `rad` is meant to soley focus on
ADRs and limit user configuration in the spirit of
[`black`](https://github.com/psf/black). Additionally, this tool takes
inspiration from [`git`](https://git-scm.com) to allow you to record ADRs
anywhere within the project instead of just in the project's root directory.
## How To Install
The following instructions allow you to build `rad` locally:
```shell
git clone https://github.com/NicholasSynovic/tool_rad
cd tool_rad
cmake .
make
cp ./bin/rad ~/.local/bin/rad
```
## How To Configure `rad`
You can initialize `rad` with:
```shell
rad init
```
This will create a `.rad.json` file in the current directory.
The `.rad.json` file is intentionally sparse. The following options can be
configured in the file:
- `adr_directory`: The *relative* path to store ADRs.
- Default: `docs/adr`
- `adr_format`: The format of the ADRs.
- Default: `nygard`.
- See [ADR Formats](#adr-formats) for a list of availible formats
## ADR Formats
The following ADR formats are supported:
- `edgex`: EdgeX
- `business`: Business
- `madr`: Markdown ADR (MADR)
- `tyree`: Tyree
- `planguage`: Planguage
- `alexandrian`: Alexandrian
- `nygard`: Nygard