/adrs.nix

TODO: A nix flake for adrs

Primary LanguageRustApache License 2.0Apache-2.0

adrs

crates.io docs Rust dependency status

adrs is a command-line tool for managing Architectural Decision Records.

Status

Currently in development. The first milestone is feature parity and rough compatibility with adr-tools.

Possible extended feature ideas:

  • Support MADR in addition to Nygard.
  • Integrated git support.
  • Built-in HTTP server support to present ADRs via the web.

Installation

For now:

  1. clone this repository
  2. run cargo install --path . in the root of the repo

Command Line

adrs 0.1.0

USAGE:
    adrs <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    config      Show configuration
    generate    Generate summary documentation
    help        Prints this message or the help of the given subcommand(s)
    init        Initialize a new ADR directory
    link        Link together two ADRs
    list        List the ADRs
    new         Create a new, numbered ADR

Contributing

License

Authors