https://github.com/kevinmichaelchen/adr-tools

:rotating_light: WORK IN PROGRESS :rotating_light: — A CLI for managing Architectural Decision Records (ADRs)
https://github.com/kevinmichaelchen/adr-tools

adr adrs architectural-decision-records rust surrealdb

Last synced: 3 months ago
JSON representation

:rotating_light: WORK IN PROGRESS :rotating_light: — A CLI for managing Architectural Decision Records (ADRs)

Host: GitHub
URL: https://github.com/kevinmichaelchen/adr-tools
Owner: kevinmichaelchen
Created: 2022-12-22T21:51:32.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-12-23T02:48:55.000Z (over 2 years ago)
Last Synced: 2025-02-23T22:43:39.092Z (3 months ago)
Topics: adr, adrs, architectural-decision-records, rust, surrealdb
Language: Rust
Homepage: https://github.com/users/kevinmichaelchen/projects/2/views/1?layout=board
Size: 15.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md

README

# adr-tools

This is a Rust-based set of tools for managing Architectural Decision Records
(ADRs).

We use embedded [SurrealDB](https://surrealdb.com/).

Markdown files are loaded into the graph database, which allows us to do all
sorts of cool analytics.

The CLI is effectively a port of
[`adr-tools`](https://github.com/npryce/adr-tools).

## Contributing

### Nightly Rust

```shell
rustup default nightly
```

### Spin up SurrealDB

```shell
docker compose up
```

### Run CLI

```shell
cargo run
```