Skip to main content

​
Zero-setup pull stories

The pull/story GitHub App is the easiest way to use the product. Install it on any repo and every PR you create or get tagged in auto-generates its pull story. No API calls, no scripts, no configuration per-PR. The story link is posted back to the PR description within about 60 seconds of opening.
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 (diagrams + narration + artifacts), and posts the link to the PR description within ~60 seconds.
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 post the pull story link as a PR comment
The App cannot write code, push commits, merge PRs, or access any repo you didn’t explicitly install it on.

​
Turn off auto-generation per repo

From pullstory.com/dashboard → Automations → toggle per-repo settings:
  • Auto-generate on PR open — default on
  • Auto-generate on new commits — default on
  • Skip drafts — default on

​
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
  • A PR re-generated via POST /v1/stories doesn’t double-charge — each distinct head-SHA only bills once
If the GitHub App is installed on a repo, you don’t need to call POST /v1/stories — the story is already there at the deterministic URL pullstory.com/pr/{owner}/{repo}/{number}.

​
Next

Claude Code

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

API reference

On-demand generation via the REST API.