What problem does it solve?
This tool automates the creation of comprehensive technical specifications from GitHub Pull Requests, replacing manual, error-prone documentation efforts with an automated, repeatable process.
Core Features & Use Cases
- Analyze PR metadata, commits, and diffs using gh CLI and git to produce a structured Markdown specification.
- Detect and summarize changes across folders, the DB schema, APIs, tests, and dependencies for quick impact assessment.
- Real-world use: given a PR with schema and API changes, generate a complete spec including folder structure, change history, and impact analysis for reviewers and onboarding docs.
Quick Start
Run the spec generator for a PR: python scripts/generate_spec.py https://github.com/owner/repo/pull/123
Optionally specify the repository path: python scripts/generate_spec.py https://github.com/owner/repo/pull/123 --repo-path /path/to/repo
Optionally specify an output directory: python scripts/generate_spec.py https://github.com/owner/repo/pull/123 --output-dir /path/to/output