Docs/Get Started/Install

Install

Throughspec ships on two channels from a single source-of-truth template tree, so the trees never drift byte-for-byte.

npm (Node.js ≥ 18)

Distributed as ESM. One-off run via npx or install globally.

# one-off scaffold
npx spec-init my-app

# or install globally
npm i -g spec-init

PyPI (Python ≥ 3.10)

Distributed as a pure-Python wheel. pipx keeps it isolated from your other Python tools.

pipx install spec-init
# or
pip install spec-init

Flags

--persona <name>vibe | student | engineer | team - pre-tunes CLAUDE.md and the learning map.

--integrations <csv>graphify,obsidian - activates the relevant integration blocks and drops in their config files.

--forceRequired to overwrite an existing project. init refuses otherwise.

--dry-runPrints the file plan without writing anything.

Verify

Once installed, spec-init doctor validates that a scaffolded project has all the required files, that CLAUDE.md carries a template-version, and that the .spec-init/base/ snapshot exists.

cd my-app
spec-init doctor

No native binaries

Nothing compiled is required at install time. The Node CLI is pure JS; the Python CLI is pure Python. macOS, Linux, and Windows (PowerShell + WSL) are all supported.