Installation · Specistry Docs

Requirements

Node 24.20 or newer within Node 24
npm or pnpm
A project folder (an existing repository works)

Install

npm

npm install --save-dev @specistry/cli
npx specistry --help

pnpm

pnpm add --save-dev @specistry/cli
pnpm exec specistry --help

WarningRelease candidate

Release candidates are published under the next tag, never latest. Pin the exact version so CI and laptops build the same thing.

Add scripts

Scripts keep commands identical for everyone on the team and in CI.

package.json

{
  "scripts": {
    "docs:validate": "specistry validate",
    "docs:build": "specistry build",
    "docs:check": "specistry check"
  },
  "devDependencies": {
    "@specistry/cli": "0.1.0-rc.3"
  }
}

Edge cases

Running from a sub-folder

Config not found

✕ FAILS

terminal

cd docs
npx specistry build

✓ FIX

terminal

npx specistry build --root ..

The CLI never searches parent directories.

Importing internal packages

Unsupported interface

✕ FAILS

specistry.config.ts

import { defineConfig } from "@specistry/cli/src/config";

✓ FIX

specistry.config.ts

import { defineConfig } from "@specistry/config";

Only the published entry points are supported.