multimodel-dev-os 0.8.0 → 1.1.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.
@@ -0,0 +1,27 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "MultiModel Dev OS Adapter Schema",
4
+ "description": "JSON schema reference detailing tool/IDE adapter expected boundaries and setup layouts",
5
+ "type": "OBJECT",
6
+ "required": ["adapterName", "targetFile", "setupDocs"],
7
+ "properties": {
8
+ "adapterName": {
9
+ "type": "STRING",
10
+ "description": "Unique identifier of the target programming tool (e.g. cursor, claude)"
11
+ },
12
+ "targetFile": {
13
+ "type": "STRING",
14
+ "description": "The rule configuration file mapped by the adapter"
15
+ },
16
+ "setupDocs": {
17
+ "type": "STRING",
18
+ "description": "Relative reference to the adapter setup markdown instructions"
19
+ },
20
+ "requiredRootFiles": {
21
+ "type": "ARRAY",
22
+ "items": { "type": "STRING" },
23
+ "description": "Root workspace contracts verified by the adapter schema"
24
+ }
25
+ },
26
+ "additionalProperties": false
27
+ }
@@ -0,0 +1,35 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "MultiModel Dev OS Config Schema",
4
+ "description": "JSON schema reference validating standard .ai/config.yaml workspace settings",
5
+ "type": "OBJECT",
6
+ "required": ["version", "adapters"],
7
+ "properties": {
8
+ "version": {
9
+ "type": "STRING",
10
+ "description": "The configuration protocol version matching semantic limits"
11
+ },
12
+ "adapters": {
13
+ "type": "OBJECT",
14
+ "description": "Enabled state of target IDE and terminal programming adapters",
15
+ "properties": {
16
+ "codex": { "type": "BOOLEAN" },
17
+ "antigravity": { "type": "BOOLEAN" },
18
+ "cursor": { "type": "BOOLEAN" },
19
+ "claude": { "type": "BOOLEAN" },
20
+ "gemini": { "type": "BOOLEAN" },
21
+ "vscode": { "type": "BOOLEAN" }
22
+ },
23
+ "additionalProperties": false
24
+ },
25
+ "caveman": {
26
+ "type": "BOOLEAN",
27
+ "description": "Toggled state of minimal-token prompt rules"
28
+ },
29
+ "template": {
30
+ "type": "STRING",
31
+ "description": "Selected baseline technology stack template name"
32
+ }
33
+ },
34
+ "additionalProperties": false
35
+ }
@@ -0,0 +1,33 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "MultiModel Dev OS Template Schema",
4
+ "description": "JSON schema reference defining expectations for pre-configured stack templates",
5
+ "type": "OBJECT",
6
+ "required": ["name", "requiredFiles"],
7
+ "properties": {
8
+ "name": {
9
+ "type": "STRING",
10
+ "description": "The unique identifying template name"
11
+ },
12
+ "description": {
13
+ "type": "STRING",
14
+ "description": "A description of the technology stack profile"
15
+ },
16
+ "requiredFiles": {
17
+ "type": "ARRAY",
18
+ "items": { "type": "STRING" },
19
+ "description": "Baseline contracts and subfolders required to scaffold"
20
+ },
21
+ "optionalFiles": {
22
+ "type": "ARRAY",
23
+ "items": { "type": "STRING" },
24
+ "description": "Optional overrides or specific skill prompts files"
25
+ },
26
+ "supportedAdapters": {
27
+ "type": "ARRAY",
28
+ "items": { "type": "STRING" },
29
+ "description": "IDE and terminal adapters validated for the template"
30
+ }
31
+ },
32
+ "additionalProperties": false
33
+ }
package/README.md CHANGED
@@ -1,16 +1,25 @@
1
1
  # MultiModel Dev OS
2
2
 
3
- Portable, vendor-neutral workspace configuration layer for multi-agent coding loops.
3
+ <p align="center">
4
+ <img src="assets/logo.png" alt="MultiModel Dev OS Logo" width="160">
5
+ </p>
4
6
 
5
- ---
7
+ <p align="center">
8
+ <b>One portable AI Dev OS for multimodel coding workflows.</b>
9
+ </p>
6
10
 
7
11
  <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%">
12
+ [![NPM Version](https://img.shields.io/npm/v/multimodel-dev-os.svg?color=blue&style=flat-square)](https://www.npmjs.com/package/multimodel-dev-os)
13
+ [![NPM Package](https://img.shields.io/badge/npm-package-cb3837.svg?style=flat-square)](https://www.npmjs.com/package/multimodel-dev-os)
14
+ [![License](https://img.shields.io/npm/l/multimodel-dev-os.svg?color=green&style=flat-square)](https://github.com/rizvee/multimodel-dev-os/blob/main/LICENSE)
15
+ [![GitHub Release](https://img.shields.io/github/v/release/rizvee/multimodel-dev-os?color=indigo&style=flat-square)](https://github.com/rizvee/multimodel-dev-os/releases)
16
+ [![Build Verification](https://img.shields.io/github/actions/workflow/status/rizvee/multimodel-dev-os/verify.yml?branch=main&style=flat-square&label=verification)](https://github.com/rizvee/multimodel-dev-os/actions)
17
+ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-emerald.svg?style=flat-square)](https://github.com/rizvee/multimodel-dev-os/blob/main/CONTRIBUTING.md)
9
18
  </p>
10
19
 
11
20
  ---
12
21
 
13
- ## Quickstart
22
+ ## One portable AI Dev OS for Codex, Antigravity, Cursor, Claude, Gemini, VS Code, and multimodel coding workflows.
14
23
 
15
24
  Initialize a unified, tool-neutral AI developer workspace instantly:
16
25
 
@@ -18,29 +27,112 @@ Initialize a unified, tool-neutral AI developer workspace instantly:
18
27
  npx multimodel-dev-os@latest init
19
28
  ```
20
29
 
30
+ > **Give Codex, Antigravity, Cursor, Claude, Gemini, VS Code, and other AI coding agents the same project brain.**
31
+
32
+ ---
33
+
34
+ <p align="center">
35
+ <img src="assets/social-preview.svg" alt="MultiModel Dev OS Banner" width="100%">
36
+ </p>
37
+
38
+ ---
39
+
40
+ ## Why This Exists
41
+
42
+ AI pair programmers are lightning-fast, but switching between them introduces context fragmentation:
43
+ 1. **Context Loss:** You use **Cursor** for autocomplete, **Claude Code** for command execution, and **Gemini/Antigravity** for deep audits. Every switch forces you to rebuild context.
44
+ 2. **Instruction Drift:** Different tools look for different config files (`.cursorrules`, `CLAUDE.md`, `.vscode/settings.json`, `.gemini/settings.json`). Modifying style rules or build parameters in one place leaves the others outdated.
45
+
46
+ `multimodel-dev-os` solves this by establishing a single source of truth in your repository: four root contracts (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`) and a `.ai/` directory that bridges them to all major tools dynamically.
47
+
21
48
  ---
22
49
 
23
- ## See It in Action
50
+ ## What You Get
51
+
52
+ A standard installation scaffolds a lightweight, zero-runtime-dependency workspace hierarchy:
24
53
 
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:
54
+ ```
55
+ ┌────────────────────────────────────────────────────────┐
56
+ │ LAYER 1: Root Contracts (Single Source of Truth) │
57
+ │ AGENTS.md • MEMORY.md • TASKS.md • RUNBOOK.md │
58
+ └──────────────────────────┬─────────────────────────────┘
59
+ │ Centralizes project context
60
+ ┌──────────────────────────▼─────────────────────────────┐
61
+ │ LAYER 2: Configuration & Modules (.ai/) │
62
+ │ context/ • agents/ • skills/ • prompts/ • checks/ │
63
+ └──────────────────────────┬─────────────────────────────┘
64
+ │ Routes files dynamically
65
+ ┌──────────────────────────▼─────────────────────────────┐
66
+ │ LAYER 3: Tool & IDE Adapters │
67
+ │ .cursorrules • CLAUDE.md • .vscode/ • .gemini/ │
68
+ └────────────────────────────────────────────────────────┘
69
+ ```
26
70
 
27
71
  <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%">
72
+ <img src="assets/architecture-preview.svg" alt="Architecture Diagram" width="100%">
29
73
  </p>
30
74
 
31
75
  ---
32
76
 
33
- ## Before vs. After
77
+ ## Supported Tools
78
+
79
+ | Tool / Agent | Target Adapter File | Setup Instructions | Behavior Setup |
80
+ | :--- | :--- | :--- | :--- |
81
+ | **Codex** | `adapters/codex/AGENTS.md` | `adapters/codex/setup.md` | Automated code scaffolding |
82
+ | **Antigravity** | `.gemini/settings.json` | `adapters/antigravity/setup.md` | Security and audit parameters |
83
+ | **Cursor** | `.cursorrules` | `adapters/cursor/setup.md` | Inline autocomplete guidelines |
84
+ | **Claude Code** | `CLAUDE.md` | `adapters/claude/setup.md` | Terminal build and run controls |
85
+ | **Gemini** | `GEMINI.md` | `adapters/gemini/setup.md` | Prompt system context logs |
86
+ | **VS Code** | `.vscode/settings.json` | `adapters/vscode/setup.md` | Editor layout and search limits |
87
+
88
+ ---
89
+
90
+ ## Why Not Just a Manual AGENTS.md?
34
91
 
35
- ### Before: Chaotic Prompting & Instruction Drift
36
- - Switching between agents (like Cursor, Claude Code, Gemini, Codex, Antigravity) 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.
92
+ While you can write a raw markdown file manually, `multimodel-dev-os` offers a standardized development workflow:
39
93
 
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.
94
+ | Feature | Manual Rules File | MultiModel Dev OS |
95
+ | :--- | :--- | :--- |
96
+ | **Tool Synchronization** | Manual copy-paste across tools | Automated dynamic adapters |
97
+ | **Context Budgets** | Bloats prompts, wasting cost | **Caveman Mode** slashes tokens by **~79%** |
98
+ | **Standards Enforcement**| Easy to drift and corrupt | Built-in CLI `validate` and `doctor` checks |
99
+ | **Onboarding baseline** | Start from scratch | 5 production-ready real-world templates |
100
+
101
+ ---
102
+
103
+ ## Interactive Command Line Interface (CLI)
104
+
105
+ MultiModel Dev OS is powered by a pure Node.js CLI with **zero runtime external npm dependencies**.
106
+
107
+ <p align="center">
108
+ <img src="assets/terminal-demo.svg" alt="Terminal Demo Sequence" width="100%">
109
+ </p>
110
+
111
+ ### 1. Scaffolding Templates
112
+ Initialize customized stack specifications:
113
+ - **Next.js SaaS:** `npx multimodel-dev-os@latest init --template nextjs-saas`
114
+ - **WordPress Theme/Plugin:** `npx multimodel-dev-os@latest init --template wordpress-site`
115
+ - **E-Commerce Store:** `npx multimodel-dev-os@latest init --template ecommerce-store`
116
+ - **SEO Landing Page:** `npx multimodel-dev-os@latest init --template seo-landing-page`
117
+ - **General Fallback:** `npx multimodel-dev-os@latest init --template general-app`
118
+
119
+ ### 2. Adapter Linking
120
+ Inject rules specifically for a developer tool:
121
+ ```bash
122
+ npx multimodel-dev-os@latest init --adapter cursor
123
+ npx multimodel-dev-os@latest init --adapter claude
124
+ ```
125
+
126
+ ### 3. Caveman Mode (Token Optimizer)
127
+ Cuts prompt rules overhead down by **~79%** using highly optimized short-hand declarations:
128
+ ```bash
129
+ npx multimodel-dev-os@latest init --caveman
130
+ ```
131
+
132
+ ### 4. Quality Gates
133
+ Run assertions and diagnostic checkups:
134
+ - **`validate`** (Strict schema checkup): `npx multimodel-dev-os validate`
135
+ - **`doctor`** (Advisory compatibility warning): `npx multimodel-dev-os doctor`
44
136
 
45
137
  ---
46
138
 
@@ -49,13 +141,9 @@ npx multimodel-dev-os@latest init
49
141
  Minimize prompt overhead and API billing by mapping key context-reduction techniques to MultiModel Dev OS features:
50
142
 
51
143
  <p align="center">
52
- <img src="https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/assets/cost-optimization.svg" alt="Cost Optimization Funnel" width="100%">
144
+ <img src="assets/cost-optimization.svg" alt="Cost Optimization Funnel" width="100%">
53
145
  </p>
54
146
 
55
- - 🧠 **Choose Right Model:** Configured in `model-map.md`.
56
- - ⚡ **Caveman Mode:** Cuts rule context sizes down by **~79%**.
57
- - 📦 **RAG Scoping:** Modular context files in `.ai/context/` prevent token waste.
58
-
59
147
  For a full deep dive, see our [Cost Optimization Playbook](https://rizvee.github.io/multimodel-dev-os/cost-optimization).
60
148
 
61
149
  ---
@@ -65,7 +153,7 @@ For a full deep dive, see our [Cost Optimization Playbook](https://rizvee.github
65
153
  Deploying MultiModel Dev OS across your team is straightforward and tool-neutral:
66
154
 
67
155
  <p align="center">
68
- <img src="https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/assets/ai-dev-os-roadmap.svg" alt="5-Day Adoption Roadmap" width="100%">
156
+ <img src="assets/ai-dev-os-roadmap.svg" alt="5-Day Adoption Roadmap" width="100%">
69
157
  </p>
70
158
 
71
159
  See our step-by-step timeline: [5-Day Adoption Roadmap Playbook](https://rizvee.github.io/multimodel-dev-os/5-day-roadmap).
@@ -83,15 +171,33 @@ Discover how engineering teams deploy MultiModel Dev OS:
83
171
 
84
172
  ---
85
173
 
86
- ## Core Navigation Guides
174
+ ## Stable Protocol Specification
175
+
176
+ MultiModel Dev OS version `v1.1.0` officially freezes the Layer 1, Layer 2, and Layer 3 specifications:
177
+ - 🛡️ [Stable Protocol Specification](https://rizvee.github.io/multimodel-dev-os/stable-protocol)
178
+ - 🔌 [Multi-Agent Compatibility Guides](https://rizvee.github.io/multimodel-dev-os/compatibility)
179
+ - 📈 [Upgrade & Migration Guide](https://rizvee.github.io/multimodel-dev-os/migration-guide)
180
+ - 🏁 [v1.0.0 Release Quality Checklist](https://rizvee.github.io/multimodel-dev-os/v1-checklist)
181
+
182
+ ---
183
+
184
+ ## Contributing
185
+
186
+ We love contributions! Propose new adapters, request built-in templates, or report issues safely.
187
+ Read our [Contributing Onboarding Guidelines](CONTRIBUTING.md) to get started.
188
+
189
+ ---
190
+
191
+ ## Docs & Staging Links
87
192
 
88
- Explore our detailed manuals directly:
89
- - 📖 [CLI Terminal Demo Guide](https://rizvee.github.io/multimodel-dev-os/demo)
90
- - 💡 [Before/After Workflow Case Studies](https://rizvee.github.io/multimodel-dev-os/workflow-examples)
91
- - 🛡️ [Public Release & Staging Checklist](https://rizvee.github.io/multimodel-dev-os/launch-checklist)
193
+ Explore detailed specifications, guides, and playbooks at the official docs portal:
194
+ 👉 **[Documentation site](https://rizvee.github.io/multimodel-dev-os/)**
195
+ 👉 **[GitHub repository](https://github.com/rizvee/multimodel-dev-os)**
196
+ 👉 **[NPM registry](https://www.npmjs.com/package/multimodel-dev-os)**
197
+ 👉 **[llms.txt discoverability guide](https://rizvee.github.io/multimodel-dev-os/llms.txt)**
92
198
 
93
199
  ---
94
200
 
95
201
  ## License
96
202
 
97
- MIT License.
203
+ MIT License. Copyright (c) 2026-present MultiModel Dev OS team.
Binary file
Binary file
@@ -202,6 +202,7 @@ function handleInit(options) {
202
202
  // Source path mapping for core files
203
203
  let templateDir = join(sourceRoot, 'examples', options.template);
204
204
  if (!existsSync(templateDir)) {
205
+ console.warn(` \x1b[33m[WARNING] Template '${options.template}' not found. Falling back to 'general-app' profile.\x1b[0m`);
205
206
  templateDir = join(sourceRoot, 'examples', 'general-app');
206
207
  }
207
208
 
@@ -3,6 +3,40 @@ export default {
3
3
  title: 'MultiModel Dev OS',
4
4
  description: 'Portable, vendor-neutral AI Developer OS for multi-agent coding workflows.',
5
5
  ignoreDeadLinks: true,
6
+ head: [
7
+ ['link', { rel: 'icon', href: '/multimodel-dev-os/favicon.png', type: 'image/png' }],
8
+ ['link', { rel: 'canonical', href: 'https://rizvee.github.io/multimodel-dev-os/' }],
9
+ ['meta', { name: 'theme-color', content: '#6366f1' }],
10
+ ['meta', { name: 'robots', content: 'index, follow' }],
11
+ ['meta', { name: 'application-name', content: 'MultiModel Dev OS' }],
12
+ ['meta', { name: 'apple-mobile-web-app-title', content: 'MultiModel Dev OS' }],
13
+ ['meta', { property: 'og:title', content: 'MultiModel Dev OS' }],
14
+ ['meta', { property: 'og:description', content: 'Portable AI Dev OS for Codex, Antigravity, Cursor, Claude, Gemini, VS Code, and multimodel coding workflows.' }],
15
+ ['meta', { property: 'og:image', content: 'https://rizvee.github.io/multimodel-dev-os/assets/social-preview.svg' }],
16
+ ['meta', { property: 'og:url', content: 'https://rizvee.github.io/multimodel-dev-os/' }],
17
+ ['meta', { property: 'og:type', content: 'website' }],
18
+ ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
19
+ ['meta', { name: 'twitter:title', content: 'MultiModel Dev OS' }],
20
+ ['meta', { name: 'twitter:description', content: 'Portable AI Dev OS for Codex, Antigravity, Cursor, Claude, Gemini, VS Code, and multimodel coding workflows.' }],
21
+ ['meta', { name: 'twitter:image', content: 'https://rizvee.github.io/multimodel-dev-os/assets/social-preview.svg' }],
22
+ [
23
+ 'script',
24
+ { type: 'application/ld+json' },
25
+ JSON.stringify({
26
+ '@context': 'https://schema.org',
27
+ '@type': 'SoftwareApplication',
28
+ 'name': 'MultiModel Dev OS',
29
+ 'applicationCategory': 'DeveloperApplication',
30
+ 'operatingSystem': 'Windows, macOS, Linux',
31
+ 'programmingLanguage': 'JavaScript',
32
+ 'license': 'https://opensource.org/licenses/MIT',
33
+ 'url': 'https://github.com/rizvee/multimodel-dev-os',
34
+ 'downloadUrl': 'https://www.npmjs.com/package/multimodel-dev-os',
35
+ 'softwareVersion': '1.1.0',
36
+ 'description': 'Portable, vendor-neutral AI Developer OS for multi-agent coding workflows.'
37
+ })
38
+ ]
39
+ ],
6
40
  themeConfig: {
7
41
  logo: '/logo.png',
8
42
  nav: [
@@ -21,6 +55,17 @@ export default {
21
55
  { text: 'FAQ', link: '/faq' }
22
56
  ]
23
57
  },
58
+ {
59
+ text: 'Protocol & QA Specifications',
60
+ items: [
61
+ { text: 'Protocol Specification', link: '/protocol' },
62
+ { text: 'Stable Protocol Specification', link: '/stable-protocol' },
63
+ { text: 'Adapter Compatibility', link: '/compatibility' },
64
+ { text: 'Upgrades & Migration', link: '/migration-guide' },
65
+ { text: 'Templates QA Blueprint', link: '/template-qa' },
66
+ { text: 'v1.0.0 Readiness Checklist', link: '/v1-readiness' }
67
+ ]
68
+ },
24
69
  {
25
70
  text: 'Case Studies & Playbooks',
26
71
  items: [
@@ -64,7 +109,11 @@ export default {
64
109
  { text: 'Release Playbook Template', link: '/release-template' },
65
110
  { text: 'CLI Roadmap', link: '/cli-roadmap' },
66
111
  { text: 'NPM Publishing Runbook', link: '/npm-publishing' },
67
- { text: 'Pre-flight Release Testing', link: '/testing-v0.2' }
112
+ { text: 'Pre-flight Release Testing', link: '/testing-v0.2' },
113
+ { text: 'Release Policy', link: '/release-policy' },
114
+ { text: 'Support Policy', link: '/support-policy' },
115
+ { text: 'Final Launch Guidelines', link: '/final-launch' },
116
+ { text: 'v1.0.0 Release Checklist', link: '/v1-checklist' }
68
117
  ]
69
118
  }
70
119
  ],
@@ -1,6 +1,8 @@
1
- # Real-World Case Studies
1
+ # Real-World Case Studies: AI Dev OS Integrations
2
2
 
3
- Explore how engineering teams and developers leverage `multimodel-dev-os` to prevent instruction drift, secure workspace boundaries, and save significant LLM token context budgets.
3
+ Explore how engineering teams and developers leverage MultiModel Dev OS to prevent instruction drift, secure workspace boundaries, and save significant LLM token context budgets.
4
+
5
+ > **Use when**: Designing a workflow for a specific tech stack (like Next.js SaaS schema synchronization, WordPress themes, headless checkout loops, or multi-model handoffs).
4
6
 
5
7
  ---
6
8
 
@@ -9,16 +11,18 @@ Explore how engineering teams and developers leverage `multimodel-dev-os` to pre
9
11
  Select a case study to see specific problems, setups, commands, outcomes, and reusable design patterns:
10
12
 
11
13
  ### 1. [Full-Stack Next.js SaaS](nextjs-saas.md)
12
- *Solving schema sync and inline autocompletion shifts across full-stack applications.*
14
+ *Solving schema sync and inline autocompletion shifts across full-stack applications (Nextjs SaaS template / database schema synchronization).*
13
15
 
14
16
  ### 2. [WordPress Theme & Plugin Development](wordpress-site.md)
15
- *Securing PHP coding style conventions and folder overrides during local scaffolding.*
17
+ *Securing PHP coding style conventions and folder overrides during local scaffolding (WordPress theme folder boundaries).*
16
18
 
17
19
  ### 3. [E-Commerce Webhooks & State Tracking](ecommerce-store.md)
18
- *Keeping payment routes and database event states strictly aligned between terminal-based models and editors.*
20
+ *Keeping payment routes and database event states strictly aligned between terminal-based models and editors (e-commerce state webhooks).*
19
21
 
20
22
  ### 4. [SEO Landing Page Audits](seo-landing-page.md)
21
- *Managing multiple automated performance linter audits and SEO checkups.*
23
+ *Managing multiple automated performance linter audits and SEO checkups (SEO landing page performance Core Web Vitals).*
22
24
 
23
25
  ### 5. [Multi-Model Handoff Protocols](multimodel-handoff.md)
24
- *Structuring sequential session logs to pass context between Claude Code and Gemini with zero token drops.*
26
+ *Structuring sequential session logs to pass context between Claude Code and Gemini with zero token drops (Claude Gemini handoff logs).*
27
+
28
+ Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
@@ -54,3 +54,11 @@ node bin/multimodel-dev-os.js verify
54
54
  * **Adapter Autoregeneration (`sync`):** Parse custom override boundaries inside adapters and automatically synchronize them with updates in the root markdown source of truth.
55
55
  * **Interactive Mode:** Provide step-by-step CLI options if run without arguments.
56
56
 
57
+ ## Protocol Stabilization & v1.0.0 Freeze (v0.9.0)
58
+
59
+ In version **v0.9.0**, we pivot the roadmap to focus on **stabilization and hardening** ahead of the official `v1.0.0` freeze:
60
+ - **API Freeze:** The CLI syntax, standard command names (`init`, `verify`, `validate`, `doctor`, `templates`), and dynamic flags are frozen to ensure zero breaking changes in future minor patches.
61
+ - **Robust JSON Schemas:** Added standard validators inside `.ai/schema/` to define config and template formats.
62
+ - **Continuous Integration Gates:** Transitioning `validate` to serve as a strict build blocker for pulling and publishing code.
63
+ - **Enhanced Warning Paths:** Hardened CLI error messaging when directory write conflicts occur, mapping absolute paths cleanly.
64
+
@@ -0,0 +1,46 @@
1
+ # Compatibility & Customization Guide
2
+
3
+ This document maps how MultiModel Dev OS integrates across diverse IDEs and terminal utilities, detailing what parameters developers can customize without breaking the protocol.
4
+
5
+ > **Use when**: Setting up tool configurations (like Cursor project rules or Claude Code project instructions) or configuring the active adapter mappings in `.ai/config.yaml`.
6
+
7
+ ---
8
+
9
+ ## 1. Supported Tool Matrix
10
+
11
+ The CLI routes centralized specifications directly to the following target adapters:
12
+
13
+ | Tool / Agent | Target Adapter File | Setup Instructions | Behavior Setup |
14
+ | :--- | :--- | :--- | :--- |
15
+ | **Cursor** | `.cursorrules` | `adapters/cursor/setup.md` | Inline autocomplete guidelines |
16
+ | **Claude Code** | `CLAUDE.md` | `adapters/claude/setup.md` | Terminal build and run controls |
17
+ | **VS Code** | `.vscode/settings.json` | `adapters/vscode/setup.md` | Editor layout and search limits |
18
+ | **Gemini** | `GEMINI.md` | `adapters/gemini/setup.md` | Prompt system context logs |
19
+ | **Antigravity** | `.gemini/settings.json` | `adapters/antigravity/setup.md` | Security and audit parameters |
20
+ | **Codex** | `adapters/codex/AGENTS.md` | `adapters/codex/setup.md` | Automated code scaffolding |
21
+
22
+ ---
23
+
24
+ ## 2. Safe Customizations
25
+
26
+ Developers can customize the following configurations inside the `.ai/` directory without breaking linter checkups:
27
+ - **Skills and Prompts:** Adding custom task files under `.ai/skills/` (e.g., custom database migrations, API setups).
28
+ - **Core Memory Notes:** Expanding milestones or architectural notes in `MEMORY.md` and `RUNBOOK.md`.
29
+ - **Model Routings:** Adjusting provider selections and endpoint targets inside `.ai/context/model-map.md`.
30
+
31
+ ---
32
+
33
+ ## 3. Strict Rules (Do Not Rename)
34
+
35
+ To guarantee validation compliance:
36
+ - **Do Not Rename Root Documents:** The core contract files (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`) must reside exactly at the repository root and use capital letters.
37
+ - **Do Not Modify Schema Subfolders:** Subdirectories under `.ai/` (context, skills, prompts, checks, session-logs) must maintain lower-case names.
38
+ - **Do Not Interfere with CLI Flags:** Compliance checks expect `init`, `validate`, and `doctor` to accept `--target` and `--adapter` variables consistently.
39
+
40
+ ---
41
+
42
+ ## 4. v1.1.0 Compatibility Guarantee
43
+
44
+ The supported tool matrix and custom specifications listed here represent the officially frozen contracts of MultiModel Dev OS `v1.1.0`. Any backward-compatible extensions introduced in subsequent `1.x` releases will build on top of these mappings without breaking current project integrations.
45
+
46
+ Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
@@ -1,6 +1,8 @@
1
- # LLM Cost & Context Optimization Playbook
1
+ # LLM Cost & Context Optimization Playbook (v1.1.0)
2
2
 
3
- Maximizing developer velocity while minimizing LLM prompt overhead and API billing budgets is a critical priority for engineering teams. This playbook maps 12 industry cost-reduction techniques directly to native `multimodel-dev-os` features.
3
+ Maximizing developer velocity while minimizing LLM prompt overhead and API billing budgets is a critical priority for engineering teams. This playbook maps 12 industry cost-reduction techniques directly to native MultiModel Dev OS features.
4
+
5
+ > **Use when**: Optimizing API token usage, configuring Caveman Mode settings, or designing modular prompt caching strategies.
4
6
 
5
7
  ---
6
8
 
@@ -59,3 +61,5 @@ Below is how the 12 core context optimization strategies are implemented inside
59
61
  ### 12. Embedding Hygiene
60
62
  - **The Strategy:** Ensure semantic search indexes only relevant source files instead of temporary distributions.
61
63
  - **Dev OS Implementation:** Strict routing specifications mapped inside `context-routing.md` and pre-configured `.gitignore` definitions protect search databases from index pollution.
64
+
65
+ Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
package/docs/faq.md CHANGED
@@ -1,83 +1,67 @@
1
- # FAQ
1
+ # FAQ: MultiModel Dev OS Questions & Answers
2
+
3
+ Frequently asked questions regarding MultiModel Dev OS, AI coding agents compatibility, and prompt context optimization.
4
+
5
+ > **Use when**: Resolving setup ambiguities, understanding comparative advantages over simple rules files, or auditing CLI validations.
6
+
7
+ ---
2
8
 
3
9
  ## General
4
10
 
5
- **What is multimodel-dev-os?**
6
- A set of markdown files and conventions that let multiple AI coding tools
7
- (Codex, Cursor, Claude, Gemini, Antigravity, VS Code) share the same
8
- project context. Not a runtime. Not an AI agent. Think `.editorconfig`
9
- but for AI tools.
11
+ **What is MultiModel Dev OS?**
12
+ A set of markdown templates and directory structures that allow multiple AI coding tools (Codex, Cursor, Claude Code, Gemini, Antigravity, VS Code) to share a single portable AI project context. It acts like `.editorconfig` but for AI assistants.
10
13
 
11
- **Is this an operating system?**
12
- No. "Dev OS" is a metaphor for the shared operating layer between tools.
13
- It's just markdown files in your repo.
14
+ **Is this a runtime operating system?**
15
+ No. It is a metaphorical "OS" providing standard files (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`) to coordinate multiple tools.
14
16
 
15
17
  **What does "multimodel" mean?**
16
- Multiple AI models/tools working on the same project.
17
- Not "multimodal" (multiple input types like text + image).
18
+ Multiple distinct AI coding models/agents (such as Codex, Antigravity, Cursor, and Claude Code) operating sequentially on the exact same workspace branch.
19
+
20
+ ---
18
21
 
19
22
  ## Setup
20
23
 
21
24
  **Do I need Node.js?**
22
25
  It depends on your installation path:
23
- * **Yes:** If you run the primary, recommended `npx multimodel-dev-os@latest init` workflow, Node.js is required.
24
- * **No:** If you run the fallback automated shell installer scripts (`install.sh` or `install.ps1`), they run purely on native bash or PowerShell and download resources directly.
26
+ * **Yes:** If you run the primary, recommended `npx multimodel-dev-os@latest init` workflow.
27
+ * **No:** If you run the fallback bash (`install.sh`) or PowerShell (`install.ps1`) one-liners.
25
28
 
26
29
  **Why not just write a single manual AGENTS.md myself?**
27
- While you can write a raw markdown instruction file manually, `multimodel-dev-os` offers a standardized development environment:
28
- 1. **Automated Bridging:** Rather than copying and pasting rules into `.cursorrules`, `CLAUDE.md`, `.vscode/settings.json`, and `.gemini/settings.json`, our adapters dynamically references your root source of truth.
29
- 2. **Standardized Context Segregation:** Separates concerns cleanly (`MEMORY.md` for architectural context, `TASKS.md` for task state tracking, `RUNBOOK.md` for incident response, and `.ai/` for skills and prompts).
30
- 3. **Structured Verification:** Pre-packaged CLI and verification scripts test and assert the structural completeness of your rules.
31
- 4. **Token Savings:** Seamlessly switches into Caveman Mode to slash token footprints by **~79%** for smaller models.
32
-
33
- **Can I use just one AI tool?**
34
- Yes. Use a single adapter. The multi-agent features are optional.
30
+ While you can write a raw markdown file, MultiModel Dev OS offers:
31
+ 1. **Automated Bridging:** Adapters dynamically map your root source to Cursor, Claude, and Gemini native rules.
32
+ 2. **Context Budgets:** Toggle **Caveman Mode** to slash prompt rules overhead by **~79%**.
33
+ 3. **Structured Verification:** Built-in CLI commands validate workspace specifications instantly.
35
34
 
36
- **Which files are required?**
37
- At minimum: `AGENTS.md`. Everything else is optional.
38
- The installer creates the full structure, but you can delete what you don't need.
35
+ ---
39
36
 
40
37
  ## Adapters
41
38
 
42
39
  **Do I copy adapter files to my project root?**
43
40
  Yes, for tools that auto-detect specific files:
44
- - Cursor → copy `.cursorrules` to root
45
- - Claude → copy `CLAUDE.md` to root
46
- - VS Code → copy `.vscode/` to root
47
-
48
- **My tool isn't listed. Can I add one?**
49
- Yes. See [docs/adapters.md](adapters.md) for the guide. PRs welcome.
41
+ - Cursor → `.cursorrules`
42
+ - Claude Code → `CLAUDE.md`
43
+ - VS Code → `.vscode/settings.json`
50
44
 
51
- **Will adapters break if a tool changes its config format?**
52
- Possibly. Adapters are community-maintained. File an issue if you
53
- notice an adapter is outdated.
45
+ ---
54
46
 
55
47
  ## Caveman Mode
56
48
 
57
49
  **When should I use Caveman Mode?**
58
- When your context window is tight, your model is small, or you're
59
- optimizing for API cost. It cuts ~79% of tokens.
50
+ **Best for**: Context optimization for AI coding when you are using compact context budget windows, smaller models, or want to save money on API bill parameters.
60
51
 
61
- **Can I mix standard and caveman files?**
62
- Yes. Each file is independent. You could have a standard `AGENTS.md`
63
- and a caveman `TASKS.md`.
64
-
65
- ## Orchestrator
66
-
67
- **Does the orchestrator run agents automatically?**
68
- No, not in v0.1. It's a protocol spec — conventions for how agents
69
- should coordinate. Runtime orchestration is planned for v0.2+.
70
-
71
- **Do I need the orchestrator for single-agent workflows?**
72
- No. The orchestrator is only relevant when multiple agents work
73
- on the same codebase.
52
+ ---
74
53
 
75
54
  ## Diagnostics & Validation
76
55
 
77
56
  **What is the difference between `validate` and `doctor`?**
78
- * **`validate`** is strict and verifies that your workspace strictly complies with the multimodel-dev-os directory schema. It checks for the existence of core files/directories and ensures enabled adapter rule references are not broken. If any checks fail, it exits with an error status (exit code 1).
79
- * **`doctor`** is advisory. It inspects compatibility constraints, warning you about potential context bloat (e.g. missing `.gitignore` files or non-ignored build directories) or active rules missing matching files. It reports warnings without blocking execution.
57
+ * **`validate`** is strict and verifies compliance with the directory schema.
58
+ * **`doctor`** is advisory and warns you about large unignored directories or empty placeholders.
59
+
60
+ ---
61
+
62
+ ## Protocol & Migration
80
63
 
81
- **How do I view available scaffolding templates?**
82
- You can use `node bin/multimodel-dev-os.js templates` (or `list-templates`) to view all available tech stacks and detailed blueprints, or `show-template <name>` to inspect a specific template's specifications.
64
+ **Is the MultiModel Dev OS protocol stable?**
65
+ Yes. As of version `v1.1.0`, the core specifications are officially frozen and backward-compatible. This ensures that any codebase prepared using `v1.1.0` will operate seamlessly inside future `1.x` ecosystems.
83
66
 
67
+ Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.