Your docs, always up to date. Automatically.
DocuPilot generates and updates your README, API documentation, and CHANGELOG every time you push to GitHub. Install the GitHub App, push your code, and get a pull request with updated docs — zero config required.
Get Started Free — No credit card required.
- Install — Add the PushDocs GitHub App to your repositories
- Push — Push code as you normally do
- Review — DocuPilot opens a PR with updated documentation
DocuPilot reads your codebase, understands the changes, and generates accurate documentation using AI. You review and merge — that's it.
- README generation — Keeps your README in sync with your actual code
- CHANGELOG updates — Automatically documents what changed and why
- API documentation — Generates docs from your API endpoints and types
- Zero config — Works out of the box with sensible defaults
- Customizable — Fine-tune behavior with
.docupilot.yml - Pull request workflow — All changes come as reviewable PRs, never direct commits
docupilot-demo — Fork the template repo, push a change, and see DocuPilot generate docs in 30 seconds.
See real auto-generated PRs:
- docupilot#2 — README + CHANGELOG update (+57 lines)
- docupilot-action#1 — README + CHANGELOG (+38 lines)
Prefer CI/CD? Use the DocuPilot Action — same AI doc generation, runs in your workflow:
- uses: AkrMcmr/docupilot-action@v1
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}Create a .docupilot.yml in your repository root to customize behavior:
# Which docs to generate (all true by default except api_docs)
generate:
readme: true
changelog: true
api_docs: false
# Documentation language
language: en
# Files/patterns to exclude from analysis
ignore:
- "**/*.test.ts"
- "**/__snapshots__/**"
- "node_modules/**"
# Auto-merge generated PRs (default: false)
auto_merge: false
# Additional instructions for the AI
custom_instructions: "Use concise language. Focus on usage examples."If no config file is present, DocuPilot uses sensible defaults (README + CHANGELOG, English, no auto-merge).
| Plan | Price | Repos | Features |
|---|---|---|---|
| Free | $0/mo | 1 | README, CHANGELOG |
| Starter | $9/mo | Up to 5 | README, CHANGELOG |
| Pro | $29/mo | Unlimited | All docs + API docs + custom templates |
Competitors like Mintlify charge $300+/mo. DocuPilot starts free.
- Next.js — App framework
- Vercel — Hosting & deployment
- GitHub App — Repository integration
- Claude API — AI documentation generation
- Stripe — Billing & subscriptions
npm install
npm run devRequires environment variables — see .env.example for the full list.
Proprietary. All rights reserved.