{"id":17776548,"url":"https://github.com/keremciu/adr-tool","last_synced_at":"2025-03-15T17:31:35.430Z","repository":{"id":39579300,"uuid":"357924011","full_name":"keremciu/adr-tool","owner":"keremciu","description":"A simple CLI for Architectural Decision Records.","archived":false,"fork":false,"pushed_at":"2022-05-31T22:17:19.000Z","size":1514,"stargazers_count":19,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-10T13:06:15.467Z","etag":null,"topics":["adr","architectural-decision-records","cli"],"latest_commit_sha":null,"homepage":"https://adr.github.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keremciu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-14T13:56:34.000Z","updated_at":"2024-08-10T19:17:08.000Z","dependencies_parsed_at":"2022-08-24T14:32:51.140Z","dependency_job_id":null,"html_url":"https://github.com/keremciu/adr-tool","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keremciu%2Fadr-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keremciu%2Fadr-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keremciu%2Fadr-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keremciu%2Fadr-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keremciu","download_url":"https://codeload.github.com/keremciu/adr-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243766721,"owners_count":20344802,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adr","architectural-decision-records","cli"],"created_at":"2024-10-26T22:06:05.218Z","updated_at":"2025-03-15T17:31:35.039Z","avatar_url":"https://github.com/keremciu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"adr-tool\n========\n\neasy CLI for ADR docs\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n[![Version](https://img.shields.io/npm/v/adr-tool.svg)](https://npmjs.org/package/adr-tool)\n[![Downloads/week](https://img.shields.io/npm/dw/adr-tool.svg)](https://npmjs.org/package/adr-tool)\n[![License](https://img.shields.io/npm/l/adr-tool.svg)](https://github.com/keremciu/adr-tool/blob/main/package.json)\n\n\u003c!-- toc --\u003e\n* [Demo](#demo)\n* [Usage](#usage)\n* [Commands](#commands)\n\u003c!-- tocstop --\u003e\n\n# Demo\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://youtu.be/lesHQoZ7qYY\" title=\"Click to watch the full screencast\"\u003e\n    \u003cimg src=\"demo.gif\" alt=\"adr-tool demo\" width=\"838\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://youtu.be/lesHQoZ7qYY\"\u003e🎞️ Watch the full screencast\u003c/a\u003e\u003c/p\u003e\n\n# Usage\n\nYou can install it globally (`npm install -g adr-tool`) or use it with [npx](https://docs.npmjs.com/cli/v7/commands/npx)\n\n```sh-session\n$ npx adr-tool init\n./docs/adr folder is created!\n$ npx adr-tool create Use Markdown Architectural Decision Records\na decision created on ./docs/adr/0000-use-markdown-architectural-decision-records.md\n```\n# Commands\n\u003c!-- commands --\u003e\n* [`adr-tool create [TITLE]`](#adr-tool-create-title)\n* [`adr-tool help [COMMAND]`](#adr-tool-help-command)\n* [`adr-tool init`](#adr-tool-init)\n* [`adr-tool toc`](#adr-tool-toc)\n\n## `adr-tool create [TITLE]`\n\ncreate a new decision and log it into docs/adr/README.md file\n\n```\nUSAGE\n  $ adr-tool create [TITLE]\n\nARGUMENTS\n  TITLE  title of the decision\n\nOPTIONS\n  -h, --help                               show CLI help\n  -t, --ticket=ticket                      technical ticket\n  --status=accepted|deprecated|superseded\n\nEXAMPLE\n  $ adr-tool create Use ADR Tool\n  a decision created on ./docs/adr/0000-use-adr-tool.md\n```\n\n_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.3.0/src/commands/create.ts)_\n\n## `adr-tool help [COMMAND]`\n\nDisplay help for adr-tool.\n\n```\nUSAGE\n  $ adr-tool help [COMMAND]\n\nARGUMENTS\n  COMMAND  Command to show help for.\n\nOPTIONS\n  -n, --nested-commands  Include all nested commands in the output.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_\n\n## `adr-tool init`\n\ncreate docs/adr folder and copies template.md and README.md\n\n```\nUSAGE\n  $ adr-tool init\n\nOPTIONS\n  -h, --help  show CLI help\n\nEXAMPLE\n  $ adr-tool init\n  ./docs/adr folder is created!\n```\n\n_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.3.0/src/commands/init.ts)_\n\n## `adr-tool toc`\n\ncreate docs/adr/README.md file\n\n```\nUSAGE\n  $ adr-tool toc\n\nOPTIONS\n  -h, --help  show CLI help\n\nEXAMPLE\n  $ adr-tool toc\n  ./docs/adr/README.md file is created!\n```\n\n_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.3.0/src/commands/toc.ts)_\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeremciu%2Fadr-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeremciu%2Fadr-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeremciu%2Fadr-tool/lists"}