Giter Club home page Giter Club logo

adr-tool's Introduction

adr-tool

easy CLI for ADR docs

oclif Version Downloads/week License

Demo

adr-tool demo

🎞️ Watch the full screencast

Usage

You can install it globally (npm install -g adr-tool) or use it with npx

$ npx adr-tool init
./docs/adr folder is created!
$ npx adr-tool create Use Markdown Architectural Decision Records
a decision created on ./docs/adr/0000-use-markdown-architectural-decision-records.md

Commands

adr-tool create [TITLE]

create a new decision and log it into docs/adr/README.md file

USAGE
  $ adr-tool create [TITLE]

ARGUMENTS
  TITLE  title of the decision

OPTIONS
  -h, --help                               show CLI help
  -t, --ticket=ticket                      technical ticket
  --status=accepted|deprecated|superseded

EXAMPLE
  $ adr-tool create Use ADR Tool
  a decision created on ./docs/adr/0000-use-adr-tool.md

See code: src/commands/create.ts

adr-tool help [COMMAND]

Display help for adr-tool.

USAGE
  $ adr-tool help [COMMAND]

ARGUMENTS
  COMMAND  Command to show help for.

OPTIONS
  -n, --nested-commands  Include all nested commands in the output.

See code: @oclif/plugin-help

adr-tool init

create docs/adr folder and copies template.md and README.md

USAGE
  $ adr-tool init

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ adr-tool init
  ./docs/adr folder is created!

See code: src/commands/init.ts

adr-tool toc

create docs/adr/README.md file

USAGE
  $ adr-tool toc

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ adr-tool toc
  ./docs/adr/README.md file is created!

See code: src/commands/toc.ts

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.