Skip to content

davidnguyen/speci5

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

speci5

A spec-driven development framework for AI-assisted coding. Gives your AI coding agent a structured workflow: initbrainstormspecifyplanimplementcheck.

Install

Add speci5 to any project:

npx @atheneworkai/speci5 init

Or install skills at the user level (available across all projects):

npx @atheneworkai/speci5 init --user

Options:

  • --user — Install skills to ~/.claude/skills/ instead of the project's .claude/skills/
  • --force — Overwrite existing files without prompting

This copies the skill definitions into your project (or home directory) and creates a .speci5.config.yml to remember your configuration:

.claude/skills/              # Skill definitions (slash commands)
.spec/PRD.<domain>.md        # Domain PRD (one per domain, created by /speci5-init)
.spec/design-systems/        # Design system definitions (created by /speci5-design)
.spec/features/              # Structured specs land here
.speci5.config.yml           # Remembers scope and version

To update to the latest version:

npx @atheneworkai/speci5 update

The update command reads .speci5.config.yml to determine where skills were installed, so you don't need to pass --user again.

Usage

Once installed, the skills are available as /slash commands in Copilot Chat:

Command What it does
/speci5-init Create a PRD.<domain>.md for a new product or domain via guided interview
/speci5-brainstorm Add, change, or remove features in an existing domain PRD
/speci5-design Create or update design systems in .spec/design-systems/
/speci5-spec Transform PRD features into feature and story specs
/speci5-plan Create concrete implementation tasks from a story
/speci5-implement Implement a story's tasks using worktree-isolated agents
/speci5-check Verify code against a story's plan and update progress

Workflow

1. /speci5-init
   → interview to capture domain name, audience, goals
   → writes .spec/PRD.<domain>.md
   → run again to add a second domain (e.g. PRD.admin.md, PRD.api.md)

2. /speci5-brainstorm "user authentication with OAuth"
   → updates .spec/PRD.<domain>.md with the new feature

3. /speci5-design "minimal light theme"
   → writes .spec/design-systems/minimal-light/DESIGN.md
   → selected automatically during /speci5-init if design systems exist

4. /speci5-spec
   → writes .spec/features/user-auth/feature.md
   → writes .spec/features/user-auth/oauth-login/story.md

5. /speci5-plan .spec/features/user-auth/oauth-login
   → writes .spec/features/user-auth/oauth-login/plan.md

6. /speci5-implement .spec/features/user-auth/oauth-login
   → implements tasks from plan.md, checks off completed tasks
   → use --mode sub-agent for parallel implementation

7. /speci5-check .spec/features/user-auth/oauth-login
   → updates plan.md checkboxes, reports progress

How it works

Speci5 is a set of AI coding skills that enforce a spec-driven workflow. Instead of jumping straight to code, you capture ideas, break them into features and stories with acceptance criteria, then create concrete implementation plans — all tracked in .spec/ alongside your code.

See AGENT.md for the full framework reference.

License

MIT

About

A simple spec driven development workflow

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors