Skip to main content

Throughspec - Spec-driven. Drift-proof. Token-lean. Scaffolds a Claude Code project around a deterministic SDLC.

Project description

spec-init

PyPI version Python versions license

Throughspec - spec-driven, drift-proof, token-lean scaffolding for Claude Code. spec-init bootstraps a project around a deterministic, spec-first SDLC: you make the decisions, Claude does the heavy lifting, and a fixed structure keeps the work from drifting.

The same CLI ships on PyPI (this package) and npm from one source-of-truth template tree, verified byte-for-byte.

Install

# recommended (isolated)
pipx install spec-init
spec-init my-project

# or regular pip
pip install spec-init
spec-init my-project

Requires Python ≥ 3.10.

Quickstart

# scaffold, then open in Claude Code and run /spec-requirements
spec-init my-project
cd my-project

Run with no arguments in a terminal for an interactive welcome (new-vs-existing, persona, integrations). In a non-interactive shell (CI, pipes) it prints help instead, so scripts are unaffected.

spec-init <name> scaffolds the canonical Throughspec tree:

my-project/
├── CLAUDE.md
├── README.md
├── CHANGELOG.md
├── SECURITY.md
├── CONTRIBUTING.md
├── claude/
│   ├── srs.md
│   ├── plan.md
│   ├── context.md
│   ├── features.md
│   ├── design-decisions.md
│   └── learnings.md
├── design/
│   └── design.md
├── .claude/
│   ├── skills/
│   └── agents/
└── .spec-init/base/    # pristine snapshot for upgrade

Commands

Command Purpose
spec-init With no args on a terminal, launch the interactive welcome
spec-init init <name> Scaffold a new project into <name>/
spec-init reinit [dir] Adopt Throughspec in an existing project in place (non-destructive)
spec-init customize --add / --remove <name> Toggle an integration in an existing project
spec-init customize --persona <name> Swap the CLAUDE.md persona block
spec-init add-skill <name> Copy one skill from the payload catalog into .claude/skills/
spec-init upgrade Three-way-merge a newer template payload into an existing project
spec-init doctor Verify a scaffolded project's shape

Flags

  • --persona vibe|student|engineer|team - which CLAUDE.md persona block to keep.
  • --integrations <csv> - activate integrations at scaffold time (see below).
  • --force - overwrite an existing directory (init) or replace existing spec files (reinit).
  • --dry-run - print the plan without writing files.
  • -h, --help / -v, --version.

Integrations

Opt-in, free/open-source tools layered in without touching your source. Add at scaffold time (--integrations graphify,caveman) or later (spec-init customize --add obsidian); remove with customize --remove <name>.

graphify, obsidian, caveman, agentmemory, openwiki, ponytail, opencodereview.

See the Integrations docs for what each does.

Both channels produce byte-identical scaffolded trees for every persona/integration combination, enforced by a cross-language parity test.

The .spec-init/base/ snapshot

init writes a pristine copy of the payload into <project>/.spec-init/base/. upgrade uses it as the common ancestor for its three-way merge; doctor checks it exists. Don't edit files under .spec-init/ - they are the CLI's private state.

Links

License

MIT © Vishal Patil

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spec_init-1.0.0.tar.gz (78.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spec_init-1.0.0-py3-none-any.whl (115.3 kB view details)

Uploaded Python 3

File details

Details for the file spec_init-1.0.0.tar.gz.

File metadata

  • Download URL: spec_init-1.0.0.tar.gz
  • Upload date:
  • Size: 78.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for spec_init-1.0.0.tar.gz
Algorithm Hash digest
SHA256 53289e46f53a0afad83618f704cf7c1839d8a6b948a60407e8f8ee9dc5ed927e
MD5 52de9960b58db555372bead89e3aac7c
BLAKE2b-256 02afdb44150c38e8f3907c1ebcb5db1ceea9b7c208a9cc57178326e954e544d0

See more details on using hashes here.

File details

Details for the file spec_init-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: spec_init-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 115.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for spec_init-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9222777940ab859ef0499af0f8c7d7d65cdf87cd743ed4e4128329383f847788
MD5 c559415e1f38ad489f953afa03ec3f22
BLAKE2b-256 d178d802a511d19e53109142769fecd1aae7af054b73785f05cfd65d11abbf4c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page