multimodel-dev-os 0.6.0 → 0.7.0

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.
Files changed (19) hide show
  1. package/README.md +33 -166
  2. package/assets/architecture-preview.svg +94 -0
  3. package/assets/social-preview.svg +72 -0
  4. package/assets/terminal-demo.svg +72 -0
  5. package/docs/.vitepress/config.js +4 -0
  6. package/docs/comparison.md +6 -6
  7. package/docs/demo.md +79 -0
  8. package/docs/index.md +11 -2
  9. package/docs/launch-checklist.md +47 -0
  10. package/docs/launch-kit.md +15 -25
  11. package/docs/public/assets/architecture-preview.svg +94 -0
  12. package/docs/public/assets/social-preview.svg +72 -0
  13. package/docs/public/assets/terminal-demo.svg +72 -0
  14. package/docs/quickstart.md +21 -30
  15. package/docs/release-template.md +74 -0
  16. package/docs/workflow-examples.md +72 -0
  17. package/package.json +3 -2
  18. package/scripts/verify.js +17 -16
  19. package/scripts/verify.sh +15 -12
package/README.md CHANGED
@@ -1,202 +1,69 @@
1
- # multimodel-dev-os
1
+ # MultiModel Dev OS
2
2
 
3
- > Portable, vendor-neutral project configuration and CLI tool for AI coding agents.
4
-
5
- [![npm version](https://img.shields.io/npm/v/multimodel-dev-os.svg?color=blue)](https://www.npmjs.com/package/multimodel-dev-os)
6
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
7
- [![GitHub release](https://img.shields.io/github/v/release/rizvee/multimodel-dev-os?include_prereleases)](https://github.com/rizvee/multimodel-dev-os/releases)
8
- [![Build Status](https://img.shields.io/github/actions/workflow/status/rizvee/multimodel-dev-os/verify.yml?branch=main)](https://github.com/rizvee/multimodel-dev-os/actions)
9
- [![npm downloads](https://img.shields.io/npm/dm/multimodel-dev-os.svg?color=green)](https://www.npmjs.com/package/multimodel-dev-os)
10
- [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
11
-
12
- ---
13
-
14
- ## 10-Second Quickstart
15
-
16
- Bootstrap your project instantly via `npx`:
17
-
18
- ```bash
19
- npx multimodel-dev-os@latest init
20
- ```
21
-
22
- `multimodel-dev-os` is a lightweight, vendor-neutral configuration specification and local CLI utility that scaffolds a standardized operational context layout for your AI pair-programmers (such as Codex, Antigravity, Cursor, Claude Code, Gemini, or VS Code). It acts like `.editorconfig` but is optimized for multi-model AI coding agents.
3
+ Portable, vendor-neutral workspace configuration layer for multi-agent coding loops.
23
4
 
24
5
  ---
25
6
 
26
- ## Why This Exists
27
-
28
- AI coding tools are incredibly fast, but switching between them introduces context fragmentation:
29
- 1. **Context Loss:** You use **Cursor** for quick code completions, **Claude Code** for command-line implementations, and **Gemini/Antigravity** for auditing large code volumes. Every context switch drops your operational parameters.
30
- 2. **Instruction Drift:** Different tools look for different files (`.cursorrules`, `CLAUDE.md`, `.vscode/settings.json`, `.gemini/settings.json`). If you modify build scripts or styling rules in one place, they quickly drift across others, causing confusing compile failures.
31
-
32
- `multimodel-dev-os` establishes a single source of truth inside your repository using a standardized root structure (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`) and a `.ai/` context configuration directory.
7
+ <p align="center">
8
+ <img src="https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/assets/social-preview.svg" alt="MultiModel Dev OS Banner" width="100%">
9
+ </p>
33
10
 
34
11
  ---
35
12
 
36
- ## Why Not Just AGENTS.md?
13
+ ## Quickstart
37
14
 
38
- While you can write a raw instruction file manually, `multimodel-dev-os` provides a robust, standardized context-management architecture:
39
-
40
- | Feature | AGENTS.md Only | Tool-Specific Prompt Packs | MultiModel Dev OS |
41
- | :--- | :--- | :--- | :--- |
42
- | **Portability** | Hard to coordinate across different IDEs/CLIs | None (locked to one platform) | **Universal** (Single source of truth) |
43
- | **Drift Prevention** | Manual copy-pasting of rules | None | **Automated** (Adapters sync root rules instantly) |
44
- | **Token Optimization** | Read entire file every turn | Basic prompts | **Caveman Mode** (cuts token consumption by **~79%**) |
45
- | **Tool Translation** | None (IDE files must be managed manually) | None | **Zero-Duplication** (Dynamic reference generation) |
46
- | **Quality Gates** | None | None | **Verify checkup** (`npx multimodel-dev-os verify`) |
47
-
48
- ---
49
-
50
- ## Supported Tool Matrix
51
-
52
- | Tool | Adapter File | Reads Source of Truth From | Status |
53
- |------|--------------|----------------------------|--------|
54
- | OpenAI Codex | `adapters/codex/AGENTS.md` | `/AGENTS.md` | ✅ Production-Ready |
55
- | Google Antigravity | `adapters/antigravity/AGENTS.md` | `/AGENTS.md` | ✅ Production-Ready |
56
- | Cursor | `adapters/cursor/.cursorrules` | `/AGENTS.md`, `/MEMORY.md`, `/TASKS.md` | ✅ Production-Ready |
57
- | Claude Code | `adapters/claude/CLAUDE.md` | `/AGENTS.md`, `/MEMORY.md`, `/TASKS.md` | ✅ Production-Ready |
58
- | Gemini | `adapters/gemini/GEMINI.md` | `/AGENTS.md` | ✅ Production-Ready |
59
- | VS Code | `adapters/vscode/.vscode/settings.json` | `/AGENTS.md` (via exclusions) | ✅ Production-Ready |
60
-
61
- ---
62
-
63
- ## Extended Quickstart Options
64
-
65
- Customize your scaffolding instantly via CLI argument flags:
15
+ Initialize a unified, tool-neutral AI developer workspace instantly:
66
16
 
67
17
  ```bash
68
- # 1. Scaffolding with standard template profile
69
18
  npx multimodel-dev-os@latest init
70
-
71
- # 2. Scaffolding for a specific tech stack (e.g. Next.js App Router)
72
- npx multimodel-dev-os@latest init --template nextjs-saas
73
-
74
- # 3. Injecting a specific tool adapter profile (e.g. OpenAI Codex)
75
- npx multimodel-dev-os@latest init --adapter codex
76
-
77
- # 4. Bootstrapping with Caveman Mode (slashes token footprints by ~79%)
78
- npx multimodel-dev-os@latest init --caveman
79
-
80
- # 5. Verifying the structural health of your workspace directories
81
- npx multimodel-dev-os@latest verify
82
-
83
- # 6. Strict validation check for structural compliance
84
- npx multimodel-dev-os@latest validate
85
-
86
- # 7. Run advisory doctor checkup on target workspace
87
- npx multimodel-dev-os@latest doctor
88
-
89
- # 8. List all built-in template profiles with details
90
- npx multimodel-dev-os@latest templates
91
- ```
92
-
93
- ---
94
-
95
- ## Architecture Layout
96
-
97
- ```
98
- ┌─────────────────────────────────────────────┐
99
- │ SOURCE OF TRUTH (root) │
100
- │ │
101
- │ AGENTS.md MEMORY.md TASKS.md RUNBOOK.md │
102
- │ .ai/ │
103
- │ config · agents · skills · checks · ... │
104
- └──────────────────┬──────────────────────────┘
105
- │
106
- Adapters read from ↑
107
- │
108
- ┌────────┬───────┼───────┬────────┬─────────┐
109
- │ │ │ │ │ │
110
- ▼ ▼ ▼ ▼ ▼ ▼
111
- Codex Antigrav Cursor Claude Gemini VS Code
112
19
  ```
113
20
 
114
- Adapters are **readers, not writers.** The root markdown files are the single source of truth. Adapters translate these into tool-native formats without duplicating instructions.
115
-
116
- ---
117
-
118
- ## Core Operational Files
119
-
120
- | File | Purpose | Audience |
121
- |------|---------|----------|
122
- | [`AGENTS.md`](AGENTS.md) | Project rules, build commands, conventions | AI agents |
123
- | [`MEMORY.md`](MEMORY.md) | Architecture decisions, patterns, session notes | AI agents |
124
- | [`TASKS.md`](TASKS.md) | Current sprint, backlog, completed work | AI + humans |
125
- | [`RUNBOOK.md`](RUNBOOK.md) | Deploy, rollback, incident response | AI + humans |
126
- | [`.ai/config.yaml`](.ai/config.yaml) | Mode, orchestrator, adapter settings | System |
127
-
128
21
  ---
129
22
 
130
- ## Multimodel Orchestrator
23
+ ## See It in Action
131
24
 
132
- Coordinate multiple AI agents on one project. Define roles in `.ai/config.yaml`, detail coordination in `.ai/agents/multimodel-orchestrator.md`.
25
+ `multimodel-dev-os` runs completely on native Node.js libraries, keeping execution speeds lightning-fast with **zero third-party NPM runtime dependencies**. Here is the clean interactive terminal sequence executing `init`, `validate`, and `doctor` commands:
133
26
 
134
- ```yaml
135
- orchestrator:
136
- mode: "sequential"
137
- agents:
138
- - name: "architect"
139
- tool: "claude"
140
- files: ["docs/**"]
141
- - name: "implementer"
142
- tool: "cursor"
143
- files: ["src/**"]
144
- ```
145
-
146
- See [docs/multimodel-workflow.md](docs/multimodel-workflow.md).
27
+ <p align="center">
28
+ <img src="https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/assets/terminal-demo.svg" alt="Terminal Demo Sequence" width="100%">
29
+ </p>
147
30
 
148
31
  ---
149
32
 
150
- ## Caveman Mode
151
-
152
- Minimal-token templates. Same structure, ~79% fewer tokens.
33
+ ## Before vs. After
153
34
 
154
- | Mode | AGENTS.md | Total |
155
- |------|-----------|-------|
156
- | Standard | ~500 tokens | ~1,600 tokens |
157
- | Caveman | ~120 tokens | ~340 tokens |
35
+ ### Before: Chaotic Prompting & Instruction Drift
36
+ - Switching between agents (like Cursor, Claude Code, Gemini, Codex) requires maintaining duplicate instruction files (`.cursorrules`, `CLAUDE.md`, `.vscode/settings.json`, etc.).
37
+ - Modifying guidelines in one place results in immediate **Instruction Drift**, where one agent operates on outdated conventions, causing compile crashes.
38
+ - Duplicate instructions bloat prompts, wasting **1,500+ tokens** of model context budget on every single turn.
158
39
 
159
- See [docs/caveman-mode.md](docs/caveman-mode.md).
40
+ ### After: Standardized Zero-Drift Sync
41
+ - Rules are defined once in a central root document (`AGENTS.md` and `.ai/`).
42
+ - MultiModel Dev OS dynamically routes the root contract directly to Cursor, Claude Code, Gemini, and VS Code. All agents operate on matching build specifications instantly.
43
+ - Toggling **Caveman Mode** dynamically strips descriptions and examples, saving **~79% of token context** per chat turn.
160
44
 
161
45
  ---
162
46
 
163
- ## Scaffolding Templates
164
-
165
- We provide target-specific layouts for common application architectures:
166
- * [Next.js SaaS Stack](examples/nextjs-saas/) (TypeScript, Prisma, Tailwind)
167
- * [WordPress Custom Plugin/Site](examples/wordpress-site/) (PHP, standard blocks)
168
- * [Headless E-commerce Store](examples/ecommerce-store/) (Payment processing, Webhooks)
169
- * [SEO Static Landing Page](examples/seo-landing-page/) (Astro, static optimizations)
170
- * [General Application](examples/general-app/) (Default baseline configuration)
47
+ ## Sync Architecture
171
48
 
172
- See [docs/use-cases.md](docs/use-cases.md) for full stack examples.
173
-
174
- ---
49
+ `multimodel-dev-os` decouples your instructions from specific IDE extensions and model APIs:
175
50
 
176
- ## Documentation
177
-
178
- * [Quickstart Guide](docs/quickstart.md)
179
- * [Templates Upgrade Guide](docs/templates-guide.md)
180
- * [Comparison Matrix](docs/comparison.md)
181
- * [Use Cases & Stack Templates](docs/use-cases.md)
182
- * [Social Launch Kit](docs/launch-kit.md)
183
- * [Architecture Overview](docs/architecture.md)
184
- * [Adapters Guide](docs/adapters.md)
185
- * [Multi-agent Workflows](docs/multimodel-workflow.md)
186
- * [Caveman Mode](docs/caveman-mode.md)
187
- * [Script Installers Guide](docs/installers.md)
188
- * [CLI Development Roadmap](docs/cli-roadmap.md)
189
- * [NPM Publishing Runbook](docs/npm-publishing.md)
190
- * [Frequently Asked Questions (FAQ)](docs/faq.md)
51
+ <p align="center">
52
+ <img src="https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/assets/architecture-preview.svg" alt="Sync Architecture" width="100%">
53
+ </p>
191
54
 
192
55
  ---
193
56
 
194
- ## Contributing
57
+ ## Core Navigation Guides
195
58
 
196
- See [`CONTRIBUTING.md`](CONTRIBUTING.md) and [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md).
59
+ Explore our detailed manuals directly:
60
+ - 📖 [CLI Terminal Demo Guide](https://rizvee.github.io/multimodel-dev-os/demo)
61
+ - 💡 [Before/After Workflow Case Studies](https://rizvee.github.io/multimodel-dev-os/workflow-examples)
62
+ - 🛡️ [Public Release & Staging Checklist](https://rizvee.github.io/multimodel-dev-os/launch-checklist)
63
+ - 📦 [Standard Template Gallery](https://rizvee.github.io/multimodel-dev-os/templates/)
197
64
 
198
65
  ---
199
66
 
200
67
  ## License
201
68
 
202
- This project is licensed under the [MIT License](LICENSE).
69
+ MIT License.
package/assets/architecture-preview.svg ADDED
@@ -0,0 +1,94 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 820 400" width="100%" height="100%" style="font-family: 'Outfit', 'Inter', -apple-system, sans-serif;">
2
+ <defs>
3
+ <!-- Card Gradients -->
4
+ <linearGradient id="rootCard" x1="0%" y1="0%" x2="100%" y2="100%">
5
+ <stop offset="0%" stop-color="#1e1b4b" />
6
+ <stop offset="100%" stop-color="#0f172a" />
7
+ </linearGradient>
8
+ <linearGradient id="aiCard" x1="0%" y1="0%" x2="100%" y2="100%">
9
+ <stop offset="0%" stop-color="#111827" />
10
+ <stop offset="100%" stop-color="#1f2937" />
11
+ </linearGradient>
12
+
13
+ <!-- Flow Connector -->
14
+ <linearGradient id="flowGrad" x1="0%" y1="0%" x2="0%" y2="100%">
15
+ <stop offset="0%" stop-color="#8b5cf6" />
16
+ <stop offset="100%" stop-color="#10b981" />
17
+ </linearGradient>
18
+ </defs>
19
+
20
+ <!-- Canvas Container -->
21
+ <rect width="820" height="400" rx="12" fill="#090d16" stroke="#1e293b" stroke-width="1.5"/>
22
+
23
+ <!-- Layer 1: Root Files Single Source of Truth -->
24
+ <g transform="translate(110, 25)">
25
+ <rect width="600" height="85" rx="12" fill="url(#rootCard)" stroke="#4f46e5" stroke-width="2"/>
26
+ <text x="300" y="32" font-size="14" font-weight="800" fill="#a5b4fc" text-anchor="middle" letter-spacing="1">LAYER 1: CENTRAL ROOT CONTRACTS</text>
27
+ <text x="300" y="62" font-size="16" font-weight="700" fill="#f8fafc" text-anchor="middle">AGENTS.md • MEMORY.md • TASKS.md • RUNBOOK.md</text>
28
+ </g>
29
+
30
+ <!-- Flow Connector 1 -->
31
+ <path d="M 410,110 L 410,140" stroke="url(#flowGrad)" stroke-width="3" stroke-dasharray="4,4" fill="none"/>
32
+
33
+ <!-- Layer 2: The .ai/ Config Layer -->
34
+ <g transform="translate(110, 140)">
35
+ <rect width="600" height="85" rx="12" fill="url(#aiCard)" stroke="#8b5cf6" stroke-width="1.5"/>
36
+ <text x="300" y="30" font-size="13" font-weight="800" fill="#c084fc" text-anchor="middle" letter-spacing="1">LAYER 2: .AI/ CONFIGURATION DIRECTORY</text>
37
+ <text x="300" y="60" font-size="15" font-weight="700" fill="#e2e8f0" text-anchor="middle">context • agents • skills • prompts • checks • session logs</text>
38
+ </g>
39
+
40
+ <!-- Flow Connector 2 -->
41
+ <path d="M 410,225 L 410,255" stroke="url(#flowGrad)" stroke-width="3" fill="none"/>
42
+ <polygon points="410,260 405,250 415,250" fill="#10b981"/>
43
+
44
+ <!-- Layer 3: Adapters Connection Tree -->
45
+ <path d="M 100,265 L 720,265 L 720,280" stroke="#334155" stroke-width="2" fill="none"/>
46
+ <path d="M 100,265 L 100,280" stroke="#334155" stroke-width="2" fill="none"/>
47
+ <path d="M 224,265 L 224,280" stroke="#334155" stroke-width="2" fill="none"/>
48
+ <path d="M 348,265 L 348,280" stroke="#334155" stroke-width="2" fill="none"/>
49
+ <path d="M 472,265 L 472,280" stroke="#334155" stroke-width="2" fill="none"/>
50
+ <path d="M 596,265 L 596,280" stroke="#334155" stroke-width="2" fill="none"/>
51
+
52
+ <!-- Adapter Output Nodes -->
53
+ <!-- Node 1: Codex -->
54
+ <g transform="translate(40, 280)">
55
+ <rect width="120" height="50" rx="8" fill="#0f172a" stroke="#334155" stroke-width="1"/>
56
+ <text x="60" y="24" font-size="12" font-weight="700" fill="#f8fafc" text-anchor="middle">Codex</text>
57
+ <text x="60" y="40" font-size="10" fill="#94a3b8" text-anchor="middle">adapters/codex/</text>
58
+ </g>
59
+
60
+ <!-- Node 2: Antigravity -->
61
+ <g transform="translate(165, 280)">
62
+ <rect width="120" height="50" rx="8" fill="#0f172a" stroke="#334155" stroke-width="1"/>
63
+ <text x="60" y="24" font-size="12" font-weight="700" fill="#f8fafc" text-anchor="middle">Antigravity</text>
64
+ <text x="60" y="40" font-size="10" fill="#94a3b8" text-anchor="middle">.gemini/settings</text>
65
+ </g>
66
+
67
+ <!-- Node 3: Cursor -->
68
+ <g transform="translate(290, 280)">
69
+ <rect width="120" height="50" rx="8" fill="#0f172a" stroke="#334155" stroke-width="1"/>
70
+ <text x="60" y="24" font-size="12" font-weight="700" fill="#f8fafc" text-anchor="middle">Cursor</text>
71
+ <text x="60" y="40" font-size="10" fill="#94a3b8" text-anchor="middle">.cursorrules</text>
72
+ </g>
73
+
74
+ <!-- Node 4: Claude -->
75
+ <g transform="translate(415, 280)">
76
+ <rect width="120" height="50" rx="8" fill="#0f172a" stroke="#334155" stroke-width="1"/>
77
+ <text x="60" y="24" font-size="12" font-weight="700" fill="#f8fafc" text-anchor="middle">Claude</text>
78
+ <text x="60" y="40" font-size="10" fill="#94a3b8" text-anchor="middle">CLAUDE.md</text>
79
+ </g>
80
+
81
+ <!-- Node 5: Gemini -->
82
+ <g transform="translate(540, 280)">
83
+ <rect width="120" height="50" rx="8" fill="#0f172a" stroke="#334155" stroke-width="1"/>
84
+ <text x="60" y="24" font-size="12" font-weight="700" fill="#f8fafc" text-anchor="middle">Gemini</text>
85
+ <text x="60" y="40" font-size="10" fill="#94a3b8" text-anchor="middle">GEMINI.md</text>
86
+ </g>
87
+
88
+ <!-- Node 6: VS Code -->
89
+ <g transform="translate(665, 280)">
90
+ <rect width="120" height="50" rx="8" fill="#0f172a" stroke="#334155" stroke-width="1"/>
91
+ <text x="60" y="24" font-size="12" font-weight="700" fill="#f8fafc" text-anchor="middle">VS Code</text>
92
+ <text x="60" y="40" font-size="10" fill="#94a3b8" text-anchor="middle">.vscode/settings</text>
93
+ </g>
94
+ </svg>
package/assets/social-preview.svg ADDED
@@ -0,0 +1,72 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1280 640" width="100%" height="100%" style="font-family: 'Outfit', 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;">
2
+ <defs>
3
+ <!-- Dark Background -->
4
+ <linearGradient id="bgGrad" x1="0%" y1="0%" x2="100%" y2="100%">
5
+ <stop offset="0%" stop-color="#070a13" />
6
+ <stop offset="50%" stop-color="#0d111d" />
7
+ <stop offset="100%" stop-color="#04060b" />
8
+ </linearGradient>
9
+
10
+ <!-- Indigo/Purple Accent -->
11
+ <linearGradient id="brandGrad" x1="0%" y1="0%" x2="100%" y2="100%">
12
+ <stop offset="0%" stop-color="#6366f1" />
13
+ <stop offset="50%" stop-color="#8b5cf6" />
14
+ <stop offset="100%" stop-color="#10b981" />
15
+ </linearGradient>
16
+
17
+ <!-- Glassmorphic Card -->
18
+ <linearGradient id="cardGrad" x1="0%" y1="0%" x2="100%" y2="100%">
19
+ <stop offset="0%" stop-color="#ffffff" stop-opacity="0.06" />
20
+ <stop offset="100%" stop-color="#ffffff" stop-opacity="0.01" />
21
+ </linearGradient>
22
+
23
+ <!-- Glow Effect -->
24
+ <filter id="glow" x="-20%" y="-20%" width="140%" height="140%">
25
+ <feGaussianBlur stdDeviation="45" result="blur" />
26
+ <feComposite in="SourceGraphic" in2="blur" operator="over" />
27
+ </filter>
28
+ </defs>
29
+
30
+ <!-- Background -->
31
+ <rect width="1280" height="640" fill="url(#bgGrad)" />
32
+
33
+ <!-- Backlight Glows -->
34
+ <circle cx="1100" cy="150" r="220" fill="#8b5cf6" opacity="0.15" filter="url(#glow)" />
35
+ <circle cx="180" cy="480" r="250" fill="#10b981" opacity="0.1" filter="url(#glow)" />
36
+
37
+ <!-- Outer Frames -->
38
+ <rect x="25" y="25" width="1230" height="590" rx="20" fill="none" stroke="#1e293b" stroke-width="2" />
39
+ <rect x="35" y="35" width="1210" height="570" rx="16" fill="none" stroke="url(#brandGrad)" stroke-width="1.5" opacity="0.2" />
40
+
41
+ <!-- Glassmorphic Card Container -->
42
+ <rect x="80" y="80" width="1120" height="480" rx="24" fill="url(#cardGrad)" stroke="#334155" stroke-width="1" stroke-opacity="0.4" style="backdrop-filter: blur(12px);" />
43
+
44
+ <!-- Brand Mark -->
45
+ <g transform="translate(130, 140)">
46
+ <rect width="100" height="100" rx="22" fill="url(#brandGrad)" />
47
+ <path d="M 32,50 L 50,32 L 68,50 L 50,68 Z" fill="#ffffff" />
48
+ <circle cx="50" cy="50" r="8" fill="#070a13" />
49
+ </g>
50
+
51
+ <!-- Titles -->
52
+ <text x="260" y="205" font-size="68" font-weight="900" fill="#ffffff" letter-spacing="-1.5">MultiModel Dev OS</text>
53
+ <text x="260" y="252" font-size="28" font-weight="700" fill="#a78bfa" letter-spacing="-0.5">One project brain for every AI coding agent</text>
54
+
55
+ <!-- Scaffolding Highlight Commands -->
56
+ <g transform="translate(130, 320)">
57
+ <!-- Command box -->
58
+ <rect width="520" height="75" rx="16" fill="#090d16" stroke="#4f46e5" stroke-width="2" />
59
+ <text x="30" y="47" font-family="'Fira Code', 'JetBrains Mono', monospace" font-size="22" font-weight="bold" fill="#34d399">$ <tspan fill="#e2e8f0">npx multimodel-dev-os@latest init</tspan></text>
60
+ </g>
61
+
62
+ <!-- Tools Covered Footer Matrix -->
63
+ <g transform="translate(130, 435)">
64
+ <!-- Divider -->
65
+ <line x1="0" y1="0" x2="1020" y2="0" stroke="#334155" stroke-width="1.5" stroke-opacity="0.6" />
66
+
67
+ <!-- Tools text -->
68
+ <text x="0" y="45" font-size="22" font-weight="600" fill="#94a3b8" letter-spacing="1">
69
+ SUPPORTED WORKFLOWS: <tspan fill="#f8fafc">Codex</tspan> • <tspan fill="#f8fafc">Antigravity</tspan> • <tspan fill="#f8fafc">Cursor</tspan> • <tspan fill="#f8fafc">Claude</tspan> • <tspan fill="#f8fafc">Gemini</tspan> • <tspan fill="#f8fafc">VS Code</tspan>
70
+ </text>
71
+ </g>
72
+ </svg>
package/assets/terminal-demo.svg ADDED
@@ -0,0 +1,72 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 500" width="100%" height="100%" style="border-radius: 12px; font-family: 'Fira Code', 'JetBrains Mono', Consolas, Monaco, monospace; box-shadow: 0 20px 50px rgba(0,0,0,0.45);">
2
+ <defs>
3
+ <!-- Dark Terminal Background Gradient -->
4
+ <linearGradient id="termBg" x1="0%" y1="0%" x2="100%" y2="100%">
5
+ <stop offset="0%" stop-color="#0a0e17" />
6
+ <stop offset="100%" stop-color="#0f1626" />
7
+ </linearGradient>
8
+
9
+ <!-- Decorative Title Accent -->
10
+ <linearGradient id="titleAccent" x1="0%" y1="0%" x2="100%" y2="0%">
11
+ <stop offset="0%" stop-color="#6366f1" />
12
+ <stop offset="50%" stop-color="#a855f7" />
13
+ <stop offset="100%" stop-color="#10b981" />
14
+ </linearGradient>
15
+ </defs>
16
+
17
+ <!-- Shell Frame and Background -->
18
+ <rect width="800" height="500" rx="12" fill="url(#termBg)" stroke="#1e293b" stroke-width="1.5"/>
19
+ <rect x="0" y="0" width="800" height="2" fill="url(#titleAccent)"/>
20
+
21
+ <!-- Title Bar -->
22
+ <path d="M 1 12 A 11 11 0 0 1 12 2 h 776 a 11 11 0 0 1 11 11 v 28 H 1 Z" fill="#0f172a"/>
23
+
24
+ <!-- Window Controls -->
25
+ <circle cx="25" cy="22" r="6" fill="#ff5f56"/>
26
+ <circle cx="45" cy="22" r="6" fill="#ffbd2e"/>
27
+ <circle cx="65" cy="22" r="6" fill="#27c93f"/>
28
+
29
+ <!-- Window Title -->
30
+ <text x="400" y="26" fill="#94a3b8" font-size="13" font-weight="600" text-anchor="middle" letter-spacing="0.5">bash - MultiModel Dev OS CLI</text>
31
+
32
+ <!-- Terminal Content Console -->
33
+ <g font-size="13.5" fill="#e2e8f0" xml:space="preserve">
34
+ <!-- COMMAND 1: init -->
35
+ <text x="30" y="70" font-weight="bold">
36
+ <tspan fill="#38bdf8">~</tspan> <tspan fill="#f43f5e">❯</tspan> <tspan fill="#818cf8">npx</tspan> <tspan fill="#f472b6">multimodel-dev-os@latest</tspan> <tspan fill="#34d399">init</tspan> <tspan fill="#94a3b8">--template nextjs-saas --adapter codex</tspan>
37
+ </text>
38
+
39
+ <!-- Scaffolding Output -->
40
+ <text x="30" y="95" fill="#a78bfa" font-weight="600">🧠 Scaffolding MultiModel Dev OS environment...</text>
41
+ <text x="50" y="115" fill="#34d399">✓ <tspan fill="#e2e8f0">Scaffolded root files</tspan> <tspan fill="#64748b">(AGENTS.md, MEMORY.md, TASKS.md, RUNBOOK.md)</tspan></text>
42
+ <text x="50" y="132" fill="#34d399">✓ <tspan fill="#e2e8f0">Enabled adapter</tspan> <tspan fill="#fb7185">codex</tspan> <tspan fill="#64748b">(.ai/config.yaml status = true)</tspan></text>
43
+
44
+ <!-- COMMAND 2: validate -->
45
+ <text x="30" y="175" font-weight="bold">
46
+ <tspan fill="#38bdf8">~</tspan> <tspan fill="#f43f5e">❯</tspan> <tspan fill="#818cf8">npx</tspan> <tspan fill="#f472b6">multimodel-dev-os@latest</tspan> <tspan fill="#34d399">validate</tspan> <tspan fill="#94a3b8">--target ./my-app</tspan>
47
+ </text>
48
+
49
+ <!-- Validate Output -->
50
+ <text x="30" y="200" fill="#a78bfa" font-weight="600">🛡️ Validating workspace structure compliance...</text>
51
+ <text x="50" y="220" fill="#34d399">✓ <tspan fill="#e2e8f0">Checked primary contract documents: 4/4 exist</tspan></text>
52
+ <text x="50" y="237" fill="#34d399">✓ <tspan fill="#e2e8f0">Validated .ai/config.yaml adapter constraints</tspan></text>
53
+ <text x="50" y="254" fill="#34d399">✓ <tspan fill="#34d399">Success:</tspan> <tspan fill="#e2e8f0">Workspace structure conforms to specifications</tspan></text>
54
+
55
+ <!-- COMMAND 3: doctor -->
56
+ <text x="30" y="295" font-weight="bold">
57
+ <tspan fill="#38bdf8">~</tspan> <tspan fill="#f43f5e">❯</tspan> <tspan fill="#818cf8">npx</tspan> <tspan fill="#f472b6">multimodel-dev-os@latest</tspan> <tspan fill="#34d399">doctor</tspan> <tspan fill="#94a3b8">--target ./my-app</tspan>
58
+ </text>
59
+
60
+ <!-- Doctor Output -->
61
+ <text x="30" y="320" fill="#a78bfa" font-weight="600">🩺 Executing advisory checkups...</text>
62
+ <text x="50" y="340" fill="#34d399">✓ <tspan fill="#e2e8f0">Gitignore audit: Ignored cache folders (.vitepress/dist)</tspan></text>
63
+ <text x="50" y="357" fill="#34d399">✓ <tspan fill="#e2e8f0">Active adapters verify: Physical rule files mapped</tspan></text>
64
+ <text x="50" y="374" fill="#38bdf8">ℹ <tspan fill="#e2e8f0">Advisory: 0 warnings, workspace is operating at 100% efficiency</tspan></text>
65
+
66
+ <!-- Success banner -->
67
+ <text x="30" y="415" fill="#34d399" font-weight="bold">🚀 All Dev OS pipeline checkups completed successfully!</text>
68
+
69
+ <!-- Next Active Prompt Cursor -->
70
+ <text x="30" y="455" fill="#f43f5e">❯ <tspan fill="#e2e8f0">█</tspan></text>
71
+ </g>
72
+ </svg>
package/docs/.vitepress/config.js CHANGED
@@ -16,6 +16,7 @@ export default {
16
16
  text: 'Getting Started',
17
17
  items: [
18
18
  { text: 'Introduction', link: '/' },
19
+ { text: 'Interactive CLI Demo', link: '/demo' },
19
20
  { text: 'Quickstart', link: '/quickstart' },
20
21
  { text: 'FAQ', link: '/faq' }
21
22
  ]
@@ -33,6 +34,7 @@ export default {
33
34
  text: 'Templates & Use Cases',
34
35
  items: [
35
36
  { text: 'Template Gallery', link: '/templates/' },
37
+ { text: 'Before/After Workflows', link: '/workflow-examples' },
36
38
  { text: 'Use Cases Guide', link: '/use-cases' },
37
39
  { text: 'Templates Architecture', link: '/templates-guide' }
38
40
  ]
@@ -40,6 +42,8 @@ export default {
40
42
  {
41
43
  text: 'Operations & Publishing',
42
44
  items: [
45
+ { text: 'Public Launch Checklist', link: '/launch-checklist' },
46
+ { text: 'Release Playbook Template', link: '/release-template' },
43
47
  { text: 'CLI Roadmap', link: '/cli-roadmap' },
44
48
  { text: 'NPM Publishing Runbook', link: '/npm-publishing' },
45
49
  { text: 'Pre-flight Release Testing', link: '/testing-v0.2' }
package/docs/comparison.md CHANGED
@@ -19,15 +19,15 @@ Selecting how to manage AI instructions inside a codebase significantly impacts
19
19
 
20
20
  ### 1. The DIY Approach (AGENTS.md Only)
21
21
  Many developers start by dropping a single `AGENTS.md` file in their root. While better than nothing, this approach quickly breaks down:
22
- * **Drift:** You modify a build command in `AGENTS.md`, but forget to update Cursor's `.cursorrules`. Cursor continues running the old build script, causing confusing errors.
23
- * **Clutter:** A single markdown file gets bloated with styling guidelines, deployment procedures, and troubleshooting steps. Soon, the AI spends 10,000 tokens just reading instructions on every turn.
22
+ - **Drift:** You modify a build command in `AGENTS.md`, but forget to update Cursor's `.cursorrules`. Cursor continues running the old build script, causing confusing errors.
23
+ - **Clutter:** A single markdown file gets bloated with styling guidelines, deployment procedures, and troubleshooting steps. Soon, the AI spends 10,000 tokens just reading instructions on every turn.
24
24
 
25
25
  ### 2. Tool-Specific Prompt Packs
26
26
  Using tools like `Cursorrules` websites or Claude Code presets locks your project configuration into one vendor's ecosystem:
27
- * **Vendor Lock:** If your team uses Cursor for coding and Claude Code for debugging, you must duplicate and manually translate the syntax for both tools.
28
- * **No Collaboration:** Co-workers using different IDEs or terminal utilities cannot benefit from the unified context.
27
+ - **Vendor Lock:** If your team uses Cursor for coding and Claude Code for debugging, you must duplicate and manually translate the syntax for both tools.
28
+ - **No Collaboration:** Co-workers using different IDEs or terminal utilities cannot benefit from the unified context.
29
29
 
30
30
  ### 3. MultiModel Dev OS
31
31
  `multimodel-dev-os` establishes a lightweight, vendor-neutral layer that decouples your project's rules from specific tools:
32
- * **Translate once, read everywhere:** You write build parameters once in the root. The CLI and adapters expose these configurations cleanly to Cursor, Claude, Antigravity, VS Code, and Codex.
33
- * **Continuous Integration:** You can add `multimodel-dev-os verify` to your CI pipeline or pre-commit hooks to guarantee that all developers share healthy, correctly-formatted AI configurations.
32
+ - **Translate once, read everywhere:** You write build parameters once in the root. The CLI and adapters expose these configurations cleanly to Cursor, Claude, Antigravity, VS Code, and Codex.
33
+ - **Continuous Integration:** You can add `multimodel-dev-os verify` to your CI pipeline or pre-commit hooks to guarantee that all developers share healthy, correctly-formatted AI configurations.
package/docs/demo.md ADDED
@@ -0,0 +1,79 @@
1
+ # Interactive CLI & Terminal Demo
2
+
3
+ Experience the clean scaffolding pipeline and zero-dependency commands of `multimodel-dev-os` right from your terminal.
4
+
5
+ ---
6
+
7
+ ## Visual Initialization Pipeline
8
+
9
+ Here is how the automatic bootstrapping pipeline looks when initializing a project with a template:
10
+
11
+ ![Terminal Scaffold Mockup](/assets/terminal-demo.svg)
12
+
13
+ ---
14
+
15
+ ## Under the Hood: CLI Commands
16
+
17
+ `multimodel-dev-os` is built entirely on native Node.js libraries, keeping execution lightning-fast with **zero third-party runtime dependencies**.
18
+
19
+ ### 1. The `init` Scaffolding Engine
20
+
21
+ Bootstraps the shared workspace contract files and target directory setups.
22
+
23
+ ```bash
24
+ # Global zero-install setup
25
+ npx multimodel-dev-os@latest init
26
+
27
+ # Scaffold a specific technology stack template and set up adapter status automatically
28
+ npx multimodel-dev-os@latest init --template nextjs-saas --adapter cursor --adapter claude
29
+
30
+ # Run a dry-run preview to verify planned file actions without modifying the disk
31
+ npx multimodel-dev-os@latest init --dry-run
32
+ ```
33
+
34
+ #### Core Scaffolding Activities:
35
+ - **Directory Guarantee:** Assures target paths (`.ai/context`, `.ai/skills`, `.ai/session-logs`) exist.
36
+ - **Contract Scaffold:** Creates the root source-of-truth instructions (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`).
37
+ - **Adapter Linking:** Translates and copies rule files (like `.cursorrules`, `CLAUDE.md`, or `.vscode/`) directly to your workspace root.
38
+
39
+ ---
40
+
41
+ ### 2. The `templates` Gallery Inspector
42
+
43
+ Allows developers to view, inspect, and choose real-world configuration templates.
44
+
45
+ ```bash
46
+ # List all pre-configured stack templates
47
+ npx multimodel-dev-os templates
48
+
49
+ # Display detailed configuration rules and files of a specific template
50
+ npx multimodel-dev-os show-template nextjs-saas
51
+ ```
52
+
53
+ ---
54
+
55
+ ### 3. The `validate` Quality Gate
56
+
57
+ Enforce strict formatting conventions inside your repository before checking in code:
58
+
59
+ ```bash
60
+ # Strict directory schema and file validation checkup
61
+ npx multimodel-dev-os validate
62
+ ```
63
+
64
+ If any core agent file (`AGENTS.md`, `MEMORY.md`) is missing or is structurally invalid, the CLI exits with non-zero exit codes to fail pull requests or pre-commit hooks, guarding workspace health.
65
+
66
+ ---
67
+
68
+ ### 4. The `doctor` Advisory Inspector
69
+
70
+ An advisory checkup to diagnose environment compatibility issues:
71
+
72
+ ```bash
73
+ # Diagnostic audit of gitignore rules and IDE adapter overrides
74
+ npx multimodel-dev-os doctor
75
+ ```
76
+
77
+ The doctor warns you if:
78
+ - IDE cache directories (like `node_modules` or `.vitepress/dist`) are not listed in your `.gitignore` file.
79
+ - Enabled adapter configurations inside `.ai/config.yaml` lack corresponding physical rule files on the disk.
package/docs/index.md CHANGED
@@ -12,6 +12,9 @@ hero:
12
12
  - theme: brand
13
13
  text: Get Started Quick
14
14
  link: /quickstart
15
+ - theme: alt
16
+ text: View CLI Demo
17
+ link: /demo
15
18
  - theme: alt
16
19
  text: View Template Gallery
17
20
  link: /templates/
@@ -28,16 +31,22 @@ features:
28
31
  details: Includes Caveman Mode to slash model context footprint by ~79%, saving massive API bill budgets.
29
32
  - icon: 🛡️
30
33
  title: Local Quality Gates
31
- details: Build-in zero-dependency validate and doctor checkups ensure pristine workspace rules layout.
34
+ details: Built-in zero-dependency validate and doctor checkups ensure pristine workspace rules layout.
32
35
  ---
33
36
 
34
37
  <style>
35
38
  :root {
36
39
  --vp-home-hero-name-color: transparent;
37
- --vp-home-hero-name-background: linear-gradient(135deg, #646cff 0%, #42b883 100%);
40
+ --vp-home-hero-name-background: linear-gradient(135deg, #6366f1 0%, #10b981 100%);
38
41
  }
39
42
  </style>
40
43
 
44
+ ## Interactive CLI Demo
45
+
46
+ <p align="center">
47
+ <img src="/assets/terminal-demo.svg" alt="Terminal Demo Scaffolding" width="100%">
48
+ </p>
49
+
41
50
  ## 10-Second Quickstart
42
51
 
43
52
  Bootstrap your project instantly via `npx`: