generate

Overview

The generate command fronts three options for generating output for use with other tools.

toc - generate a Markdown table of contents
graph - generate a Graphviz representation of your ADRs
book - generate a basic mdBook representation of your ADRs

Help

Generates summary documentation about the Architectural Decision Records

Usage: adrs generate <COMMAND>

Commands:
  toc    Generate a table of contents
  graph  Generate a graph of the ADRs
  book   Generate a book of the ADRs
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Examples

Graph

# Generate a Graphviz file graphing the ADRs and their relationships.
adrs generate graph

digraph {
  node [shape=plaintext]
  subgraph {
        _1 [label="1. Record architecture decisions"; URL="0001-record-architecture-decisions.html"];
        _2 [label="2. Rewrite it in Rust"; URL="0002-rewrite-it-in-rust.html"];
        _1 -> _2 [style="dotted", weight=1];
        _3 [label="3. Use mdBook for documentation"; URL="0003-use-mdbook-for-documentation.html"];
        _2 -> _3 [style="dotted", weight=1];
  }
}

Book

Generate a book of the ADRs

Usage: adrs generate book [OPTIONS]

Options:
  -p, --path <PATH>                Target path for the book directory [default: book]
  -o, --overwrite                  Overwrite existing directory
  -t, --title <TITLE>              Title of the book [default: "Architecture Decision Records"]
  -d, --description <DESCRIPTION>  Description of the book [default: "A collection of architecture decision records"]
  -a, --author <AUTHOR>            Author of the book
  -h, --help                       Print help
  -V, --version                    Print version

# Generate a basic mdBook based project for the current ADRs
adrs generate book

The book directory now contains a basic mdbook with:

`book.toml' - the book's configuration
src/SUMMARY.md - a Markdown file describing the structure of the book
your ADR files - copied into the book and referenced by the SUMMARY.md

Get started by running mdbook serve in your book directory. See mdBook for more information.

Note that the command is currently pretty destructive, but requires the -o/--overwrite flag to work on an existing directory.

Issues

See the cmd-generate label for command specific issues.

adrs documentation