{"repo":"nioe/madr-tools","free":true,"listed":false,"github":"https://github.com/nioe/madr-tools","clone":"git clone https://github.com/nioe/madr-tools.git","description":"Node.js CLI tool to create and manage Markdown Architectural Decision Records (MADR)","language":"TypeScript","stars":12,"topics":["madr","adr","markdown","cli","documentation"],"license":"ISC","category":"cli-tools","readme_excerpt":"madr-tools Node.js CLI tools to help you create and manage Markdown Architectural Decision Records (MADR). The famous ADR Tools have been taken as a role model for this Node.js port. Installation Within specific project (recommended): Globally: Usage Run npx madr --help to get an overview and description for all available commands. Each command provides another, more detailed help. E.g. npx madr init --help . Initialization Run the following command within the root directory of your repository to initialize the MADR directory and config file. By default, the MADR directory will be created under docs/decisions . You can specify a custom directory by providing the relative path as the first positional argument. Furthermore, the overview over all MADRs is written to a file called index.md by default as the official MADR Documentation suggests. However, when watching the directory within a web-based Git repo (e.g. GitHub or GitLab), it will automatically render the readme.md file within the directory. Therefore, it's possible to use readme.md instead of index.md as the file name by setting the -i readme.md option. Creating a new MADR Run the following command to create a new MADR-File. e.g. It will create a new MADR file within the configured directory based on the template.md file. Furthermore, it updates the MADR log. Updating the MADR Log When you change the filename or title of a MADR, it is possible to trigger an update of the log manually by running Contribution Every contr","default_branch":null,"files":null,"tree":[],"storefront":"/r/nioe","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/nioe/madr-tools/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}