magic-spec 1.5.132 β†’ 1.5.206

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,323 +1,236 @@
1
- # πŸͺ„ Magic Spec
2
-
3
- [![NPM version](https://img.shields.io/npm/v/magic-spec?color=green&label=npm)](https://www.npmjs.com/package/magic-spec)
4
- [![PyPI version](https://img.shields.io/pypi/v/magic-spec?color=blue&label=pypi)](https://pypi.org/project/magic-spec/)
5
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
6
-
7
- ## πŸ“– Description
8
-
9
- **The Specification-Driven Development (SDD) Operating System for AI Coding Agents.**
10
-
11
- Stop your AI from writing fragile code before it fully understands the problem. `magic-spec` installs a high-performance, structured pipeline β€” *Thought β†’ Spec β†’ Task β†’ Run β†’ Code* β€” directly into any project, regardless of the tech stack.
12
-
13
- Whether you are a **coding novice** building your first application or a **senior engineer** architecting enterprise systems, Magic Spec brings **maximum automation** and professional rigor to your development process. It enforces a deterministic workflow that ensures your AI agent perfectly aligns with your vision before writing a single line of code.
14
-
15
- ### The Core Concept
16
-
17
- `magic-spec` is a set of **markdown-based workflow instructions** specifically designed for AI coding agents like Cursor, Windsurf, Claude, and Gemini. It acts as a project-level operating system that orchestrates agentic development.
18
-
19
- Instead of chaotic prompt-engineering, Magic Spec provides a rigorous pipeline:
20
-
21
- ```plaintext
22
- πŸ’‘ Idea β†’ πŸ“‹ Specification β†’ πŸ—ΊοΈ Task & Plan β†’ ⚑ Run β†’ πŸš€ Code
23
- ```
24
-
25
- Once initialized, your AI agent will automatically:
26
-
27
- - Formulate a strong conceptual and technical specification.
28
- - Build a phased implementation plan with hierarchical dependencies.
29
- - Decompose the plan into prioritized, atomic, trackable tasks.
30
- - Facilitate safe architectural brainstorming via **Explore Mode**.
31
- - Analyze its own workflow and suggest improvements via Auto-Retrospectives.
32
-
33
- ### What Gets Installed
34
-
35
- After running the installer, your project directory will be augmented with the following structure:
36
-
37
- ```plaintext
38
- root-project/
39
- β”œβ”€β”€ .agents/workflows/ # Slash commands wrapper (e.g., magic.spec, magic.task)
40
- β”œβ”€β”€ .magic/ # The SDD Engine (workflow logic and scripts - read-only)
41
- └── .design/ # Your Project Design Workspace (INDEX.md, RULES.md, PLAN.md)
42
- ```
43
-
44
- 1. **`.magic/`**: Deploys the core SDD engine.
45
- 2. **`.agents/`**: Sets up workflows for your AI.
46
- 3. **`.design/`**: Initializes your project's workspace for Specifications, Rules, and Plans.
47
-
48
- > [!TIP]
49
- > **Magic Workspaces**: Magic Spec supports multiple, isolated design environments within a single repository (e.g., `.design/engine/`, `.design/installers/`). This allows you to manage fundamentally different project domains without specification overlap, while sharing a single core engine. See [workspaces.md](./workspaces.md) for details.
50
-
51
- ## 🧠 The SDD Philosophy
52
-
53
- > *"No code without a spec. No spec without a plan."*
54
-
55
- Magic Spec is built around a single conviction: **AI agents write better code when they are forced to think before they act.** Left unconstrained, they jump straight to implementation β€” producing code that is fragile, misaligned, and expensive to refactor. Magic Spec installs a structured pipeline that makes this impossible.
56
-
57
- ### Human-Minimal Engineering (Autonomous Partner)
58
-
59
- The core design goal is to **keep humans out of the loop as much as possible** β€” without sacrificing control over what actually matters. Magic Spec moves from manual "Status Gates" to an **Autonomous Partner** model.
60
-
61
- #### Trust Mode: Encapsulated Logic
62
-
63
- Once you describe what you want, the engine takes over:
64
-
65
- - **Type A β€” "AI Trust"**: You provide intent, the agent handles the rest (`Draft -> RFC -> Stable -> Plan -> Run`). The internal SDD ceremony is **encapsulated** β€” you only see the result and a final "Go" gate.
66
- - **Type B β€” "Expert Audit"**: You maintain full control. Inspect `.design/` at any time to review specifications and plans. The rigor is there for when you need it.
67
-
68
- #### Silent Orchestration
69
-
70
- - **Auto-Stabilization**: Specifications are drafted, reviewed, and promoted to `Stable` automatically if the logic is clear.
71
- - **Zero-Prompt Planning**: Tasks are decomposed, prioritized, and scheduled without interrupting your flow.
72
- - **Silent Operations**: Phases execute end-to-end: retrospectives, changelogs, and context regeneration happen silently.
73
- - **Single Execution Gate**: The only mandatory prompt is the final sign-off before implementation begins.
74
-
75
- Everything else is automated. The agent does the engineering. You approve the direction.
76
-
77
- ### Two-Layer Specification Model
78
-
79
- Every specification in Magic Spec belongs to one of two layers, and this separation is strictly enforced:
80
-
81
- **Layer 1 β€” Concept** (`layer: concept`)
82
- Technology-agnostic. Describes *what* the system must do: business rules, domain invariants, data contracts, and behavioral requirements. A Layer 1 spec can be ported to any tech stack without modification. It is the source of truth for the entire implementation.
83
-
84
- **Layer 2 β€” Implementation** (`layer: implementation`)
85
- Stack-specific. Describes *how* a Layer 1 concept is realized in a concrete technology (e.g., a Node.js REST API, a PostgreSQL schema, a React component). Every Layer 2 spec must declare its parent via `Implements: {l1-file.md}` and cannot reach `RFC` or `Stable` status until its parent is `Stable`.
86
-
87
- This separation prevents a common failure mode in AI-assisted development: mixing "what we want" with "how we build it" in a single document, which leads to specs that are impossible to reuse, validate, or evolve independently.
88
-
89
- > **Why this matters in practice:** Imagine you built your backend on Node.js + PostgreSQL. Six months later, performance demands require a migration to Go + ScyllaDB. With a two-layer model, your Layer 1 specs β€” authentication rules, data contracts, business logic β€” remain completely intact. Only the Layer 2 specs are rewritten to reflect the new stack. Your AI agent gets a clean, unambiguous brief for the migration without you having to re-explain the entire domain from scratch.
90
-
91
- ### Integrity by Design
92
-
93
- The engine actively protects specification integrity throughout the project lifecycle:
94
-
95
- - **Quarantine Cascade**: If a Layer 1 spec is destabilized (demoted from `Stable`), all dependent Layer 2 specs are automatically flagged and their tasks are blocked. The plan cannot proceed on a broken foundation.
96
- - **Session Isolation (Phase Gates)**: To prevent AI "hallucinations" and context bleed-over, major workflow transitions enforce a **Hard Stop** (e.g., from Specification to Planning). You are required to physically open a "New Chat" in your IDE to proceed. Simply telling the AI to "forget" does not clear its context window reliably.
97
- - **Registry Parity**: Every spec that exists on disk must be registered in `INDEX.md`. Every registered spec must appear in the implementation plan or the backlog. Orphaned specs are treated as critical blockers.
98
- - **Rules Parity**: If project conventions change (`RULES.md`), any existing task plan is flagged as stale. The agent will not execute tasks generated under outdated rules without an explicit sync.
99
- - **Engine Integrity**: Core engine files are checksummed. Any untracked modification halts all workflows until the engine state is reconciled.
100
-
101
- ### Self-Improving Feedback Loop
102
-
103
- Magic Spec includes a built-in retrospective engine that runs automatically at two levels:
104
-
105
- - **Level 1** fires after every phase completes: captures a lightweight snapshot of spec health, task metrics, and signal status.
106
- - **Level 2** fires when the full plan is complete: performs a deep audit β€” identifying spec drift, blocked-task patterns, shadow logic, and workflow friction β€” then produces actionable recommendations.
107
-
108
- These retrospectives feed back into the specification layer, closing the loop between what was planned and what was actually built.
109
-
110
- ## πŸ–ΌοΈ Visuals
111
-
112
- The engine enforces a rigorous, unskippable pipeline: **Idea β†’ Specification β†’ Task & Plan β†’ Code**. AI agents are prevented from jumping straight to coding. They must first formally specify the solution, then break it down into a concrete plan and tasks, and only then proceed to execution.
113
-
114
- ```mermaid
115
- flowchart TB
116
- IDEA(["πŸ’‘ Idea"])
117
-
118
- subgraph BOX ["Magic Spec"]
119
- direction TB
120
-
121
- SPEC["πŸ“‹ Spec"]
122
-
123
- subgraph TASK ["πŸ—ΊοΈ Task"]
124
- direction TB
125
- PLAN["πŸ“ Plan"]
126
- TASKS["πŸ“Œ Tasks"]
127
- PLAN --> TASKS
128
- end
129
-
130
- RUN["⚑ Run"]
131
-
132
- SPEC --> PLAN
133
- TASKS --> RUN
134
- end
135
-
136
- CODE(["πŸš€ Code"])
137
-
138
- IDEA --> SPEC
139
- RUN --> CODE
140
-
141
- style IDEA fill:#1e1e2e,stroke:#89b4fa,color:#cdd6f4
142
- style CODE fill:#1e1e2e,stroke:#a6e3a1,color:#cdd6f4
143
-
144
- style BOX fill:#181825,stroke:#fab387,stroke-width:3px,color:#fab387
145
-
146
- style SPEC fill:#1e1e2e,stroke:#89b4fa,color:#cdd6f4
147
- style RUN fill:#1e1e2e,stroke:#89b4fa,color:#cdd6f4
148
-
149
- style TASK fill:#11111b,stroke:#89b4fa,stroke-dasharray:5 5,color:#89b4fa
150
- style PLAN fill:#1e1e2e,stroke:#45475a,stroke-dasharray:4 4,color:#cdd6f4
151
- style TASKS fill:#1e1e2e,stroke:#45475a,stroke-dasharray:4 4,color:#cdd6f4
152
- ```
153
-
154
- ## βš™οΈ Requirements
155
-
156
- Before installing Magic Spec, ensure you have one of the following available on your system:
157
-
158
- | Requirement | Details |
159
- | :--- | :--- |
160
- | **Node.js** | Version `16.x` or higher (for `npx` method) |
161
- | **Python** | Version `3.8` or higher (for `uvx` or `pipx` methods) |
162
- | **Git** | Required for installing edge versions directly from GitHub |
163
- | **Terminal** | `tar` utility (pre-installed on Windows/Linux/macOS) |
164
-
165
- ## πŸ“¦ Installation
166
-
167
- Works perfectly with **any project** β€” Rust, Go, Python, JavaScript, C++, or anything else. No runtime lock-in.
168
-
169
- ### Option A: Node.js (`npx`)
170
-
171
- **Stable Release:**
172
-
173
- ```bash
174
- # Basic installation (defaults to .agents/ folder)
175
- npx magic-spec@latest
176
-
177
- # Targeted installation for Cursor
178
- npx magic-spec@latest --cursor
179
- ```
180
-
181
- **Edge Version (GitHub):**
182
-
183
- ```bash
184
- npx --yes github:teratron/magic-spec
185
- ```
186
-
187
- ### Option B: Python (`uvx`)
188
-
189
- **Stable Release:**
190
-
191
- ```bash
192
- # Basic installation
193
- uvx magic-spec
194
-
195
- # Targeted installation for Windsurf
196
- uvx magic-spec --windsurf
197
- ```
198
-
199
- **Edge Version (GitHub):**
200
-
201
- ```bash
202
- uvx --from git+https://github.com/teratron/magic-spec.git magic-spec
203
- ```
204
-
205
- ### Option C: Python (`pipx`)
206
-
207
- ```bash
208
- pipx run magic-spec
209
- ```
210
-
211
- ### Option D: Multi-Adapter Installation
212
-
213
- You can install support for multiple adapters at once:
214
-
215
- ```bash
216
- npx magic-spec@latest --cursor --copilot --windsurf
217
- ```
218
-
219
- ### Option E: Manual Installation
220
-
221
- If automated installers do not fit your environment:
222
-
223
- 1. **Engine**: Download the `.magic/` folder from the [GitHub repository](https://github.com/teratron/magic-spec).
224
- 2. **Workflows**: Download command wrappers from [`workflows/`](https://github.com/teratron/magic-spec/tree/main/workflows).
225
- 3. **Deploy**: Place files into your AI agent's instruction directory (e.g., `.cursor/commands`).
226
-
227
- ## πŸ”„ Updating
228
-
229
- Keep your SDD engine up to date with the latest logic and features:
230
-
231
- ```bash
232
- # Check if update is available
233
- npx magic-spec@latest --check
234
-
235
- # Perform the update
236
- npx magic-spec@latest --update
237
- ```
238
-
239
- > [!TIP]
240
- > The update process preserves your `.design/` workspace and automatically creates backups of `.magic/` and `.agents/` folders. If you have modified core engine files, the installer will detect conflicts and ask for your preference (overwrite, skip, or abort). **After updating Magic Spec, it is highly recommended to run the `/magic.analyze` command to ensure your project's specifications and engine metadata are fully synchronized.**
241
-
242
- ### Post-Install: `.gitignore`
243
-
244
- The installer automatically adds `.magic/` and the adapter directory (e.g., `.agents/`, `.cursor/rules/`) to your project's `.gitignore`. These directories are **installed dependencies** β€” similar to `node_modules/` β€” and should be reinstalled via `npx magic-spec@latest` rather than committed to version control.
245
-
246
- > [!TIP]
247
- > **Vendoring**: If you prefer to commit the engine into your repository (so teammates get it without running the installer), simply remove the `.magic/` and `.agents/` entries from your `.gitignore`.
248
-
249
- ## πŸ’¬ Usage
250
-
251
- Just talk to your AI agent naturally in your prompt interface. No complex commands to learn:
252
-
253
- - *"Dispatch this thought into specs..."* β†’ Triggers **Specification** workflow.
254
- - *"Run a project audit"*, *"magic.analyze"* β†’ Triggers **Analyze** (Ventilation) workflow.
255
- - *"Create an implementation plan"* β†’ Triggers **Task & Plan** workflow.
256
- - *"Execute the next task"* β†’ Triggers **Run** workflow.
257
- - *"Add a rule: always use Inter font"* β†’ Triggers **Rule** workflow.
258
-
259
- ### 🀝 Compatibility
260
-
261
- Magic Spec is heavily optimized and provides native workflow generation for the world's most powerful AI development environments.
262
-
263
- You can install support for a specific adapter using the shortcut flag (e.g., `--cursor`) or the environment flag (e.g., `--env cursor`).
264
-
265
- | AI Agent / IDE | Shortcut Flag | Env Flag |
266
- | :--- | :--- | :--- |
267
- | [**Cursor**](https://cursor.com) (Agent Mode) | `--cursor` | `--env cursor` |
268
- | [**Windsurf**](https://codeium.com/windsurf) (Cascade) | `--windsurf` | `--env windsurf` |
269
- | [**Claude Code**](https://claude.ai/code) | `--claude` | `--env claude` |
270
- | [**Gemini CLI**](https://gemini.google.com) | `--gemini` | `--env gemini` |
271
- | [**GitHub Copilot**](https://github.com/features/copilot) | `--copilot` | `--env copilot` |
272
- | **Roo Code** | `--roo` | `--env roo` |
273
- | **Amp** | `--amp` | `--env amp` |
274
- | **Amazon Q Developer** | `--q` | `--env q` |
275
- | **Kilo Code** | `--kilocode` | `--env kilocode` |
276
- | **Qwen Code** | `--qwen` | `--env qwen` |
277
- | **OpenCode** | `--opencode` | `--env opencode` |
278
- | **SHAI (OVHcloud)** | `--shai` | `--env shai` |
279
- | **IBM Bob** | `--bob` | `--env bob` |
280
- | **CodeBuddy** | `--codebuddy` | `--env codebuddy` |
281
- | **Qoder IDE** | `--qoder` | `--env qoder` |
282
- | **Codex CLI** | `--codex` | `--env codex` |
283
- | **Auggie CLI** | `--augment` | `--env augment` |
284
- | **Antigravity IDE** | `--antigravity` | `--env antigravity` |
285
- | **Lingma IDE** | `--lingma` | `--env lingma` |
286
-
287
- ## πŸ“š Documentation
288
-
289
- - [**Main Documentation**](./docs/README.md) β€” Detailed guide on workflows, architecture, and advanced features.
290
- - [**Installers Guide**](./installers/README.md) β€” Advanced CLI options and platform specifics.
291
- - [**Contributing**](./CONTRIBUTING.md) β€” How to develop, test, and extend the engine.
292
-
293
- ## πŸ›Ÿ Support
294
-
295
- If you encounter issues or have questions:
296
-
297
- - Open an [Issue](https://github.com/teratron/magic-spec/issues) on GitHub.
298
-
299
- ## πŸ—ΊοΈ Roadmap
300
-
301
- - [x] Multi-agent adapter system.
302
- - [x] Phased implementation planning.
303
- - [ ] Extended support for local-first LLM agents.
304
- - [ ] Advanced visual dashboard for project health.
305
- - [ ] Integration with CI/CD for automated spec validation.
306
-
307
- ## πŸ—οΈ Contributing
308
-
309
- We welcome contributions! Whether it's a bug fix, a new adapter, or an improvement to the workflow logic.
310
- Please see [**Contributing Guide**](./CONTRIBUTING.md) for details.
311
-
312
- ## πŸ‘₯ Authors and Acknowledgments
313
-
314
- - **Oleg Alexandrov** β€” Creator and Lead Maintainer.
315
- - Special thanks to the AI agent community for inspiration and testing.
316
-
317
- ## πŸ“„ License
318
-
319
- Distributed under the [MIT License](./LICENSE).
320
-
321
- ## πŸ“Š Project Status
322
-
323
- **Active Development** (v1.5.129). We are constantly refining the SDD engine based on real-world usage.
1
+ # πŸͺ„ Magic Spec
2
+
3
+ [![NPM version](https://img.shields.io/npm/v/magic-spec?color=green&label=npm)](https://www.npmjs.com/package/magic-spec)
4
+ [![PyPI version](https://img.shields.io/pypi/v/magic-spec?color=blue&label=pypi)](https://pypi.org/project/magic-spec/)
5
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
6
+
7
+ ## πŸ“– Description
8
+
9
+ **The Specification-Driven Development (SDD) Operating System for AI Coding Agents.**
10
+
11
+ `magic-spec` installs a structured pipeline β€” *Thought β†’ Spec β†’ Task β†’ Run β†’ Code* β€” directly into any project, regardless of the tech stack. It acts as a set of **markdown-based workflow instructions** for AI coding agents (Cursor, Windsurf, Claude Code, Gemini CLI, and others), enforcing a deterministic process that ensures the AI fully understands the problem before writing code.
12
+
13
+ ```plaintext
14
+ πŸ’‘ Idea β†’ πŸ“‹ Specification β†’ πŸ—ΊοΈ Task & Plan β†’ ⚑ Run β†’ πŸš€ Code
15
+ ```
16
+
17
+ ### What Gets Installed
18
+
19
+ ```plaintext
20
+ your-project/
21
+ β”œβ”€β”€ .agents/workflows/ # Slash commands (magic.spec, magic.task, magic.run, ...)
22
+ β”œβ”€β”€ .magic/ # SDD Engine (workflow logic and scripts β€” read-only)
23
+ └── .design/ # Your Design Workspace (INDEX.md, RULES.md, PLAN.md)
24
+ ```
25
+
26
+ > [!TIP]
27
+ > **Magic Workspaces**: Multiple isolated design environments within a single repo (e.g., `.design/engine/`, `.design/web/`). See [workspaces.md](./workspaces.md) for details.
28
+
29
+ ## βš™οΈ Requirements
30
+
31
+ | Requirement | Details |
32
+ | :--- | :--- |
33
+ | **Node.js** | Version `16.x` or higher (for `npx` method) |
34
+ | **Python** | Version `3.8` or higher (for `uvx` or `pipx` methods) |
35
+ | **Git** | Required for installing edge versions directly from GitHub |
36
+ | **Terminal** | `tar` utility (pre-installed on Windows/Linux/macOS) |
37
+
38
+ ## πŸ“¦ Installation
39
+
40
+ Works with **any project** β€” Rust, Go, Python, JavaScript, C++, or anything else. No runtime lock-in.
41
+
42
+ ### Option A: Node.js (`npx`)
43
+
44
+ **Stable Release:**
45
+
46
+ ```bash
47
+ # Basic installation (defaults to .agents/ folder)
48
+ npx magic-spec@latest
49
+
50
+ # Targeted installation for a specific AI agent
51
+ npx magic-spec@latest --cursor
52
+ npx magic-spec@latest --claude
53
+ npx magic-spec@latest --windsurf
54
+ ```
55
+
56
+ **Edge Version (GitHub):**
57
+
58
+ ```bash
59
+ npx --yes github:teratron/magic-spec
60
+ ```
61
+
62
+ ### Option B: Python (`uvx`)
63
+
64
+ **Stable Release:**
65
+
66
+ ```bash
67
+ # Basic installation
68
+ uvx magic-spec
69
+
70
+ # Targeted installation
71
+ uvx magic-spec --windsurf
72
+ ```
73
+
74
+ **Edge Version (GitHub):**
75
+
76
+ ```bash
77
+ uvx --from git+https://github.com/teratron/magic-spec.git magic-spec
78
+ ```
79
+
80
+ ### Option C: Python (`pipx`)
81
+
82
+ ```bash
83
+ pipx run magic-spec
84
+ ```
85
+
86
+ ### Option D: Multi-Adapter Installation
87
+
88
+ Install support for multiple adapters at once:
89
+
90
+ ```bash
91
+ npx magic-spec@latest --cursor --copilot --windsurf
92
+ ```
93
+
94
+ ### Option E: Manual Installation
95
+
96
+ 1. Download `.magic/` and [`workflows/`](https://github.com/teratron/magic-spec/tree/main/workflows) from the [GitHub repository](https://github.com/teratron/magic-spec).
97
+ 2. Place files into your AI agent's instruction directory (e.g., `.cursor/commands`).
98
+
99
+ ### Post-Install: `.gitignore`
100
+
101
+ The installer automatically adds `.magic/` and the adapter directory (e.g., `.agents/`) to `.gitignore`. These are **installed dependencies** (like `node_modules/`) β€” reinstall via `npx magic-spec@latest` rather than committing.
102
+
103
+ > [!TIP]
104
+ > **Vendoring**: To commit the engine into your repo (so teammates get it without running the installer), remove the `.magic/` and `.agents/` entries from `.gitignore`.
105
+
106
+ ## πŸ”„ Updating
107
+
108
+ ```bash
109
+ # Check if update is available
110
+ npx magic-spec@latest --check
111
+
112
+ # Perform the update
113
+ npx magic-spec@latest --update
114
+ ```
115
+
116
+ > [!TIP]
117
+ > The update preserves your `.design/` workspace and creates backups of `.magic/` and `.agents/`. After updating, run `/magic.analyze` to ensure synchronization.
118
+
119
+ ## πŸ’¬ Usage
120
+
121
+ ### Natural Language
122
+
123
+ Talk to your AI agent naturally β€” it will route to the correct workflow:
124
+
125
+ - *"Create a spec for user authentication"* β†’ **Specification** workflow
126
+ - *"Build an implementation plan"* β†’ **Task & Plan** workflow
127
+ - *"Execute the next task"* β†’ **Run** workflow
128
+ - *"Add a rule: always use Inter font"* β†’ **Rule** workflow
129
+ - *"Run a project audit"* β†’ **Analyze** workflow
130
+
131
+ ### Slash Commands
132
+
133
+ All core workflows are available as slash commands with optional arguments:
134
+
135
+ | Command | Purpose |
136
+ | :--- | :--- |
137
+ | `/magic.spec` | Create or update specifications |
138
+ | `/magic.task` | Generate implementation plan and tasks |
139
+ | `/magic.run` | Execute tasks from the plan |
140
+ | `/magic.rule` | Add or amend project conventions |
141
+ | `/magic.analyze` | Audit project health and detect drift |
142
+
143
+ #### Commands with Arguments
144
+
145
+ Each command accepts optional arguments to scope the operation to a specific **workspace** or provide a **directive**:
146
+
147
+ ```bash
148
+ # No arguments β€” operates across all workspaces
149
+ /magic.spec
150
+ /magic.task
151
+ /magic.run
152
+
153
+ # Workspace-scoped
154
+ /magic.task engine # Plan only for the "engine" workspace
155
+ /magic.run installers # Execute tasks in "installers" workspace
156
+ /magic.analyze engine # Analyze only the "engine" workspace
157
+
158
+ # With directive (quoted text)
159
+ /magic.task "decompose phase-2" # Guided planning with focus
160
+ /magic.run "T-1A01" # Execute a specific task by ID
161
+ /magic.run "phase-2" # Execute all tasks in a phase
162
+ /magic.analyze "check API coverage" # Focused analysis on a specific area
163
+
164
+ # Workspace + directive
165
+ /magic.run installers "phase-1" # Execute phase 1 in "installers" workspace
166
+ /magic.task engine "only new specs" # Plan only new specs in "engine" workspace
167
+ ```
168
+
169
+ > [!NOTE]
170
+ > **For AI IDE users (Cursor, Windsurf, Claude Code, etc.):** When you type `/` in the chat, a dropdown list of available commands appears and selecting one immediately executes it **without arguments**. If you need to pass arguments (workspace name, task ID, directive), **type the full command manually** instead of selecting from the dropdown. For example, type `/magic.run "phase-2"` directly rather than clicking `/magic.run` from the list.
171
+
172
+ ## 🀝 Compatibility
173
+
174
+ Magic Spec provides native workflow generation for all major AI development environments.
175
+
176
+ Install with a shortcut flag (e.g., `--cursor`) or the environment flag (e.g., `--env cursor`).
177
+
178
+ | AI Agent / IDE | Shortcut Flag | Env Flag |
179
+ | :--- | :--- | :--- |
180
+ | [**Cursor**](https://cursor.com) (Agent Mode) | `--cursor` | `--env cursor` |
181
+ | [**Windsurf**](https://codeium.com/windsurf) (Cascade) | `--windsurf` | `--env windsurf` |
182
+ | [**Claude Code**](https://claude.ai/code) | `--claude` | `--env claude` |
183
+ | [**Gemini CLI**](https://gemini.google.com) | `--gemini` | `--env gemini` |
184
+ | [**GitHub Copilot**](https://github.com/features/copilot) | `--copilot` | `--env copilot` |
185
+ | **Roo Code** | `--roo` | `--env roo` |
186
+ | **Amp** | `--amp` | `--env amp` |
187
+ | **Amazon Q Developer** | `--q` | `--env q` |
188
+ | **Kilo Code** | `--kilocode` | `--env kilocode` |
189
+ | **Qwen Code** | `--qwen` | `--env qwen` |
190
+ | **OpenCode** | `--opencode` | `--env opencode` |
191
+ | **SHAI (OVHcloud)** | `--shai` | `--env shai` |
192
+ | **IBM Bob** | `--bob` | `--env bob` |
193
+ | **CodeBuddy** | `--codebuddy` | `--env codebuddy` |
194
+ | **Qoder IDE** | `--qoder` | `--env qoder` |
195
+ | **Codex CLI** | `--codex` | `--env codex` |
196
+ | **Auggie CLI** | `--augment` | `--env augment` |
197
+ | **Antigravity IDE** | `--antigravity` | `--env antigravity` |
198
+ | **Lingma IDE** | `--lingma` | `--env lingma` |
199
+
200
+ ## πŸ“š Documentation
201
+
202
+ | Document | Description |
203
+ | :--- | :--- |
204
+ | [**Main Documentation**](./docs/README.md) | Workflows, architecture, and advanced features |
205
+ | [**SDD Philosophy**](./docs/conception.md) | Two-Layer Model, Integrity by Design, Self-Improving Feedback Loop |
206
+ | [**Installers Guide**](./installers/README.md) | Advanced CLI options and platform specifics |
207
+ | [**Contributing**](./CONTRIBUTING.md) | How to develop, test, and extend the engine |
208
+
209
+ ## πŸ›Ÿ Support
210
+
211
+ If you encounter issues or have questions β€” open an [Issue](https://github.com/teratron/magic-spec/issues) on GitHub.
212
+
213
+ ## πŸ—ΊοΈ Roadmap
214
+
215
+ - [x] Multi-agent adapter system.
216
+ - [x] Phased implementation planning.
217
+ - [ ] Extended support for local-first LLM agents.
218
+ - [ ] Advanced visual dashboard for project health.
219
+ - [ ] Integration with CI/CD for automated spec validation.
220
+
221
+ ## πŸ—οΈ Contributing
222
+
223
+ We welcome contributions! See the [**Contributing Guide**](./CONTRIBUTING.md) for details.
224
+
225
+ ## πŸ‘₯ Authors and Acknowledgments
226
+
227
+ - **Oleg Alexandrov** β€” Creator and Lead Maintainer.
228
+ - Special thanks to the AI agent community for inspiration and testing.
229
+
230
+ ## πŸ“„ License
231
+
232
+ Distributed under the [Apache License 2.0](./LICENSE).
233
+
234
+ ## πŸ“Š Project Status
235
+
236
+ **Active Development** (v1.5.206). We are constantly refining the SDD engine based on real-world usage.
@@ -17,10 +17,14 @@
17
17
  "magic.task"
18
18
  ],
19
19
  "devWorkflows": [
20
- "magic.dev.simulate"
20
+ "magic.dev.publish",
21
+ "magic.dev.simulate",
22
+ "magic.dev.sync"
21
23
  ],
22
24
  "devSkills": [
23
- "magic.dev.simulate"
25
+ "magic.dev.publish",
26
+ "magic.dev.simulate",
27
+ "magic.dev.sync"
24
28
  ],
25
29
  "magicFiles": [
26
30
  "analyze.md",
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "magic-spec",
3
- "version": "1.5.132",
3
+ "version": "1.5.206",
4
4
  "description": "Magic Specification-Driven Development (SDD) Workflow",
5
5
  "author": "Oleg Alexandrov <alexandrovoleg.ru@gmail.com>",
6
- "license": "MIT",
6
+ "license": "Apache-2.0",
7
7
  "homepage": "https://github.com/teratron/magic-spec",
8
8
  "repository": {
9
9
  "type": "git",