Installation · Documentation Specistry

Prérequis

Node 24.20 ou plus récent (branche Node 24)
npm ou pnpm
Un dossier de projet — un dépôt existant convient

Installer

npm

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

pnpm

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

AttentionVersion candidate

Les versions candidates sont publiées sous le tag next, jamais latest. Fixez la version exacte pour que la CI et les postes de l’équipe construisent la même chose.

Ajouter des scripts

Avec des scripts, toute l’équipe — et la CI — lance exactement les mêmes commandes.

package.json

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

Cas particuliers

Lancer la commande depuis un sous-dossier

Config introuvable

✕ ÉCHOUE

terminal

cd docs
npx specistry build

✓ CORRECTION

terminal

npx specistry build --root ..

La CLI ne remonte jamais dans les dossiers parents.

Importer un paquet interne

Interface non prise en charge

✕ ÉCHOUE

specistry.config.ts

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

✓ CORRECTION

specistry.config.ts

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

Seuls les points d’entrée publiés sont garantis.