Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 3.84 KB

README.en.md

File metadata and controls

90 lines (66 loc) · 3.84 KB

SpecCore — Code by Spec, Not by Vibe

SpecCore is not a code generator — it's a human-AI collaboration operating system. It turns requirements, splitting, planning, execution, and delivery into a closed loop — every step previewable and adjustable, ensuring human and AI reach consensus before a single line of code is written.

Juggling 5 microservices and 3 frontend platforms? SpecCore turns requirements → splits → plans → code → delivery into a traceable, automated pipeline.

  init → doc2spec → analyze → split → plan → execute → pr → done
  🚀Setup   📝Import   🧠Analyze  📦Split  📋Plan  💻Build  🔀PR  ✅Archive
  ✅ CLI    🔒 AI      🔒 AI      🔒 AI     🔒 AI    🔒 AI    🔒 AI  🔒 AI

🚀 5 Minutes to First Task

# CLI usage (direct terminal commands)
npm install -g speccore
speccore init
speccore iteration create -n Q1     # Create iteration

# 🔒 AI usage (in WorkBuddy/Cursor/Trae via @spec-ask)
@spec-ask "import requirements.docx to Q1 iteration"
@spec-ask "analyze Q1 requirements and code health"
@spec-ask "split Q1 iteration into tasks"
@spec-ask "generate execution plan for Q1"
@spec-ask "execute Task-001 with AI"
@spec-ask "archive Task-001 after validation"

📋 Setup Guide — speccore init auto-generates a 6-step onboarding guide:

Setup Guide

🧠 Knowledge Graph Visualization

speccore knowledge generates an interactive HTML knowledge graph with 8 shape types for entity distinction and automatic decay detection:

Full View (Large Nodes)

Knowledge Graph Full

Zoomed View (Compact Layout)

Knowledge Graph Zoom

🎯 What do you want to do?

I want to... Command
Start a new project speccore init --interactive
Import a PRD document @spec-ask "import PRD.docx to Q1" 🔒
Analyze requirements + code health @spec-ask "analyze Q1 requirements" 🔒
Split requirements into tasks speccore iteration split -I Q1 --interactive
Fix a bug speccore task new -n "Login timeout" --type=bugfix
Batch fix bugs speccore task new --batch-file=bugs.xlsx --type=bugfix
Schedule overnight execution speccore schedule create --at "02:00" --all -I Q1
AI auto-development @spec-ask "execute Task-001" 🔒
Create a Pull Request @spec-ask "create PR for Task-001" 🔒
Archive a completed task @spec-ask "archive Task-001" 🔒
Check project status speccore or speccore dashboard
Natural language queries @spec-ask "analyze current requirements" 🔒

📋 Full command reference → Command Reference | 中文文档 → README.zh.md

🤝 Interactive Mode

6 commands support --interactive — preview changes before confirming:

🧠 analyze --interactive 🧠 split --interactive 🧠 plan --interactive
🧠 pr --interactive 🧠 change --interactive 🧠 done --interactive

⏰ Scheduled Execution

speccore task new -n "Data migration" --schedule=night         # Queue for night
speccore schedule create --at "2026-08-10 02:00" --all -I Q1   # Exact time
speccore schedule daemon start                                  # Auto-execute on schedule
# 🔒 AI: @spec-ask "run all scheduled tasks"

📚 Documentation

Doc Content
🚀 Quick Start Full tutorial
🔧 Command Reference All 20 commands
🎬 Scenarios Real-world examples
🗺 Overview Architecture & philosophy
📝 SDD Methodology Spec-driven development