omni-reverse

Co-OmniSpec

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

Co-OmniSpec is an open-source toolkit that turns intent into structured specifications, design artefacts, and dependency-aware tasks, and then drives an AI coding agent through implementation. It is a localized and extended adaptation of GitHub Spec Kit, optimised for Claude Code and other agent environments.

Co-OmniSpec ships as two plugins from the CoMind-plugins marketplace: omni-dsdd for the Spec-Driven Development pipeline and omni-reverse for the reverse-engineering side. Both must be installed together.

---

Table of Contents

1. Project Overview & Spec-Driven Development
2. Plugin Responsibilities
3. Prerequisites
4. Install Commands
5. First Use
6. Workflow Map (express / standard / deep / expert)
7. Using Reverse Engineering
8. Repository Layout
9. Troubleshooting
10. Contributing & Security
11. Acknowledgements & License

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

---

1. Project Overview & Spec-Driven Development

Spec-Driven Development flips the traditional code-first workflow: specifications drive implementation. You write the what and why in natural language; your AI agent translates them into structured specifications, design notes, dependency-aware tasks, and finally code.

Co-OmniSpec provides:

• A constitution that anchors every step in project-level principles.
• A repeatable pipeline: constitution → specify → clarify → design → tasks → implement → archive.
• Built-in support for brownfield work through reverse engineering of existing code.
• Quality gates at each stage (clarify, analyze, checklist, review).

---

2. Plugin Responsibilities

Co-OmniSpec is two plugins in one marketplace. They share runtime assets but each focuses on half of the workflow:

Plugin	Marketplace name	Focus	Plugin-local skills (highlights)	Shared assets
omni-dsdd	CoMind-plugins	The Spec-Driven Development pipeline: harness, slash commands, shared templates, scripts, workflow YAML.	specify, clarify, design, tasks, implement, archive, analyze, checklist, constitution, routing, workflow-orchestrator, knowledge-retrieval, create-branch, sdd, and the on-demand reverse-on-demand.	Owns .omni-infra/ (config, memory, metamodel, scripts, templates).
omni-reverse	CoMind-plugins	Reverse engineering of existing code into SDD artefacts.	reverse, reverse-orchestration, reverse-shared, reverse-logic-architecture, reverse-deep-logic-architecture, reverse-interfaces, reverse-external-interfaces, reverse-functions, reverse-entities, reverse-scenarios, reverse-requirements, reverse-rules.	Depends on omni-dsdd; resolves ${DSDD} through scripts/resolve-dsdd-root.{sh, py, ps1}.

Both plugins must be installed side by side. omni-reverse cannot run without omni-dsdd; the DSDD pipeline benefits from omni-reverse whenever the project has existing code to document.

---

3. Prerequisites

Requirement	Notes
Claude Code	code.claude.com with plugin marketplace support.
Git	Used for feature branches and the changes/ directory.
Bash or PowerShell	Required to execute the shared scripts under .omni-infra/scripts/.
Node + pnpm (optional)	Needed only when validating the plugin's own skills locally (pnpm validate inside omni-dsdd/); see CONTRIBUTING.md.

---

4. Install Commands

Add the marketplace and install both plugins:

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

The first command is also accepted as /market add ZTE-AICloud/Co-OmniSpec.

Equivalent CLI form (for non-interactive shells or CI):

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

Verify:

1. /plugin marketplace list (or /market list) — CoMind-plugins is registered.
2. /plugin (Discover) — both omni-dsdd and omni-reverse are listed and enabled.
3. In your project workspace, open AI chat and check that /constitution, /specify, /reverse, /routing are visible.