multimodel-dev-os 0.6.1 → 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 (17) 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
package/docs/launch-checklist.md ADDED
@@ -0,0 +1,47 @@
1
+ # Public Launch Checklist
2
+
3
+ A complete list of operational and promotional gates to successfully deploy and publicize `multimodel-dev-os` to the global developer ecosystem.
4
+
5
+ ---
6
+
7
+ ## 1. GitHub Launch Checklist
8
+
9
+ Ensure the repository is clean, communicative, and ready for public forks/stars:
10
+ - [ ] **Community Standards Audit:** Confirm root files `LICENSE` (MIT), `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are present and correctly formatted.
11
+ - [ ] **GitHub Workflows Pass:** Validate that the `.github/workflows/verify.yml` actions run successfully on push events.
12
+ - [ ] **Community Engagement CTAs:** Confirm standard issue templates exist inside `.github/ISSUE_TEMPLATE/` to guide bug reporting and feature additions.
13
+
14
+ ---
15
+
16
+ ## 2. NPM Verification Checklist
17
+
18
+ Assure packaging hygiene before executing npm publishes:
19
+ - [ ] **Technical Structure Verify:** Run the cross-platform structural verifier:
20
+ ```bash
21
+ npm run verify
22
+ ```
23
+ Ensure all 102 target assertions return successful passes.
24
+ - [ ] **Dynamic Manifest Sync:** Assert that the dynamic version in `package.json` matches exactly across the CHANGELOG.md and installer scripts.
25
+ - [ ] **NPM Pack Audit:** Run the packaging dry-run:
26
+ ```bash
27
+ npm pack --dry-run
28
+ ```
29
+ Confirm that the output tarball size is under `~65kB`, the unpacked file size is under `~200kB`, and compiled docs caches (`docs/.vitepress/dist`, `docs/.vitepress/cache`) are completely ignored.
30
+
31
+ ---
32
+
33
+ ## 3. Docs Site Checklist
34
+
35
+ Verify documentation site integrity before public indexing:
36
+ - [ ] **VitePress Compile:** Run `npm run docs:build` and confirm that Rollup completes client and server bundle compilation successfully.
37
+ - [ ] **Asset Resolution:** Verify that all SVGs (terminal-demo, social-preview, architecture-preview) compile seamlessly and display correctly inside docs pages.
38
+ - [ ] **Pages Navigation:** Click all navigation sidebars, navbar tabs, and footer links under the hosted root `/multimodel-dev-os/` path to confirm zero broken links.
39
+
40
+ ---
41
+
42
+ ## 4. Social Launch Checklist
43
+
44
+ Prepare the phase-by-phase promotional campaigns to maximize engagement:
45
+ - [ ] **Product Hunt Staging:** Prepare high-end media cards (`social-preview.svg`) and draft the first-comment outline explaining our zero-dependency context layer.
46
+ - [ ] **Hacker News Submission:** Format the direct developer pitch under a clean Show HN title: `Show HN: MultiModel Dev OS — A portable .editorconfig for your AI coding agents`.
47
+ - [ ] **Reddit Outreach:** Select relevant communities (`/r/webdev`, `/r/node`, `/r/LocalLLaMA`) and schedule clear announcements addressing instruction drift.
package/docs/launch-kit.md CHANGED
@@ -1,28 +1,29 @@
1
1
  # Public Launch & Social Sharing Kit
2
2
 
3
- Use these curated marketing templates and outlines to announce the release of `multimodel-dev-os` to developer communities.
3
+ A curated collection of promotional templates and copy outlines to successfully announce `multimodel-dev-os` to global developer communities.
4
4
 
5
5
  ---
6
6
 
7
7
  ## 1. Product Hunt Style Launch Info
8
- * **Product Tagline:** Portable, vendor-neutral project context for all your AI coding tools.
9
- * **Elevator Pitch:** Stop copy-pasting system instructions when switching between Cursor, Claude Code, Antigravity, and VS Code. Run a single command to sync, verify, and optimize your codebase context.
8
+ - **Tagline:** Portable, vendor-neutral project context for all your AI coding tools.
9
+ - **Elevator Pitch:** Stop manually copy-pasting system instructions when switching between Cursor, Claude Code, Antigravity, and VS Code. Run a single lightweight command to scaffold, sync, and optimize your repository's AI guidelines.
10
10
 
11
11
  ---
12
12
 
13
13
  ## 2. GitHub Repository Metadata
14
- * **Short Description:** Portable, vendor-neutral project configuration and CLI tool for AI coding agents. Think `.editorconfig` but optimized for LLMs, Cursor, Claude Code, and VS Code.
15
- * **Topics/Keywords:** `ai-dev-os`, `multi-agent`, `ai-coding`, `developer-tools`, `cursorrules`, `claude-code`, `antigravity`
14
+ - **Short Description:** Portable, vendor-neutral project configuration and CLI tool for AI coding agents. Think `.editorconfig` but optimized for LLMs, Cursor, Claude Code, and VS Code.
15
+ - **Topics/Keywords:** `ai-dev-os`, `multi-agent`, `ai-coding`, `developer-tools`, `cursorrules`, `claude-code`, `antigravity`, `gemini`
16
16
 
17
17
  ---
18
18
 
19
19
  ## 3. X / Twitter Post (The Hook)
20
+
20
21
  ```text
21
- Pair programming with AI is fast, until you switch tools.
22
+ Pair programming with AI is fast, until you switch tools. 💸
22
23
 
23
24
  You design architecture in Claude Code, implement locally in Cursor, and audit with Gemini. Every switch drops context, and rules start to drift.
24
25
 
25
- Stop copy-pasting. Say hello to multimodel-dev-os! 🧠
26
+ Stop copy-pasting. Say hello to MultiModel Dev OS! 🧠
26
27
 
27
28
  npx multimodel-dev-os@latest init
28
29
 
@@ -38,6 +39,7 @@ Check it out: https://github.com/rizvee/multimodel-dev-os
38
39
  ---
39
40
 
40
41
  ## 4. LinkedIn Post (The Deep Dive)
42
+
41
43
  ```text
42
44
  The hidden developer tax when coding with AI: Context Drift. 💸
43
45
 
@@ -48,12 +50,12 @@ When pair programming with AI agents, we often switch between platforms to lever
48
50
 
49
51
  But there's a problem: every tool has its own custom settings, systems, and instructions files. You modify a build command in one place, forget to update it in another, and the agent breaks on compile.
50
52
 
51
- To solve this, we are launching `multimodel-dev-os` — a portable, vendor-neutral operating configuration layer for AI coding tools.
53
+ To solve this, we are launching multimodel-dev-os — a portable, vendor-neutral operating configuration layer for AI coding tools.
52
54
 
53
- Think `.editorconfig` but designed for LLMs.
55
+ Think .editorconfig but designed for LLMs.
54
56
 
55
57
  How it works:
56
- 1. Initialize in seconds: `npx multimodel-dev-os@latest init`
58
+ 1. Initialize in seconds: npx multimodel-dev-os@latest init
57
59
  2. Configure your instructions in one root directory (AGENTS.md, MEMORY.md, TASKS.md)
58
60
  3. Zero-duplication adapters dynamically present these instructions to Cursor (.cursorrules), Claude (CLAUDE.md), VS Code, and Gemini.
59
61
  4. Slash token bills by up to ~79% using Caveman Mode for small-context turns.
@@ -67,8 +69,9 @@ Let me know what you think in the comments! 👇
67
69
  ---
68
70
 
69
71
  ## 5. Reddit-Style Post (/r/webdev, /r/LocalLLaMA)
70
- * **Title:** Show Show HN / Show Reddit: I built multimodel-dev-os — a vendor-neutral context management layer for Cursor, Claude Code, and VS Code.
71
- * **Content:**
72
+
73
+ - **Title:** Show HN / Show Reddit: MultiModel Dev OS — A vendor-neutral context management layer for Cursor, Claude Code, and VS Code.
74
+ - **Content:**
72
75
  Hey everyone,
73
76
 
74
77
  If you pair program with multiple AI tools, you've probably noticed how fast rules drift. You edit a command in your system prompts, but forget to update Cursor's `.cursorrules`, causing the model to continuously fail.
@@ -84,16 +87,3 @@ Let me know what you think in the comments! 👇
84
87
  Open-source and MIT licensed. I'd love to hear your feedback on the layout structure!
85
88
 
86
89
  GitHub: https://github.com/rizvee/multimodel-dev-os
87
-
88
- ---
89
-
90
- ## 6. Dev.to Article Outline
91
- * **Title:** Stop Copy-Pasting AI Prompts: How to Build a Portable Context Layer in Your Codebase
92
- * **Outline:**
93
- 1. **Introduction:** The multi-model developer reality (switching Cursor, Claude, Gemini).
94
- 2. **The Problem:** The "context synchronization tax" and rules drift.
95
- 3. **The Concept:** Decoupling rules from specific IDE extension configurations.
96
- 4. **Introducing multimodel-dev-os:** Setup in seconds using `npx multimodel-dev-os@latest init`.
97
- 5. **Deep Dive on Token Budgeting:** How Caveman Mode preserves structural intent while cutting token usage by ~79%.
98
- 6. **CI/CD Integration:** Adding `verify` commands to enforce healthy setups across team repositories.
99
- 7. **Conclusion & CTA:** Join the open-source project and build custom adapters.
package/docs/public/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/docs/public/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/docs/public/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/quickstart.md CHANGED
@@ -1,13 +1,15 @@
1
1
  # Quickstart
2
2
 
3
- Get multimodel-dev-os into your project in under 2 minutes.
3
+ Get `multimodel-dev-os` integrated into your codebase in under 2 minutes.
4
+
5
+ ---
4
6
 
5
7
  ## Option A: NPX Scaffolding (Recommended)
6
8
 
7
9
  Initialize any project immediately without local clones using our public npm registry:
8
10
 
9
11
  ```bash
10
- # Standard interactive initialization in current directory
12
+ # Standard interactive initialization in the current directory
11
13
  npx multimodel-dev-os@latest init
12
14
 
13
15
  # Target specific stack templates and specific tool adapters
@@ -17,6 +19,8 @@ npx multimodel-dev-os@latest init --template nextjs-saas --adapter cursor --adap
17
19
  npx multimodel-dev-os@latest init --dry-run
18
20
  ```
19
21
 
22
+ ---
23
+
20
24
  ## Option B: Fallback One-Line Scripts
21
25
 
22
26
  If you choose to run installation scripts directly:
@@ -31,6 +35,8 @@ curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scrip
31
35
  irm https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/install.ps1 | iex
32
36
  ```
33
37
 
38
+ ---
39
+
34
40
  ## Option C: Caveman Mode (Minimal Tokens)
35
41
 
36
42
  Reduce token footprint by **~79%** with our lightweight variants:
@@ -39,6 +45,8 @@ Reduce token footprint by **~79%** with our lightweight variants:
39
45
  curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/install.sh | bash -s -- --caveman
40
46
  ```
41
47
 
48
+ ---
49
+
42
50
  ## Option D: Node.js Local Scaffolding CLI
43
51
 
44
52
  For offline execution or customized packaging within a cloned workspace:
@@ -51,48 +59,31 @@ For offline execution or customized packaging within a cloned workspace:
51
59
  node bin/multimodel-dev-os.js init --target /path/to/your-project --template nextjs-saas --adapter cursor
52
60
  ```
53
61
 
54
- ## Option E: Manual Scaffolding
55
-
56
- If you prefer absolute manual control over copying files:
57
-
58
- ```bash
59
- git clone https://github.com/rizvee/multimodel-dev-os.git /tmp/mmdos
60
- cp /tmp/mmdos/AGENTS.md your-project/
61
- cp /tmp/mmdos/MEMORY.md your-project/
62
- cp /tmp/mmdos/TASKS.md your-project/
63
- cp /tmp/mmdos/RUNBOOK.md your-project/
64
- cp /tmp/mmdos/.gitattributes your-project/
65
- cp -r /tmp/mmdos/.ai your-project/
66
- ```
62
+ ---
67
63
 
68
64
  ## After Install
69
65
 
70
- 1. **Edit `AGENTS.md`** — fill in your project name, stack, and build commands
71
- 2. **Edit `.ai/config.yaml`** — enable adapters for your tools
66
+ 1. **Edit `AGENTS.md`** — fill in your project name, stack, and build commands.
67
+ 2. **Edit `.ai/config.yaml`** — enable adapters for your tools.
72
68
  3. **Copy adapter files** to your project root:
73
69
  - Cursor: `cp adapters/cursor/.cursorrules .cursorrules`
74
70
  - Claude: `cp adapters/claude/CLAUDE.md CLAUDE.md`
75
71
  - VS Code: `cp -r adapters/vscode/.vscode/ .vscode/`
76
- 4. **Start coding** — your AI tools will read the shared config
72
+ 4. **Start coding** — your AI tools will read the shared configuration instantly.
73
+
74
+ ---
77
75
 
78
76
  ## Verify & Diagnose
79
77
 
80
78
  You can run our strict validation check or advisory doctor checkup to validate structural health:
79
+
81
80
  ```bash
82
81
  # Strict directory schema validation
83
- node bin/multimodel-dev-os.js validate --target /path/to/your-project
82
+ node bin/multimodel-dev-os.js validate
84
83
 
85
84
  # Advisory doctor workspace compatibility audit
86
- node bin/multimodel-dev-os.js doctor --target /path/to/your-project
85
+ node bin/multimodel-dev-os.js doctor
87
86
 
88
- # Legacy verification script
89
- node bin/multimodel-dev-os.js verify --target /path/to/your-project
87
+ # Verify repository structure checks
88
+ npm run verify
90
89
  ```
91
-
92
- ## Next Steps
93
-
94
- - [Architecture overview](architecture.md)
95
- - [Adapter setup](adapters.md)
96
- - [Multi-agent workflows](multimodel-workflow.md)
97
- - [Caveman Mode](caveman-mode.md)
98
- - [NPM Publishing Runbook](npm-publishing.md)
package/docs/release-template.md ADDED
@@ -0,0 +1,74 @@
1
+ # Patch & Release Playbook Template
2
+
3
+ Use this playbook to prepare, audit, and announce releases. This document contains reusable release notes templates tailored for patch, minor, and major milestones.
4
+
5
+ ---
6
+
7
+ ## 1. Reusable Release Notes Templates
8
+
9
+ ### A. Patch Release Template (e.g., `v0.7.1`)
10
+ Use this when releasing hotfixes, structural compliance patches, or minor configuration adjustments.
11
+
12
+ ```markdown
13
+ ## [vX.Y.Z] - YYYY-MM-DD (Patch Release)
14
+
15
+ ### Fixed
16
+ - **[Fix Category]:** Detailed explanation of the bug and how it was resolved.
17
+ - **[Adapter Sync]:** Fixed minor pathing issue in [Adapter Name] setup rules.
18
+
19
+ ### Performance
20
+ - Optimized local verifier execution times by removing redundant filesystem lookups.
21
+
22
+ ---
23
+ **Technical Integrity:** All 100+ release audit compliance checks pass successfully.
24
+ ```
25
+
26
+ ---
27
+
28
+ ### B. Minor Release Template (e.g., `v0.8.0`)
29
+ Use this when introducing backward-compatible new features, stack templates, or command additions.
30
+
31
+ ```markdown
32
+ ## [vX.Y.0] - YYYY-MM-DD (Minor Feature Release)
33
+
34
+ ### Added
35
+ - **[New Feature]:** Introduced [Feature Name] supporting automated [Activity Name].
36
+ - **[New Template]:** Added [Template Name] real-world stack template for [Stack Name].
37
+ - **[CLI Command]:** Implemented `npx multimodel-dev-os [command-name]` to execute [description].
38
+
39
+ ### Changed
40
+ - **[Adapter Refactor]:** Upgraded [Adapter Name] rules mapping to support [New version specs].
41
+
42
+ ### Fixed
43
+ - **[Linter Adjustments]:** Adjusted linter guidelines to prevent false-positives under specific workspace boundaries.
44
+ ```
45
+
46
+ ---
47
+
48
+ ### C. Major Release Template (e.g., `v1.0.0`)
49
+ Use this for major milestones, breaking changes, or sweeping architectural overhauls.
50
+
51
+ ```markdown
52
+ ## [vX.0.0] - YYYY-MM-DD (Major Milestone Release)
53
+
54
+ ### 🚨 Breaking Changes
55
+ - **[Abstractions Overhaul]:** Central root contracts have been restructured. [Detail the exact changes and how to migrate].
56
+ - **[CLI Commands Deprecation]:** The legacy subcommand `[legacy-command]` has been deprecated in favor of `[new-command]`.
57
+
58
+ ### Added
59
+ - **[Core Architecture]:** Implemented the new [Architectural Block Name] mapping protocol.
60
+ - **[Universal Adaptability]:** Full integration and native support for [List of new tools].
61
+
62
+ ### Migration Guide
63
+ 1. Run `npx multimodel-dev-os@latest migrate` inside your target repository.
64
+ 2. Update your root configuration `AGENTS.md` to reflect the new schemas.
65
+ ```
66
+
67
+ ---
68
+
69
+ ## 2. Dynamic Release Pipeline Checklist
70
+ - [ ] Bump version tag inside `package.json`.
71
+ - [ ] Prepend release notes to `CHANGELOG.md` following the Keep a Changelog convention.
72
+ - [ ] Execute `npm run verify` to test structural compliance.
73
+ - [ ] Execute `npm run docs:build` to confirm website compilation success.
74
+ - [ ] Run `npm pack --dry-run` to audit tarball cleanliness.
package/docs/workflow-examples.md ADDED
@@ -0,0 +1,72 @@
1
+ # Before/After Workflow Case Studies
2
+
3
+ Explore how `multimodel-dev-os` eliminates instruction drift and saves token budgets across multiple AI programming agents.
4
+
5
+ ---
6
+
7
+ ## 1. Before: Chaotic AI Prompting (The Old Way)
8
+
9
+ In a typical modern development pipeline, developers switch between multiple agents to leverage their distinct strengths (Cursor for inline autocomplete, Claude Code for CLI scaffolding, Gemini for repository audits).
10
+
11
+ Without context standardizations, this leads to **Chaotic AI Prompting**:
12
+ - **Manual Translation:** Every time a build script, staging path, or coding convention changes, the developer must manually edit `.cursorrules`, `CLAUDE.md`, and custom system instruction files.
13
+ - **Instruction Drift:** One IDE agent inevitably operates on an outdated convention. For example, Cursor suggests database patterns that Claude Code already replaced, causing immediate syntax and compiler crashes.
14
+ - **Context Bloat:** Boilerplate guidelines are copy-pasted across all files. Models consume **1,500+ tokens** of duplicate context on every single prompt turn, inflating API bills.
15
+
16
+ ---
17
+
18
+ ## 2. After: MultiModel Dev OS Workflow (The Standard)
19
+
20
+ `multimodel-dev-os` establishes a single source of truth inside your repository root, dynamically routing updates across all specialized tools.
21
+
22
+ ```
23
+ ┌──────────────────────┐
24
+ │ AGENTS.md (Root Truth)│
25
+ └──────────┬───────────┘
26
+ │
27
+ ┌──────────▼───────────┐
28
+ │ MultiModel Dev OS │
29
+ └────┬───────────┬─────┘
30
+ │ │
31
+ ┌────────────▼───┐ ┌───▼────────────┐
32
+ │ IDE Adapters │ │ CLI Adapters │
33
+ │ (Cursor, VS) │ │ (Claude, Codex)│
34
+ └────────────────┘ └────────────────┘
35
+ ```
36
+
37
+ ---
38
+
39
+ ## 3. Real-World Task Workflows
40
+
41
+ Here is how different agents execute their tasks under the standardized system:
42
+
43
+ ### A. Codex Scaffolding Task
44
+ When **Codex** bootstraps components:
45
+ 1. Codex parses the central `AGENTS.md` package specs and `/adapters/codex/AGENTS.md` instructions.
46
+ 2. It operates exactly under the defined build scripts, generating matching component schemas instantly.
47
+ 3. No instructions drift; Codex is aware of the exact package-lock constraints of the repository.
48
+
49
+ ### B. Antigravity Auditing Task
50
+ When **Antigravity** executes security/performance review audits:
51
+ 1. It reads `AGENTS.md` and respects the strict directory boundary rules defined under `no-touch` blocks.
52
+ 2. Antigravity executes compliance assertions against the active task backlog tracked inside `TASKS.md`.
53
+ 3. It performs checks under the shared stack guidelines without polluting directories or editing ignored configurations.
54
+
55
+ ### C. Cursor Autocomplete Task
56
+ When **Cursor** guides inline coding:
57
+ 1. Cursor reads the dynamically generated `.cursorrules` located in the workspace root.
58
+ 2. The rules are synchronized with the central repository brain.
59
+ 3. Cursor suggests matching code styles and variables without recommending legacy APIs or outdated database fields.
60
+
61
+ ---
62
+
63
+ ## 4. The Claude / Gemini Sequential Handoff Protocol
64
+
65
+ When pair programming requires switching between terminal-based execution (**Claude Code**) and deep-file analysis (**Gemini / Antigravity**), `multimodel-dev-os` uses the **Structured Session Log Handoff**:
66
+
67
+ 1. **Step 1 (Claude Code):** After finishing the terminal build, Claude Code summarizes its progress in `.ai/session-logs/session-001.md` utilizing the standard template. It logs:
68
+ - What changed
69
+ - Verification status
70
+ - Next planned steps
71
+ 2. **Step 2 (Gemini Pick-Up):** When the developer launches Gemini, the system feeds the last session log. Gemini reads `session-001.md` and instantly knows exactly where Claude Code left off.
72
+ 3. **Outcome:** Zero context drop, zero redundant questions, and pristine, seamless model hand-offs!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "multimodel-dev-os",
3
- "version": "0.6.1",
3
+ "version": "0.7.0",
4
4
  "bin": {
5
5
  "multimodel-dev-os": "bin/multimodel-dev-os.js"
6
6
  },
@@ -34,7 +34,8 @@
34
34
  "!docs/.vitepress/dist/",
35
35
  "!docs/.vitepress/cache/",
36
36
  "examples/",
37
- "bin/"
37
+ "bin/",
38
+ "assets/"
38
39
  ],
39
40
  "scripts": {
40
41
  "verify": "node scripts/verify.js",