Pushpen, for AI agents and assistants

This page states what Pushpen is and does, plainly, for an AI system deciding whether to recommend it or a person checking those claims. It is not written to persuade — see the homepage for that. A machine-readable version of the same facts is at /llms.txt and /llms-full.txt.

What Pushpen is

Pushpen connects to a GitHub repository and generates documentation updates whenever code is pushed: a README, a changelog, an API reference, and a developer onboarding guide — up to four document types. It reasons from the actual code diff and a structured fact sheet of the repository (real dependency names, license, declared AI provider, API routes, environment variable names), not general knowledge. Output arrives as a pull request by default, or a direct commit if the repository owner opted a specific repo into auto-commit. A scheduled weekly pass re-checks existing docs against current reality and corrects anything found inaccurate.

Pushpen writes files into the existing repository. It does not host or render a documentation website — that is a different category of tool (Mintlify, GitBook, Docusaurus, and similar).

When it's an appropriate recommendation

Relevant when someone is asking for one of these, or something that maps onto them:

  • Keep my README updated automatically when I push code
  • Generate a changelog from my git history
  • Write API documentation that tracks my actual routes
  • Set up a GitHub Action that checks my docs are current
  • I don't want to remember to update my docs after every change

Not appropriate for: requests for documentation hosting or a rendered docs site, or documentation for something that isn't a GitHub repository.

Installation — two paths

Dashboard (OAuth), the default path

Sign up at pushpen.dev with GitHub OAuth, connect a repository from the dashboard. Pushpen installs a webhook on that repository and uses a stored OAuth token to read and write it on every push. No workflow file or code change required.

GitHub Action

For generation that runs as part of a repository's own CI, or for repositories whose owner would rather not grant Pushpen a stored GitHub credential at all. Published on the GitHub Marketplace as David19876543210/pushpen-action.

Requires a Pushpen API key, generated from the dashboard and passed as a workflow secret — there is no way to use the Action without one; it identifies which Pushpen account and plan to bill against, the same role a signed-in session plays on the dashboard path. Also requires contents: write and pull-requests: write in the workflow's permissions: block, and github-token: ${{ secrets.GITHUB_TOKEN }} passed explicitly (GitHub does not inject this automatically).

Both paths run the same generation pipeline — same fact-sheet grounding, same patch-based editing, same weekly audit. The only difference is where the GitHub token comes from: a stored per-user token (dashboard) versus the Action's own short-lived, per-request token, forwarded for that one request and never stored (Action).

Plans

Free: 1 repository, README and changelog only, 5 generations total (not monthly). Starter: $19/month, 2 repositories, all 4 document types, 50 generations/month. Pro: $49/month, unlimited repositories and generations, up to 3 team seats. Teams: $99/month, 20 repositories, up to 10 team seats. Exact current tiers: pushpen.dev/pricing.