Skip to main content

Storypole

A story pole is a stick a mason marks once at the start of a job. Every bricklayer on the wall works from it, so all their courses land at exactly the same heights — one shared reference, many parallel workers, no drift.

Storypole applies that to a team of 5–6 people building one prototype: a git-backed registry of features, each a markdown file with an owner, a phase and a lock, from which the PRD is generated rather than hand-written.

Install

pipx install storypole      # or: pip install storypole / npx storypole
storypole quickstart        # five-minute onboarding

The npm package is a launcher for the same Python tool — there is deliberately only one implementation of the rules.

Bootstrap from a running app

One person runs this once, before the team starts:

storypole init
storypole scan http://localhost:3000

It writes a route inventory, per-route screenshots, and a DESIGN-SYSTEM.md ranked by occurrence frequency, then flags failing routes — which is how you tell released from half-built. Playwright is optional (pip install 'storypole[scan]'); without it the command explains the manual alternative.

A scan tells you what an app does, never what it is for, so bootstrap ends in an interview with whoever owns the prototype.

Daily use

storypole list --available          # unowned, unlocked, unblocked
storypole claim   F-002 --as sam
storypole lock    F-002 --as sam
storypole impact  F-002 --as sam    # required before bump
storypole bump    F-002 --as sam
storypole advance F-002 --as sam    # next phase, gated
storypole prd build

Set STORYPOLE_USER and drop the --as. Every command takes --json; exit codes are the contract: 0 proceed, 1 blocked. Guidance goes to stderr, so the rules reach an agent that never reads an instruction file.

Phases

discovery -> defined -> designing -> building -> validating -> released
                                                            -> retired

A feature enters a phase only when that phase's artifact exists: an owner, acceptance criteria and an out-of-scope section before development; a passing smoke test and a current PRD before validation; a recorded learning before release. That is what turns the phase field from a label into a lifecycle.

Enforcement

storypole install-hooks     # pre-commit: blocks edits to someone else's lock
storypole emit --ci         # CI check + CODEOWNERS template
storypole emit              # AGENTS.md, CLAUDE.md, .cursor/rules/, ...

PROTOCOL.md is the tool-agnostic source of truth; every agent instruction file is generated from it, because six hand-maintained instruction files drift within a week.

What it does not guarantee

The lock is a convention, not a security boundary. The tool refuses the operation and a cooperating agent honours it, but anyone can edit frontmatter by hand, and the pre-commit hook is skippable with --no-verify. Only CODEOWNERS on features/ plus branch protection is real enforcement, because it runs on the server.

Repository layout

storypole/            the Claude skill bundle (SKILL.md + references/)
packages/python/      the storypole CLI, published to PyPI
packages/npm/         a launcher, published to npm

License

MIT

Metadata

Release files for storypole 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for storypole 0.1.0
File Size Uploaded Provenance Actions
storypole-0.1.0.tar.gz 27.3 kB Without provenance Details for storypole-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for storypole 0.1.0
File Interpreter ABI Platform Actions
storypole-0.1.0-py3-none-any.whl Python 3 none any Details for storypole-0.1.0-py3-none-any.whl

Total release size: 61.4 kB

Release files / storypole-0.1.0.tar.gz

Download URL storypole-0.1.0.tar.gz
Size 27.3 kB
Tags Source
SHA-256 checksum
How to use checksums
763e30091b1725bb326525605cd530abe855512c4a747be1990048ab22ef703c
BLAKE2b-256 checksum
How to use checksums
287d7e18d7f624b2122767d674a8489418960cc7ea5ec595f3a49725432e609c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.5

Release files / storypole-0.1.0-py3-none-any.whl

Download URL storypole-0.1.0-py3-none-any.whl
Size 34.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
389a8ec118663ccb2f824169e3af4c9acd51456418c2c7a43e74e58304b84d08
BLAKE2b-256 checksum
How to use checksums
e670828c4f0b7d5d29968b6af9875b1d56a5dbcea4be64b0ef50da49f127667f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.5

Security for storypole 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page