5 releases
0.2.8 | Mar 14, 2024 |
---|---|
0.2.7 | Mar 8, 2024 |
0.2.1 | Mar 7, 2024 |
0.2.0 | Mar 5, 2024 |
0.1.0 | Mar 7, 2021 |
#491 in Command line utilities
178 downloads per month
36KB
827 lines
adrs
adrs
is a command-line tool for managing Architectural Decision Records.
Status
Currently in development. This first preview version has feature parity and rough compatibility with adr-tools.
Possible extended feature ideas:
- Support MADR and custom templates in addition to Nygard.
- Built-in HTTP server support to present ADRs via the web.
Installation
Homebrew:
brew tap joshrotenberg/brew
brew install adrs
From source (requires the Rust toolchain):
git clone https://github.com/joshrotenberg/adrs
cd adrs
cargo install
Via cargo
(aslo requires the Rust toolchain):
cargo install adrs
Via a released binary:
See Releases.
Command Line
Architectural Decision Record command line tool
Usage: adrs <COMMAND>
Commands:
init Initializes the directory of Architecture Decision Records
new Create a new, numbered Architectural Decision Record
edit Edit an existing Architectural Decision Record
link Link Architectural Decision Records
list List Architectural Decision Records
config Show the current configuration
generate Generates summary documentation about the Architectural Decision Records
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
Contributing
Contributions absolutely welcome. See the current issues.
License
See LICENSE-MIT or LICENSE-APACHE-2.0.
Authors
Dependencies
~5–17MB
~207K SLoC