vspec

vspec is a Cockburn-style use case management tool for teams coordinating human and AI contributors around explicit, versioned product behavior. It ships a Fastify API, Prisma persistence, and an oclif CLI for authoring, reviewing, and exporting use case specifications.

한국어 README

Install

Use the CLI directly from npm:

npx vspec --help

For repeated use, install it globally:

npm install -g vspec
vspec --help

For development from a clean clone:

corepack enable
pnpm install
cp .env.example .env
pnpm -r build

Run

Start the optional local Postgres service, then run the development server:

cp .env.example .env
docker compose up -d db
pnpm run dev

The server exposes GET /healthz on http://localhost:8080 unless PORT is set.

Deploy

Build and run the production-like Docker stack:

cp .env.example .env
VSPEC_AUTH_STUB=1 docker compose -f docker-compose.prod.yml up -d

For real GitHub OAuth, set GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET in the environment before starting the stack. The compose file provides Postgres via DATABASE_URL and publishes the app on ${VSPEC_DEPLOY_HOST_PORT:-4400}.

Documentation

• Overview
• Architecture
• Tech stack
• API contract
• CLI spec
• Autonomous build harness