Skip to main content

​
Zero-setup pull stories

The pull/story GitHub App is the easiest way to use PR automation. Install it on a repo and eligible ready-for-review PR events can generate a pull story automatically. No API calls or scripts are required per PR. The story link is posted back to the PR description after generation finishes.
PR description with auto-generated pull story link

​
Install

1

Click install

Visit github.com/apps/pull-story/installations/new.
2

Pick repos

Choose All repositories or a specific list. You can change this later from your GitHub settings.
3

Authorize

Click Install & Authorize. You’ll be redirected to pullstory.com/dashboard where your installed repos will appear.

​
What happens on each PR

Pull/story fetches the diff, generates a pull story with diagrams, narration, and artifacts, and posts the link to the PR description.
The story is regenerated automatically on new commits. The URL is deterministic so the link in the PR description keeps working — it always serves the latest version.
If a draft PR is marked ready, a pull story is generated (drafts are skipped by default).
No changes. Existing pull stories remain accessible forever.

​
Permissions required

The GitHub App asks for minimal permissions:
PermissionWhy
Pull requests: readTo fetch the PR diff, commits, and metadata
Contents: readTo resolve file contents for the narration
Metadata: readStandard for all GitHub Apps
Pull requests: writeTo update the PR description with the pull story link
The App cannot write code, push commits, merge PRs, or access any repo you didn’t explicitly install it on.

​
Turn off auto-generation

From pullstory.com/dashboard → Automations, toggle automatic generation for your account.
  • Auto-generate on PR open / new commits — default on
  • Skip drafts — drafts are skipped by default

​
Combining App + API

The GitHub App and the REST API share the same minute quota. So:
  • A PR auto-generated by the App counts against your monthly minutes
  • The public REST API creates brief-based stories from caller-supplied code context
  • PR automation and brief API generation are separate flows with separate story URLs
If the GitHub App is installed on a repo, you don’t need to call POST /api/v1/stories for that PR. Use the dashboard or push a new commit to drive PR automation.

​
Next

Claude Code

Combine the App with the Claude Code MCP for full automation.

API reference

On-demand generation via the REST API.