multimodel-dev-os 0.8.0 → 1.0.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.
- package/.ai/schema/adapter.schema.json +27 -0
- package/.ai/schema/config.schema.json +35 -0
- package/.ai/schema/template.schema.json +33 -0
- package/README.md +123 -31
- package/bin/multimodel-dev-os.js +1 -0
- package/docs/.vitepress/config.js +16 -1
- package/docs/cli-roadmap.md +8 -0
- package/docs/compatibility.md +42 -0
- package/docs/faq.md +8 -0
- package/docs/final-launch.md +29 -0
- package/docs/index.md +81 -7
- package/docs/migration-guide.md +54 -0
- package/docs/protocol.md +54 -0
- package/docs/release-policy.md +33 -0
- package/docs/stable-protocol.md +66 -0
- package/docs/support-policy.md +26 -0
- package/docs/template-qa.md +40 -0
- package/docs/templates-guide.md +6 -0
- package/docs/v1-checklist.md +31 -0
- package/docs/v1-readiness.md +29 -0
- package/package.json +1 -1
- package/scripts/verify.js +22 -0
|
@@ -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,46 +1,127 @@
|
|
|
1
1
|
# MultiModel Dev OS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/multimodel-dev-os)
|
|
4
|
+
[](https://github.com/rizvee/multimodel-dev-os/blob/main/LICENSE)
|
|
5
|
+
[](https://github.com/rizvee/multimodel-dev-os/releases)
|
|
6
|
+
[](https://github.com/rizvee/multimodel-dev-os/actions)
|
|
7
|
+
[](https://github.com/rizvee/multimodel-dev-os/blob/main/CONTRIBUTING.md)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## One portable AI Dev OS for Codex, Antigravity, Cursor, Claude, Gemini, VS Code, and multimodel coding workflows.
|
|
12
|
+
|
|
13
|
+
Initialize a unified, tool-neutral AI developer workspace instantly:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx multimodel-dev-os@latest init
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
> **Give every AI coding agent the same project brain.**
|
|
4
20
|
|
|
5
21
|
---
|
|
6
22
|
|
|
7
23
|
<p align="center">
|
|
8
|
-
<img src="
|
|
24
|
+
<img src="assets/social-preview.svg" alt="MultiModel Dev OS Banner" width="100%">
|
|
9
25
|
</p>
|
|
10
26
|
|
|
11
27
|
---
|
|
12
28
|
|
|
13
|
-
##
|
|
29
|
+
## Why This Exists
|
|
14
30
|
|
|
15
|
-
|
|
31
|
+
AI pair programmers are lightning-fast, but switching between them introduces context fragmentation:
|
|
32
|
+
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.
|
|
33
|
+
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.
|
|
16
34
|
|
|
17
|
-
|
|
18
|
-
npx multimodel-dev-os@latest init
|
|
19
|
-
```
|
|
35
|
+
`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.
|
|
20
36
|
|
|
21
37
|
---
|
|
22
38
|
|
|
23
|
-
##
|
|
39
|
+
## What You Get
|
|
40
|
+
|
|
41
|
+
A standard installation scaffolds a lightweight, zero-runtime-dependency workspace hierarchy:
|
|
24
42
|
|
|
25
|
-
|
|
43
|
+
```
|
|
44
|
+
┌────────────────────────────────────────────────────────┐
|
|
45
|
+
│ LAYER 1: Root Contracts (Single Source of Truth) │
|
|
46
|
+
│ AGENTS.md • MEMORY.md • TASKS.md • RUNBOOK.md │
|
|
47
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
48
|
+
│ Centralizes project context
|
|
49
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
50
|
+
│ LAYER 2: Configuration & Modules (.ai/) │
|
|
51
|
+
│ context/ • agents/ • skills/ • prompts/ • checks/ │
|
|
52
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
53
|
+
│ Routes files dynamically
|
|
54
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
55
|
+
│ LAYER 3: Tool & IDE Adapters │
|
|
56
|
+
│ .cursorrules • CLAUDE.md • .vscode/ • .gemini/ │
|
|
57
|
+
└────────────────────────────────────────────────────────┘
|
|
58
|
+
```
|
|
26
59
|
|
|
27
60
|
<p align="center">
|
|
28
|
-
<img src="
|
|
61
|
+
<img src="assets/architecture-preview.svg" alt="Architecture Diagram" width="100%">
|
|
29
62
|
</p>
|
|
30
63
|
|
|
31
64
|
---
|
|
32
65
|
|
|
33
|
-
##
|
|
66
|
+
## Supported Tools
|
|
34
67
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
68
|
+
| Tool / Agent | Target Adapter File | Setup Instructions | Behavior Setup |
|
|
69
|
+
| :--- | :--- | :--- | :--- |
|
|
70
|
+
| **Cursor** | `.cursorrules` | `adapters/cursor/setup.md` | Inline autocomplete guidelines |
|
|
71
|
+
| **Claude Code** | `CLAUDE.md` | `adapters/claude/setup.md` | Terminal build and run controls |
|
|
72
|
+
| **VS Code** | `.vscode/settings.json` | `adapters/vscode/setup.md` | Editor layout and search limits |
|
|
73
|
+
| **Gemini** | `GEMINI.md` | `adapters/gemini/setup.md` | Prompt system context logs |
|
|
74
|
+
| **Antigravity** | `.gemini/settings.json` | `adapters/antigravity/setup.md` | Security and audit parameters |
|
|
75
|
+
| **Codex** | `adapters/codex/AGENTS.md` | `adapters/codex/setup.md` | Automated code scaffolding |
|
|
39
76
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Why Not Just a Manual AGENTS.md?
|
|
80
|
+
|
|
81
|
+
While you can write a raw markdown file manually, `multimodel-dev-os` offers a standardized development workflow:
|
|
82
|
+
|
|
83
|
+
| Feature | Manual Rules File | MultiModel Dev OS |
|
|
84
|
+
| :--- | :--- | :--- |
|
|
85
|
+
| **Tool Synchronization** | Manual copy-paste across tools | Automated dynamic adapters |
|
|
86
|
+
| **Context Budgets** | Bloats prompts, wasting cost | **Caveman Mode** slashes tokens by **~79%** |
|
|
87
|
+
| **Standards Enforcement**| Easy to drift and corrupt | Built-in CLI `validate` and `doctor` checks |
|
|
88
|
+
| **Onboarding baseline** | Start from scratch | 5 production-ready real-world templates |
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Interactive Command Line Interface (CLI)
|
|
93
|
+
|
|
94
|
+
MultiModel Dev OS is powered by a pure Node.js CLI with **zero runtime external npm dependencies**.
|
|
95
|
+
|
|
96
|
+
<p align="center">
|
|
97
|
+
<img src="assets/terminal-demo.svg" alt="Terminal Demo Sequence" width="100%">
|
|
98
|
+
</p>
|
|
99
|
+
|
|
100
|
+
### 1. Scaffolding Templates
|
|
101
|
+
Initialize customized stack specifications:
|
|
102
|
+
- **Next.js SaaS:** `npx multimodel-dev-os@latest init --template nextjs-saas`
|
|
103
|
+
- **WordPress Theme/Plugin:** `npx multimodel-dev-os@latest init --template wordpress-site`
|
|
104
|
+
- **E-Commerce Store:** `npx multimodel-dev-os@latest init --template ecommerce-store`
|
|
105
|
+
- **SEO Landing Page:** `npx multimodel-dev-os@latest init --template seo-landing-page`
|
|
106
|
+
- **General Fallback:** `npx multimodel-dev-os@latest init --template general-app`
|
|
107
|
+
|
|
108
|
+
### 2. Adapter Linking
|
|
109
|
+
Inject rules specifically for a developer tool:
|
|
110
|
+
```bash
|
|
111
|
+
npx multimodel-dev-os@latest init --adapter cursor
|
|
112
|
+
npx multimodel-dev-os@latest init --adapter claude
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### 3. Caveman Mode (Token Optimizer)
|
|
116
|
+
Cuts prompt rules overhead down by **~79%** using highly optimized short-hand declarations:
|
|
117
|
+
```bash
|
|
118
|
+
npx multimodel-dev-os@latest init --caveman
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 4. Quality Gates
|
|
122
|
+
Run assertions and diagnostic checkups:
|
|
123
|
+
- **`validate`** (Strict schema checkup): `npx multimodel-dev-os validate`
|
|
124
|
+
- **`doctor`** (Advisory compatibility warning): `npx multimodel-dev-os doctor`
|
|
44
125
|
|
|
45
126
|
---
|
|
46
127
|
|
|
@@ -49,13 +130,9 @@ npx multimodel-dev-os@latest init
|
|
|
49
130
|
Minimize prompt overhead and API billing by mapping key context-reduction techniques to MultiModel Dev OS features:
|
|
50
131
|
|
|
51
132
|
<p align="center">
|
|
52
|
-
<img src="
|
|
133
|
+
<img src="assets/cost-optimization.svg" alt="Cost Optimization Funnel" width="100%">
|
|
53
134
|
</p>
|
|
54
135
|
|
|
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
136
|
For a full deep dive, see our [Cost Optimization Playbook](https://rizvee.github.io/multimodel-dev-os/cost-optimization).
|
|
60
137
|
|
|
61
138
|
---
|
|
@@ -65,7 +142,7 @@ For a full deep dive, see our [Cost Optimization Playbook](https://rizvee.github
|
|
|
65
142
|
Deploying MultiModel Dev OS across your team is straightforward and tool-neutral:
|
|
66
143
|
|
|
67
144
|
<p align="center">
|
|
68
|
-
<img src="
|
|
145
|
+
<img src="assets/ai-dev-os-roadmap.svg" alt="5-Day Adoption Roadmap" width="100%">
|
|
69
146
|
</p>
|
|
70
147
|
|
|
71
148
|
See our step-by-step timeline: [5-Day Adoption Roadmap Playbook](https://rizvee.github.io/multimodel-dev-os/5-day-roadmap).
|
|
@@ -83,15 +160,30 @@ Discover how engineering teams deploy MultiModel Dev OS:
|
|
|
83
160
|
|
|
84
161
|
---
|
|
85
162
|
|
|
86
|
-
##
|
|
163
|
+
## Stable Protocol Specification
|
|
164
|
+
|
|
165
|
+
MultiModel Dev OS version `v1.0.0` officially freezes the Layer 1, Layer 2, and Layer 3 specifications:
|
|
166
|
+
- 🛡️ [Stable Protocol Specification](https://rizvee.github.io/multimodel-dev-os/stable-protocol)
|
|
167
|
+
- 🔌 [Multi-Agent Compatibility Guides](https://rizvee.github.io/multimodel-dev-os/compatibility)
|
|
168
|
+
- 📈 [Upgrade & Migration Guide](https://rizvee.github.io/multimodel-dev-os/migration-guide)
|
|
169
|
+
- 🏁 [v1.0.0 Release Quality Checklist](https://rizvee.github.io/multimodel-dev-os/v1-checklist)
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## Contributing
|
|
174
|
+
|
|
175
|
+
We love contributions! Propose new adapters, request built-in templates, or report issues safely.
|
|
176
|
+
Read our [Contributing Onboarding Guidelines](CONTRIBUTING.md) to get started.
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## Docs Site
|
|
87
181
|
|
|
88
|
-
Explore
|
|
89
|
-
|
|
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)
|
|
182
|
+
Explore detailed specifications, guides, and playbooks at the official docs portal:
|
|
183
|
+
👉 **[https://rizvee.github.io/multimodel-dev-os/](https://rizvee.github.io/multimodel-dev-os/)**
|
|
92
184
|
|
|
93
185
|
---
|
|
94
186
|
|
|
95
187
|
## License
|
|
96
188
|
|
|
97
|
-
MIT License.
|
|
189
|
+
MIT License. Copyright (c) 2026-present MultiModel Dev OS team.
|
package/bin/multimodel-dev-os.js
CHANGED
|
@@ -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
|
|
|
@@ -21,6 +21,17 @@ export default {
|
|
|
21
21
|
{ text: 'FAQ', link: '/faq' }
|
|
22
22
|
]
|
|
23
23
|
},
|
|
24
|
+
{
|
|
25
|
+
text: 'Protocol & QA Specifications',
|
|
26
|
+
items: [
|
|
27
|
+
{ text: 'Protocol Specification', link: '/protocol' },
|
|
28
|
+
{ text: 'Stable Protocol Specification', link: '/stable-protocol' },
|
|
29
|
+
{ text: 'Adapter Compatibility', link: '/compatibility' },
|
|
30
|
+
{ text: 'Upgrades & Migration', link: '/migration-guide' },
|
|
31
|
+
{ text: 'Templates QA Blueprint', link: '/template-qa' },
|
|
32
|
+
{ text: 'v1.0.0 Readiness Checklist', link: '/v1-readiness' }
|
|
33
|
+
]
|
|
34
|
+
},
|
|
24
35
|
{
|
|
25
36
|
text: 'Case Studies & Playbooks',
|
|
26
37
|
items: [
|
|
@@ -64,7 +75,11 @@ export default {
|
|
|
64
75
|
{ text: 'Release Playbook Template', link: '/release-template' },
|
|
65
76
|
{ text: 'CLI Roadmap', link: '/cli-roadmap' },
|
|
66
77
|
{ text: 'NPM Publishing Runbook', link: '/npm-publishing' },
|
|
67
|
-
{ text: 'Pre-flight Release Testing', link: '/testing-v0.2' }
|
|
78
|
+
{ text: 'Pre-flight Release Testing', link: '/testing-v0.2' },
|
|
79
|
+
{ text: 'Release Policy', link: '/release-policy' },
|
|
80
|
+
{ text: 'Support Policy', link: '/support-policy' },
|
|
81
|
+
{ text: 'Final Launch Guidelines', link: '/final-launch' },
|
|
82
|
+
{ text: 'v1.0.0 Release Checklist', link: '/v1-checklist' }
|
|
68
83
|
]
|
|
69
84
|
}
|
|
70
85
|
],
|
package/docs/cli-roadmap.md
CHANGED
|
@@ -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,42 @@
|
|
|
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
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Supported Tool Matrix
|
|
8
|
+
|
|
9
|
+
The CLI routes centralized specifications directly to the following target adapters:
|
|
10
|
+
|
|
11
|
+
| Tool / Agent | Target Adapter File | Setup Instructions | Behavior Setup |
|
|
12
|
+
| :--- | :--- | :--- | :--- |
|
|
13
|
+
| **Cursor** | `.cursorrules` | `adapters/cursor/setup.md` | Inline autocomplete guidelines |
|
|
14
|
+
| **Claude Code** | `CLAUDE.md` | `adapters/claude/setup.md` | Terminal build and run controls |
|
|
15
|
+
| **VS Code** | `.vscode/settings.json` | `adapters/vscode/setup.md` | Editor layout and search limits |
|
|
16
|
+
| **Gemini** | `GEMINI.md` | `adapters/gemini/setup.md` | Prompt system context logs |
|
|
17
|
+
| **Antigravity** | `.gemini/settings.json` | `adapters/antigravity/setup.md` | Security and audit parameters |
|
|
18
|
+
| **Codex** | `adapters/codex/AGENTS.md` | `adapters/codex/setup.md` | Automated code scaffolding |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 2. Safe Customizations
|
|
23
|
+
|
|
24
|
+
Developers can customize the following configurations inside the `.ai/` directory without breaking linter checkups:
|
|
25
|
+
- **Skills and Prompts:** Adding custom task files under `.ai/skills/` (e.g., custom database migrations, API setups).
|
|
26
|
+
- **Core Memory Notes:** Expanding milestones or architectural notes in `MEMORY.md` and `RUNBOOK.md`.
|
|
27
|
+
- **Model Routings:** Adjusting provider selections and endpoint targets inside `.ai/context/model-map.md`.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 3. Strict Rules (Do Not Rename)
|
|
32
|
+
|
|
33
|
+
To guarantee validation compliance:
|
|
34
|
+
- **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.
|
|
35
|
+
- **Do Not Modify Schema Subfolders:** Subdirectories under `.ai/` (context, skills, prompts, checks, session-logs) must maintain lower-case names.
|
|
36
|
+
- **Do Not Interfere with CLI Flags:** Compliance checks expect `init`, `validate`, and `doctor` to accept `--target` and `--adapter` variables consistently.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 4. v1.0.0 Compatibility Guarantee
|
|
41
|
+
|
|
42
|
+
The supported tool matrix and custom specifications listed here represent the officially frozen contracts of MultiModel Dev OS `v1.0.0`. Any backward-compatible extensions introduced in subsequent `1.x` releases will build on top of these mappings without breaking current project integrations.
|
package/docs/faq.md
CHANGED
|
@@ -81,3 +81,11 @@ on the same codebase.
|
|
|
81
81
|
**How do I view available scaffolding templates?**
|
|
82
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.
|
|
83
83
|
|
|
84
|
+
## Protocol & Migration
|
|
85
|
+
|
|
86
|
+
**Is the MultiModel Dev OS protocol stable?**
|
|
87
|
+
Yes. As of version `v1.0.0`, the core specifications (Root Contracts Layer, `.ai/` settings configurations, and adapter file targets) are officially frozen and backward-compatible. This ensures that any codebase prepared using `v1.0.0` will operate seamlessly inside future `1.x` ecosystems.
|
|
88
|
+
|
|
89
|
+
**How do I migrate my repository to v1.0.0?**
|
|
90
|
+
Upgrading is straightforward. Refer to our [Upgrades & Migration Guide](migration-guide.md) to inspect directory shifts, execute strict validation checks (`npx multimodel-dev-os validate`), and audit compatibility issues.
|
|
91
|
+
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Final Launch Guidelines
|
|
2
|
+
|
|
3
|
+
This document details the final launch guidelines and distribution routines for the public `v1.0.0` release of MultiModel Dev OS.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Local Pre-flight Verification
|
|
8
|
+
|
|
9
|
+
Prior to pushing files to the remote repository, ensure that:
|
|
10
|
+
- The exact target version `1.0.0` is configured in `package.json`.
|
|
11
|
+
- The cross-platform verify script completes cleanly:
|
|
12
|
+
```bash
|
|
13
|
+
npm run verify
|
|
14
|
+
```
|
|
15
|
+
- The VitePress documentation compiles without warnings or errors:
|
|
16
|
+
```bash
|
|
17
|
+
npm run docs:build
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 2. Launch Announcement Outlines
|
|
23
|
+
|
|
24
|
+
When publishing the stable release, communicate the key advantages clearly:
|
|
25
|
+
- **Portability**: Write-once configurations working seamlessly across Cursor, Claude, Gemini, Antigravity, and VS Code.
|
|
26
|
+
- **Context Economy**: Up to 79% reduction in prompt tokens through Caveman Mode configurations.
|
|
27
|
+
- **Zero Dependencies**: A completely self-contained CLI for lightning-fast setups.
|
|
28
|
+
|
|
29
|
+
Refer to `docs/launch-kit.md` for specific copy blocks ready for distribution on Twitter/X, LinkedIn, Hacker News, and Reddit.
|
package/docs/index.md
CHANGED
|
@@ -4,7 +4,7 @@ layout: home
|
|
|
4
4
|
hero:
|
|
5
5
|
name: "MultiModel Dev OS"
|
|
6
6
|
text: "Standardize your AI pair-programmers"
|
|
7
|
-
tagline: "
|
|
7
|
+
tagline: "One portable AI Dev OS for Codex, Antigravity, Cursor, Claude, Gemini, VS Code, and multimodel coding workflows."
|
|
8
8
|
image:
|
|
9
9
|
src: /logo.png
|
|
10
10
|
alt: MultiModel Dev OS Logo
|
|
@@ -13,14 +13,14 @@ hero:
|
|
|
13
13
|
text: Get Started Quick
|
|
14
14
|
link: /quickstart
|
|
15
15
|
- theme: alt
|
|
16
|
-
text:
|
|
17
|
-
link: /
|
|
16
|
+
text: Stable Protocol Specs
|
|
17
|
+
link: /stable-protocol
|
|
18
18
|
- theme: alt
|
|
19
|
-
text:
|
|
20
|
-
link: /
|
|
19
|
+
text: v1.0 Readiness
|
|
20
|
+
link: /v1-readiness
|
|
21
21
|
- theme: alt
|
|
22
|
-
text:
|
|
23
|
-
link: /
|
|
22
|
+
text: View Case Studies
|
|
23
|
+
link: /case-studies/
|
|
24
24
|
- theme: alt
|
|
25
25
|
text: View on GitHub
|
|
26
26
|
link: https://github.com/rizvee/multimodel-dev-os
|
|
@@ -42,8 +42,82 @@ features:
|
|
|
42
42
|
--vp-home-hero-name-color: transparent;
|
|
43
43
|
--vp-home-hero-name-background: linear-gradient(135deg, #6366f1 0%, #10b981 100%);
|
|
44
44
|
}
|
|
45
|
+
.grid-container {
|
|
46
|
+
display: grid;
|
|
47
|
+
grid-template-columns: repeat(auto-fit, minmax(240px, 1fr));
|
|
48
|
+
gap: 1.5rem;
|
|
49
|
+
margin-top: 2rem;
|
|
50
|
+
margin-bottom: 2rem;
|
|
51
|
+
}
|
|
52
|
+
.card-item {
|
|
53
|
+
border: 1px solid var(--vp-c-bg-mute);
|
|
54
|
+
background-color: var(--vp-c-bg-soft);
|
|
55
|
+
border-radius: 8px;
|
|
56
|
+
padding: 1.5rem;
|
|
57
|
+
transition: border-color 0.25s, transform 0.25s;
|
|
58
|
+
text-decoration: none !important;
|
|
59
|
+
color: inherit !important;
|
|
60
|
+
}
|
|
61
|
+
.card-item:hover {
|
|
62
|
+
border-color: var(--vp-c-brand-1);
|
|
63
|
+
transform: translateY(-4px);
|
|
64
|
+
}
|
|
65
|
+
.card-title {
|
|
66
|
+
font-weight: 600;
|
|
67
|
+
font-size: 1.15rem;
|
|
68
|
+
margin-bottom: 0.5rem;
|
|
69
|
+
}
|
|
70
|
+
.card-desc {
|
|
71
|
+
font-size: 0.9rem;
|
|
72
|
+
color: var(--vp-c-text-2);
|
|
73
|
+
}
|
|
45
74
|
</style>
|
|
46
75
|
|
|
76
|
+
## Quick Start Setup
|
|
77
|
+
|
|
78
|
+
Scaffold a tool-neutral workspace instantly:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
npx multimodel-dev-os@latest init
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Core Specifications & Playbooks
|
|
87
|
+
|
|
88
|
+
<div class="grid-container">
|
|
89
|
+
<a href="/quickstart" class="card-item">
|
|
90
|
+
<div class="card-title">🚀 Quickstart Guide</div>
|
|
91
|
+
<div class="card-desc">Deploy adapters and root contracts in under 2 minutes.</div>
|
|
92
|
+
</a>
|
|
93
|
+
<a href="/templates/" class="card-item">
|
|
94
|
+
<div class="card-title">📦 Template Gallery</div>
|
|
95
|
+
<div class="card-desc">5 premium, production-ready stack configurations for developers.</div>
|
|
96
|
+
</a>
|
|
97
|
+
<a href="/stable-protocol" class="card-item">
|
|
98
|
+
<div class="card-title">🛡️ Stable Protocol</div>
|
|
99
|
+
<div class="card-desc">Explore the officially frozen Layer 1-3 directory and file contracts.</div>
|
|
100
|
+
</a>
|
|
101
|
+
<a href="/cost-optimization" class="card-item">
|
|
102
|
+
<div class="card-title">⚡ Cost Optimization</div>
|
|
103
|
+
<div class="card-desc">Cuts your prompting token bills by up to 79% using Caveman shortcuts.</div>
|
|
104
|
+
</a>
|
|
105
|
+
<a href="/case-studies/" class="card-item">
|
|
106
|
+
<div class="card-title">💼 Case Studies Gallery</div>
|
|
107
|
+
<div class="card-desc">5 real-world integration guides mapping SaaS schemas and sequential handoffs.</div>
|
|
108
|
+
</a>
|
|
109
|
+
<a href="/migration-guide" class="card-item">
|
|
110
|
+
<div class="card-title">📈 Migration Playbook</div>
|
|
111
|
+
<div class="card-desc">Upgrade older workspaces to v1.0.0 standards cleanly.</div>
|
|
112
|
+
</a>
|
|
113
|
+
<a href="/v1-checklist" class="card-item">
|
|
114
|
+
<div class="card-title">🏁 Release Checklist</div>
|
|
115
|
+
<div class="card-desc">Audit repository compliance with the strict release quality gates.</div>
|
|
116
|
+
</a>
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
47
121
|
## Cost & Context Optimization
|
|
48
122
|
|
|
49
123
|
Minimize prompt overhead and API billing by mapping key context-reduction techniques to MultiModel Dev OS features:
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Migration Guide: Upgrading MultiModel Dev OS
|
|
2
|
+
|
|
3
|
+
This guide assists engineering teams in upgrading their MultiModel Dev OS configurations across releases, preparing repositories for v1.0.0 compliance.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Upgrading from v0.1 to v0.5
|
|
8
|
+
|
|
9
|
+
The `v0.5` release introduced the pure-Node local CLI and template scaffolding directories.
|
|
10
|
+
|
|
11
|
+
### Upgrade Steps:
|
|
12
|
+
1. **Directory Scaffolding:** Create the Lower-case subfolders under `.ai/` if they do not exist:
|
|
13
|
+
```bash
|
|
14
|
+
mkdir -p .ai/context .ai/skills .ai/session-logs
|
|
15
|
+
```
|
|
16
|
+
2. **Move Custom Rules:** Scrape old system prompt snippets from `.cursorrules` and modularize them into isolated files inside `.ai/context/` (e.g. `project-brief.md`, `architecture.md`).
|
|
17
|
+
3. **Configure Adapters Settings:** Create [.ai/config.yaml](file:///c:/Users/ADMIN/OneDrive/Desktop/multimodel-dev-os/.ai/config.yaml) and configure adapter mappings:
|
|
18
|
+
```yaml
|
|
19
|
+
version: "0.5.0"
|
|
20
|
+
adapters:
|
|
21
|
+
cursor: true
|
|
22
|
+
claude: true
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 2. Upgrading from v0.5 to v0.8
|
|
28
|
+
|
|
29
|
+
The `v0.8` release focused on cost/context optimizations, adding the 12 playbook techniques and visual timelines.
|
|
30
|
+
|
|
31
|
+
### Upgrade Steps:
|
|
32
|
+
1. **Enable Caveman Mode:** Set up Caveman minimal-token files inside `.ai/templates/` to allow rapid chat turns under tight budgets.
|
|
33
|
+
2. **Deploy Session Logs:** Confirm a `session-log-template.md` exists in `.ai/templates/` and create [.ai/session-logs/README.md](file:///c:/Users/ADMIN/OneDrive/Desktop/multimodel-dev-os/.ai/session-logs/README.md) to manage sequential handoffs.
|
|
34
|
+
3. **Audit Workspace compliance:** Run the linter to diagnostic environment issues:
|
|
35
|
+
```bash
|
|
36
|
+
npx multimodel-dev-os doctor
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 3. Upgrading from v0.9.0 to v1.0.0 Stable
|
|
42
|
+
|
|
43
|
+
The `v1.0.0` release completely freezes the public protocol and schemas.
|
|
44
|
+
|
|
45
|
+
### Upgrade Steps:
|
|
46
|
+
1. **Mount JSON Schemas:** Verify that config schemas under `.ai/schema/` are linked in your local configuration files.
|
|
47
|
+
2. **Execute Strict Validations:** Enforce strict assertions inside your pull requests or pre-commit hooks:
|
|
48
|
+
```bash
|
|
49
|
+
npx multimodel-dev-os validate
|
|
50
|
+
```
|
|
51
|
+
3. **Run Diagnostics Suite:** Execute the full verification and doctor suite to ensure absolute compliance:
|
|
52
|
+
```bash
|
|
53
|
+
npx multimodel-dev-os doctor
|
|
54
|
+
```
|
package/docs/protocol.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# MultiModel Dev OS Protocol Specification
|
|
2
|
+
|
|
3
|
+
This document defines the official, stable architectural protocol and design contracts for `multimodel-dev-os`, preparing the codebase for the v1.0.0 freeze.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Protocol Architecture Layers
|
|
8
|
+
|
|
9
|
+
The protocol is divided into three distinct decoupled layers to guarantee portability:
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
┌────────────────────────────────────────────────────────┐
|
|
13
|
+
│ LAYER 1: Root Contracts (Single Source of Truth) │
|
|
14
|
+
│ AGENTS.md • MEMORY.md • TASKS.md • RUNBOOK.md │
|
|
15
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
16
|
+
│ Centralizes project context
|
|
17
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
18
|
+
│ LAYER 2: Configuration & Modules (.ai/) │
|
|
19
|
+
│ context/ • agents/ • skills/ • prompts/ • checks/ │
|
|
20
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
21
|
+
│ routes files dynamically
|
|
22
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
23
|
+
│ LAYER 3: Tool & IDE Adapters │
|
|
24
|
+
│ .cursorrules • CLAUDE.md • .vscode/ • .gemini/ │
|
|
25
|
+
└────────────────────────────────────────────────────────┘
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 2. Stability Matrix (v1.0.0 Freeze)
|
|
31
|
+
|
|
32
|
+
To prevent breaking changes, protocol definitions are designated as **Stable** or **Experimental**:
|
|
33
|
+
|
|
34
|
+
### A. Stable Protocol Components
|
|
35
|
+
These features are fully frozen. No breaking changes or renaming will occur in v1.0:
|
|
36
|
+
- **Core Workspace Contracts:** The names and root directories of `AGENTS.md`, `MEMORY.md`, `TASKS.md`, and `RUNBOOK.md` are completely frozen.
|
|
37
|
+
- **Scaffolding Subfolders:** Target folders `.ai/context/`, `.ai/skills/`, and `.ai/session-logs/` are strictly required by the sync CLI.
|
|
38
|
+
- **Adapters Interface:** Mappings to Cursor (`.cursorrules`), Claude (`CLAUDE.md`), VS Code (`.vscode/settings.json`), and Gemini (`GEMINI.md`) are guaranteed.
|
|
39
|
+
- **Core Commands:** Subcommands `init`, `verify`, `validate`, `doctor`, and `templates` will retain their signatures.
|
|
40
|
+
|
|
41
|
+
### B. Experimental Components
|
|
42
|
+
These components represent early specs and may undergo minor tweaks in future minor releases:
|
|
43
|
+
- **Caveman Mode Custom Overrides:** Custom manual template modifications under `.ai/templates/`.
|
|
44
|
+
- **Dynamic Context Routing:** Pre-implementation check validations inside `.ai/checks/context-budget.md`.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 3. CLI Command Contracts
|
|
49
|
+
|
|
50
|
+
All compliant MultiModel Dev OS CLIs must strictly support the following execution contracts:
|
|
51
|
+
- **`init` Scaffolding:** Recursively writes root documents and links requested adapters.
|
|
52
|
+
- **`validate` Quality Gate:** Asserts that required folders and enabled adapter rules exist on disk.
|
|
53
|
+
- **`doctor` Diagnostic:** Advisory audit of `.gitignore` setups and folder compatibility.
|
|
54
|
+
- **`templates` Inspector:** Displays available stack configurations.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Release Policy
|
|
2
|
+
|
|
3
|
+
This document defines the versioning guidelines and standard practices for public releases of the MultiModel Dev OS protocol and CLI tool.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Semantic Versioning Commitments
|
|
8
|
+
|
|
9
|
+
MultiModel Dev OS strictly adheres to **Semantic Versioning 2.0.0 (SemVer)**:
|
|
10
|
+
- **Major Releases (X.y.z)**: Incremented when backward-incompatible changes are made to the Layer 1-3 protocol or CLI signatures.
|
|
11
|
+
- **Minor Releases (x.Y.z)**: Incremented when new features, optional templates, or backward-compatible adapters are added.
|
|
12
|
+
- **Patch Releases (x.y.Z)**: Incremented for backward-compatible bug fixes, docs corrections, or verification improvements.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 2. Breaking Changes Definition
|
|
17
|
+
|
|
18
|
+
A modification is defined as a **breaking change** if it:
|
|
19
|
+
1. Renames or deletes any of the frozen Layer 1 root contracts (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`).
|
|
20
|
+
2. Alters standard directory structures (`.ai/context/`, `.ai/skills/`).
|
|
21
|
+
3. Breaks existing CLI command signatures or required inputs.
|
|
22
|
+
|
|
23
|
+
Any such changes are prohibited outside of new major version releases (e.g., `2.0.0`).
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 3. Pre-Flight Verification Gates
|
|
28
|
+
|
|
29
|
+
No package shall be merged or released without:
|
|
30
|
+
- Passing all checks inside the `scripts/verify.js` release verification suite.
|
|
31
|
+
- Building the documentation site without dead links (`npm run docs:build`).
|
|
32
|
+
- Running packaging validation (`npm pack --dry-run`).
|
|
33
|
+
- Executing smoke tests on all templates.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Stable Protocol Specification (v1.0.0 Freeze)
|
|
2
|
+
|
|
3
|
+
This document formalizes the official, frozen architectural layers and design contracts for the MultiModel Dev OS protocol, guaranteeing portability and long-term stability.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Frozen Layers Architecture
|
|
8
|
+
|
|
9
|
+
MultiModel Dev OS enforces a three-tier design to decouple core workspace context from individual IDE adapters:
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
┌────────────────────────────────────────────────────────┐
|
|
13
|
+
│ LAYER 1: Root Contracts (Single Source of Truth) │
|
|
14
|
+
│ AGENTS.md • MEMORY.md • TASKS.md • RUNBOOK.md │
|
|
15
|
+
│ Status: FROZEN │
|
|
16
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
17
|
+
│ Centralizes project context
|
|
18
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
19
|
+
│ LAYER 2: Configuration & Modules (.ai/) │
|
|
20
|
+
│ context/ • agents/ • skills/ • prompts/ • checks/ │
|
|
21
|
+
│ Status: FROZEN │
|
|
22
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
23
|
+
│ Routes files dynamically
|
|
24
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
25
|
+
│ LAYER 3: Tool & IDE Adapters │
|
|
26
|
+
│ .cursorrules • CLAUDE.md • .vscode/ • .gemini/ │
|
|
27
|
+
│ Status: FROZEN │
|
|
28
|
+
└────────────────────────────────────────────────────────┘
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 2. Layer 1: Root Contracts
|
|
34
|
+
|
|
35
|
+
The following root files serve as the workspace single source of truth and are completely frozen:
|
|
36
|
+
- **`AGENTS.md`**: Defines team structures, boundaries, and model configurations.
|
|
37
|
+
- **`MEMORY.md`**: Preserves key context decisions, codebase state, and repository milestones.
|
|
38
|
+
- **`TASKS.md`**: Tracks current active goals and backlog.
|
|
39
|
+
- **`RUNBOOK.md`**: Operational scripts and workspace verify procedures.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 3. Layer 2: Scaffolding Layout
|
|
44
|
+
|
|
45
|
+
The following directories and files under `.ai/` are strictly locked:
|
|
46
|
+
- **`.ai/config.yaml`**: Standard configuration file mapping templates and active adapters.
|
|
47
|
+
- **`.ai/context/`**: Standard markdown files containing architecture guidelines, briefs, and SEO rules.
|
|
48
|
+
- **`.ai/skills/`**: High-frequency modular instructions for agent workflows.
|
|
49
|
+
- **`.ai/session-logs/`**: Standard directory for tracking agent workspace operations.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## 4. Layer 3: Adapters Setup
|
|
54
|
+
|
|
55
|
+
IDE adapters translate centralized rules to tool-specific paths:
|
|
56
|
+
- **Cursor**: Linked via root `.cursorrules`
|
|
57
|
+
- **Claude**: Linked via root `CLAUDE.md`
|
|
58
|
+
- **Gemini**: Linked via `.gemini/settings.json`
|
|
59
|
+
- **VS Code**: Linked via `.vscode/settings.json`
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 5. Experimental vs. Stable Scope
|
|
64
|
+
|
|
65
|
+
- **Stable**: Root files, scaffolding directories, CLI subcommand signatures, and standard config structures.
|
|
66
|
+
- **Experimental**: Custom check overrides under `.ai/checks/` and stack-specific context routing.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Support Policy
|
|
2
|
+
|
|
3
|
+
This document defines the lifecycle, support channels, and bug-triaging guidelines for the MultiModel Dev OS.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Support Lifecycle
|
|
8
|
+
|
|
9
|
+
We are committed to maintaining a stable experience for developers:
|
|
10
|
+
- **Long-Term Support (LTS)**: The frozen `v1.0.0` protocol and CLI will receive security updates and critical bug fixes for at least 12 months post-release.
|
|
11
|
+
- **Backward Compatibility Guarantee**: All `1.x` minor releases will remain fully backward compatible with configurations created under `v1.0.0`.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 2. Issue Triage and Bug Reports
|
|
16
|
+
|
|
17
|
+
If you encounter issues with the scaffolding or validation commands:
|
|
18
|
+
1. Run `multimodel-dev-os doctor` to run advisory diagnostics.
|
|
19
|
+
2. Ensure your local folder structure complies with the specifications defined in `docs/stable-protocol.md`.
|
|
20
|
+
3. Submit bug reports using our GitHub Issue templates under the `.github/ISSUE_TEMPLATE/` directory.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 3. Security Vulnerability Disclosures
|
|
25
|
+
|
|
26
|
+
Please do not open public issues for security bugs. Report vulnerabilities directly to the maintainers as described in the `SECURITY.md` file in the repository root.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Template Quality Assurance Blueprint
|
|
2
|
+
|
|
3
|
+
To guarantee that all built-in and community templates scaffold cleanly and operate with zero syntax errors, templates must satisfy the following strict QA criteria before packaging.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Core QA Acceptance Checklist
|
|
8
|
+
|
|
9
|
+
All template profiles (Next.js SaaS, WordPress Site, SEO Landing Page, E-Commerce, General App) must pass these automated assertions:
|
|
10
|
+
|
|
11
|
+
### A. Initialization Check
|
|
12
|
+
- [ ] Running `npx multimodel-dev-os init --template <name>` scaffolds all required folders and root files cleanly.
|
|
13
|
+
- [ ] No empty write errors, name drifts, or file conflicts occur when executed in an empty target path.
|
|
14
|
+
|
|
15
|
+
### B. Validation & Doctor Checks
|
|
16
|
+
- [ ] Scaffolding outputs must return 100% successful passes when audited using the local validation linter:
|
|
17
|
+
```bash
|
|
18
|
+
npx multimodel-dev-os validate
|
|
19
|
+
```
|
|
20
|
+
- [ ] Running the advisor must return zero warnings or compatibility alerts:
|
|
21
|
+
```bash
|
|
22
|
+
npx multimodel-dev-os doctor
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### C. Caveman Mode Compatibility
|
|
26
|
+
- [ ] The template must include functional minimal-token variants inside its `.ai/templates/` folder.
|
|
27
|
+
- [ ] Toggling `--caveman` writes successfully, creating compressed files without loss of structural boundaries.
|
|
28
|
+
|
|
29
|
+
### D. Adapter Installation Check
|
|
30
|
+
- [ ] The template must support native adapter mounts.
|
|
31
|
+
- [ ] Running `init --adapter cursor --adapter claude` copies the corresponding rule files and updates `.ai/config.yaml` to `true` instantly.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 2. New Template Acceptance Criteria
|
|
36
|
+
|
|
37
|
+
When contributing custom team templates:
|
|
38
|
+
1. **Generic but Realistic:** Templates must not include personal branding, fake metrics, or unverified benchmarks.
|
|
39
|
+
2. **Zero Dependencies:** Templates must configure purely within the defined root and `.ai/` schema layers, introducing zero package dependencies.
|
|
40
|
+
3. **Structured Context:** Project briefs and model maps must align with the official protocol specifications.
|
package/docs/templates-guide.md
CHANGED
|
@@ -63,3 +63,9 @@ node bin/multimodel-dev-os.js show-template nextjs-saas
|
|
|
63
63
|
# Bootstrap target using a template
|
|
64
64
|
node bin/multimodel-dev-os.js init --target ../my-new-app --template nextjs-saas
|
|
65
65
|
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## Template Quality Assurance
|
|
70
|
+
|
|
71
|
+
To ensure all contributed templates meet our rigorous quality standards before packaging, refer to our [Template Quality Assurance Blueprint](/template-qa).
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# v1.0.0 Release Checklist
|
|
2
|
+
|
|
3
|
+
A strict checklist of quality gates and tests that must be run locally before the final release.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Quality Checklist
|
|
8
|
+
|
|
9
|
+
- [ ] All Layer 1 files exist (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`).
|
|
10
|
+
- [ ] Schema files (`config.schema.json`, `template.schema.json`, `adapter.schema.json`) exist under `.ai/schema/`.
|
|
11
|
+
- [ ] No external third-party dependencies are added to the core runtime of the CLI utility.
|
|
12
|
+
- [ ] Verify script runs without issues (`npm run verify`).
|
|
13
|
+
- [ ] Documentation builds without errors (`npm run docs:build`).
|
|
14
|
+
- [ ] Package whitelist filters have been reviewed to ensure `node_modules` and compiled VitePress distribution/caches are excluded.
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 2. CLI Execution Audits
|
|
19
|
+
|
|
20
|
+
Verify that the binary executable behaves identically across target systems:
|
|
21
|
+
```bash
|
|
22
|
+
node bin/multimodel-dev-os.js --help
|
|
23
|
+
node bin/multimodel-dev-os.js templates
|
|
24
|
+
node bin/multimodel-dev-os.js validate --target .
|
|
25
|
+
node bin/multimodel-dev-os.js doctor --target .
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Verify dry-runs execute safely:
|
|
29
|
+
```bash
|
|
30
|
+
node bin/multimodel-dev-os.js init --template nextjs-saas --dry-run
|
|
31
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# v1.0.0 Readiness Checklist
|
|
2
|
+
|
|
3
|
+
A strict quality playbook defining the core milestones and checks that must be satisfied before freezing the public MultiModel Dev OS protocol at `v1.0.0`.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Core API & Protocol Freeze
|
|
8
|
+
- [x] **Protocol Specification Freeze:** officially release the specification (`protocol.md`), locking the four root contracts (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`).
|
|
9
|
+
- [x] **JSON Schema Validation:** Complete standard JSON schema files under `.ai/schema/` to enforce config and template layouts.
|
|
10
|
+
- [x] **Command API Freeze:** Lock the core subcommands (`init`, `verify`, `validate`, `doctor`, `templates`) with consistent signatures, preventing breaking options in future minor versions.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 2. Documentation & Visual Assets
|
|
15
|
+
- [x] **Navigation Menu Parity:** Assure that all nested guidelines, compatibility playbooks, and migration maps are integrated into the hosted VitePress documentation navigation.
|
|
16
|
+
- [x] **High-Fidelity SVGs:** Confirm lightweight, responsive vector assets exist in both root folders and docs public caches.
|
|
17
|
+
- [x] **Before/After Case Studies:** Complete 5 generic but realistic studies demonstrating context sync gains.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 3. CLI Hardening & Error Handling
|
|
22
|
+
- [x] **Descriptive Warning Pathways:** Ensure the CLI logs descriptive error prompts when scaffolding directories, catching template mismatch errors and conflicts cleanly.
|
|
23
|
+
- [x] **Zero Dependency Limits:** Protect the CLI's pure-Node setup, assuring that zero runtime external packages are added.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 4. Package Hygiene & Security
|
|
28
|
+
- [x] **Tarball audit:** Ensure `npm pack --dry-run` reports unpacked sizes under `~260kB` and compressed releases under `~76kB`.
|
|
29
|
+
- [x] **Ignored Cache verification:** Assert that local compiler caches (`docs/.vitepress/dist` and `docs/.vitepress/cache`) and `node_modules/` are strictly excluded from the packaging files whitelist.
|
package/package.json
CHANGED
package/scripts/verify.js
CHANGED
|
@@ -194,6 +194,28 @@ checkFile('docs/faq.md');
|
|
|
194
194
|
checkFile('docs/testing-v0.2.md');
|
|
195
195
|
checkFile('docs/npm-publishing.md');
|
|
196
196
|
checkFile('docs/templates-guide.md');
|
|
197
|
+
checkFile('docs/protocol.md');
|
|
198
|
+
checkFile('docs/compatibility.md');
|
|
199
|
+
checkFile('docs/migration-guide.md');
|
|
200
|
+
checkFile('docs/template-qa.md');
|
|
201
|
+
checkFile('docs/v1-readiness.md');
|
|
202
|
+
checkFile('docs/stable-protocol.md');
|
|
203
|
+
checkFile('docs/release-policy.md');
|
|
204
|
+
checkFile('docs/support-policy.md');
|
|
205
|
+
checkFile('docs/final-launch.md');
|
|
206
|
+
checkFile('docs/v1-checklist.md');
|
|
207
|
+
|
|
208
|
+
// --- JSON Schemas ---
|
|
209
|
+
console.log('\nJSON Schemas:');
|
|
210
|
+
checkFile('.ai/schema/config.schema.json');
|
|
211
|
+
checkFile('.ai/schema/template.schema.json');
|
|
212
|
+
checkFile('.ai/schema/adapter.schema.json');
|
|
213
|
+
|
|
214
|
+
// --- Test Blueprints ---
|
|
215
|
+
console.log('\nTest Manuals:');
|
|
216
|
+
checkFile('tests/README.md');
|
|
217
|
+
checkFile('tests/fixtures/README.md');
|
|
218
|
+
checkFile('tests/smoke/README.md');
|
|
197
219
|
|
|
198
220
|
// --- CLI & Packaging Pre-Flight Tests ---
|
|
199
221
|
console.log('\nRunning CLI & Packaging Pre-Flight Tests...');
|