Name: SpecUI
Author: SpecUI

SpecUI ships as an npm package. There is no separate "SpecUI app" to install — you install the CLI, and it scaffolds .specui/ inside your projects when you ask it to.

Requirements

Requirement	Detail
Node.js	18+ (22 recommended for CI templates from `init`)
npm, pnpm, or yarn	Any package manager that can run `npx`
Git	Optional; used by `init --git`, `push`, `pull`, `load` from git URLs

Recommended: run without installing (npx)

The easiest way to try SpecUI, and the right shape for CI one-liners:

npx @logicplanes/specui@latest --version
npx @logicplanes/specui@latest init --help

In CI, pin a version so builds stay reproducible:

npx -y @logicplanes/specui@2.0.2 validate .specui --strict

Global install

Worth it if you run specui many times a day:

npm install -g @logicplanes/specui
specui --version
specui init --name "Acme" --preset web-app

Update:

npm update -g @logicplanes/specui

Per-project devDependency

If your team pins tooling in package.json:

npm install -D @logicplanes/specui

{
  "scripts": {
    "specui:validate": "specui validate .specui --strict",
    "specui:sync": "specui sync"
  }
}

npm run specui:validate

Use npx specui or ./node_modules/.bin/specui in scripts.

Verify installation

specui doctor          # from a repo that already has .specui/
specui --help          # full command list
specui spec            # print normative SpecUI standard (for agents)

After init, always run:

specui doctor
specui validate .specui

What gets installed on disk

npm install / npx only installs the CLI package (bin, src/, templates). Nothing touches your repo — .specui/ is not created until you run:

specui init    # consumer layout → ./.specui/
specui new     # flat layout → ./SPEC.md at repo root

Editors and agents (optional)

specui init can also write:

AGENTS.md — SpecUI contract block (default: on)
.cursor/rules/specui.mdc, CLAUDE.md, etc. — via --agent-tools
GitHub Actions workflow — via --ci github

See Agents & MCP and init reference.

Offline / air-gapped

On a connected machine: npm pack @logicplanes/specui
Copy the .tgz to the restricted environment
npm install -g ./logicplanes-specui-*.tgz
Scaffold with specui init (templates are inside the package)

Registry commands (specui get) need network unless you use specui get --from file:///path/item.json.

Next steps

Quick start — scaffold your first .specui/
Concepts — consumer vs flat, registry, validation
Scenarios — choose a preset and workflow for your repo type

Install