omni

Co-OmniSpec

Build high-quality software faster with Spec-Driven Development.

Co-OmniSpec is an open-source toolkit for Spec-Driven Development: specifications become executable and guide your AI coding agent through specification, design, task breakdown, and implementation. This project is a localized and extended adaptation of GitHub Spec Kit, optimized for Claude Code and other agent environments.

---

Table of Contents

• What is Spec-Driven Development?
• Get Started
• Features
• Development Workflow
• Routing Paths
• Supported Environments
• Core Philosophy
• Development Phases
• Project Structure
• Learn More
• Prerequisites
• Troubleshooting
• Support
• Acknowledgments
• License

中文说明 — 请参阅 README-zh-CN.md。

---

🤔 What is Spec-Driven Development?

Spec-Driven Development flips the script on traditional development: specifications drive implementation. Instead of code-first, you define the what and why first; your AI agent then uses those specs to produce design artifacts, task lists, and code. Co-OmniSpec provides commands and skills so that:

• Specifications are created from natural language and validated with checklists.
• Technical plans and design docs are generated from specs.
• Tasks are ordered by dependency and ready for step-by-step implementation.
• Implementation follows the plan and respects your project constitution.

---

⚡ Get Started

1. Add the Co-OmniSpec marketplace in Claude Code

In your Claude Code session, add the marketplace:

/plugin marketplace add ZTE-AICloud/Co-OmniSpec

You can also use the market shortcut:

/market add ZTE-AICloud/Co-OmniSpec

2. Install the Omni plugin

Install the plugin from marketplace CoMind-plugins:

/plugin install omni@CoMind-plugins

If you prefer command-line mode, run:

claude plugin marketplace add ZTE-AICloud/Co-OmniSpec
claude plugin install omni@CoMind-plugins

3. Establish project principles

Use /constitution to create your project's governing principles and development guidelines:

/constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements.

4. Create the spec

Use /specify and describe what you want to build. Focus on the what and why, not the tech stack:

/specify Build a photo album app. Users can create albums, upload photos, and view them in a grid. Albums are flat (no nesting). No login in this first version.

5. Create a technical plan

Use /design with your tech stack and architecture choices:

/design Use Vite with minimal libraries. Vanilla HTML, CSS, and JavaScript. Store metadata in a local SQLite database.

6. Break down into tasks

Use /tasks to generate an actionable task list from your design:

/tasks

7. Execute implementation

Use /implement to execute all tasks and build the feature:

/implement

For detailed step-by-step instructions, see the Getting Started guide and the User Guide.

---

📋 Features

Area	Description
Constitution	Project principles and guidelines that steer all later phases.
Specify	Turn a short feature description into a full spec (branch, context, spec, requirements checklist).
Clarify	Targeted questions to remove ambiguity before design.
Design	Generate technical plan, data model, contracts, quickstart from spec.
Tasks	Break the plan into ordered, dependency-aware tasks in tasks.md.
Implement	Execute tasks from tasks.md in sequence.
Archive	Archive or merge back completed feature artifacts for project continuity.
Analyze	Cross-artifact consistency checks (spec, design, tasks) before implementation.
Checklist	Custom checklists to validate requirement quality.
Reverse	Reverse-engineer existing code into full specification and context.

Metamodel and templates support requirements, context, scenarios, logic architecture, functions, entities, interfaces, and relations for both greenfield and brownfield workflows.

---

🔄 Development Workflow