{"id":31818894,"url":"https://github.com/yotpoltd/cadr","last_synced_at":"2026-02-26T11:22:45.481Z","repository":{"id":318209737,"uuid":"1070336426","full_name":"YotpoLtd/cADR","owner":"YotpoLtd","description":"🤖 AI-powered ADR generation - Automatically capture and document architectural decisions as you code ","archived":false,"fork":false,"pushed_at":"2026-01-11T20:14:29.000Z","size":574,"stargazers_count":10,"open_issues_count":4,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-01-27T04:39:05.384Z","etag":null,"topics":["adr","architectural-decision-records","cicd","coding-agents","continues-ai","documentation","llm","precommit-hooks"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/cadr-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YotpoLtd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-05T18:14:16.000Z","updated_at":"2026-01-05T10:11:31.000Z","dependencies_parsed_at":"2025-10-30T15:28:35.488Z","dependency_job_id":null,"html_url":"https://github.com/YotpoLtd/cADR","commit_stats":null,"previous_names":["yotpoltd/cadr"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/YotpoLtd/cADR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YotpoLtd%2FcADR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YotpoLtd%2FcADR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YotpoLtd%2FcADR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YotpoLtd%2FcADR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YotpoLtd","download_url":"https://codeload.github.com/YotpoLtd/cADR/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YotpoLtd%2FcADR/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29489333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T19:29:10.908Z","status":"ssl_error","status_checked_at":"2026-02-15T19:29:10.419Z","response_time":118,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","cicd","coding-agents","continues-ai","documentation","llm","precommit-hooks"],"created_at":"2025-10-11T11:21:30.947Z","updated_at":"2026-02-15T21:01:54.678Z","avatar_url":"https://github.com/YotpoLtd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cADR - Continuous Architectural Decision Records\n\n[![Test](https://github.com/YotpoLtd/cADR/actions/workflows/test.yml/badge.svg)](https://github.com/YotpoLtd/cADR/actions/workflows/test.yml)\n[![npm version](https://badge.fury.io/js/cadr-cli.svg)](https://www.npmjs.com/package/cadr-cli)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\u003e Automatically capture and document architectural decisions as you code.\n\nStop losing track of important architectural decisions. cADR analyzes your code changes with LLMs and generates comprehensive ADRs automatically, keeping your documentation in sync with your code.\n\n## ✨ Why cADR?\n\n- **Never miss a decision**: Automatically detects architecturally significant changes\n- **Stay in flow**: Works with your existing Git workflow, never blocks commits\n- **AI-powered documentation**: Generates comprehensive ADRs in MADR format\n- **Smart and fast**: Analyzes only what matters with configurable ignore patterns\n\n## 🚀 Quick Start\n\nGet cADR running in under 2 minutes:\n\n```bash\n# Install\nnpm install -g cadr-cli\n\n# Set your API key (choose one)\nexport OPENAI_API_KEY=\"sk-your-api-key-here\"\n# OR\nexport GEMINI_API_KEY=\"your-api-key-here\"\n\n# Navigate to your Git repository\ncd /path/to/your/repo\n\n# Initialize configuration\ncadr init\n\n# Make some changes, then analyze\ncadr analyze\n```\n\n**[→ Full Quick Start Guide with Examples](./docs/QUICK_START.md)**\n\n## 🎯 Key Features\n\n- 🤖 **LLM-Powered Analysis** - OpenAI and Gemini integration to detect architecturally significant changes\n- 📝 **Automated ADR Generation** - Generates comprehensive Markdown ADRs following the MADR template format\n- ⚡ **Git Integration** - Analyzes staged changes, uncommitted changes, or commit ranges\n\n## 📚 Documentation\n\n### For Users\n\n- **[Quick Start Guide](./docs/QUICK_START.md)** - Get started in 5 minutes\n- **[Usage Guide](./docs/USAGE.md)** - Detailed command reference and configuration\n- **[ADR Generation](./docs/ADR_GENERATION.md)** - How automatic ADR creation works\n- **[MADR Template](./docs/MADR_TEMPLATE.md)** - ADR format reference\n\n### For Contributors\n\n- **[Contributing Guide](./CONTRIBUTING.md)** - How to contribute to cADR\n- **[Development Setup](./DEVELOPMENT.md)** - Set up your local dev environment\n- **[Testing Guide](./TESTING.md)** - Running and writing tests\n\n## 📦 Installation\n\n### Quick Install\n\n```bash\nnpm install -g cadr-cli\n```\n\n### Verify Installation\n\n```bash\ncadr --version\n# Output: cADR version 0.0.1 (core: 0.0.1)\n```\n\nFor more installation options and configuration, see the [Usage Guide](./docs/USAGE.md).\n\n## 🔧 Configuration\n\ncADR is configured via `cadr.yaml` in your project root. Run `cadr init` to create it interactively, or create it manually:\n\n```yaml\nprovider: openai\nanalysis_model: gpt-4\napi_key_env: OPENAI_API_KEY\ntimeout_seconds: 15\nignore_patterns:\n  - node_modules/**\n  - \"*.test.ts\"\n  - dist/**\n```\n\n**Supported Providers:**\n\n- **OpenAI**: All OpenAI chat models\n- **Gemini**: All Google Gemini models\n\nSpecify any model name supported by your chosen provider. See the [Usage Guide](./docs/USAGE.md#configuration) for all configuration options.\n\n## 🏗️ What Gets Generated?\n\nWhen cADR detects an architecturally significant change, it generates a comprehensive ADR including:\n\n- **Context and Problem Statement** - Why the decision was needed\n- **Decision Drivers** - Key factors influencing the choice\n- **Considered Options** - Alternative approaches evaluated\n- **Decision Outcome** - The chosen approach and detailed rationale\n- **Consequences** - Both positive and negative impacts\n\nGenerated ADRs follow the [MADR (Markdown Architectural Decision Records)](https://adr.github.io/madr/) format with sequential numbering.\n\n📖 **[Learn More About ADR Generation →](./docs/ADR_GENERATION.md)**\n\n## 🤝 Contributing\n\nWe welcome contributions! Whether you're fixing bugs, adding features, or improving documentation:\n\n1. Read the [Contributing Guide](./CONTRIBUTING.md)\n2. Set up your [Development Environment](./DEVELOPMENT.md)\n3. Check out the [Testing Guide](./TESTING.md)\n4. Submit a Pull Request\n\n## 🆘 Support \u0026 Community\n\n- 📖 [Documentation](./docs) - Comprehensive guides and references\n- 🐛 [Report Issues](https://github.com/YotpoLtd/cADR/issues) - Found a bug?\n- 💬 [Discussions](https://github.com/YotpoLtd/cADR/discussions) - Questions and ideas\n- 🔄 [Changelog](./CHANGELOG.md) - What's new in each release\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**[Quick Start](./docs/QUICK_START.md)** • **[Usage Guide](./docs/USAGE.md)** • **[Contributing](./CONTRIBUTING.md)** • **[Development](./DEVELOPMENT.md)**\n\nMade with ❤️ by the cADR team\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyotpoltd%2Fcadr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyotpoltd%2Fcadr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyotpoltd%2Fcadr/lists"}