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.
- 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 +134 -28
- package/assets/favicon.png +0 -0
- package/assets/logo.png +0 -0
- package/bin/multimodel-dev-os.js +1 -0
- package/docs/.vitepress/config.js +50 -1
- package/docs/case-studies/index.md +11 -7
- package/docs/cli-roadmap.md +8 -0
- package/docs/compatibility.md +46 -0
- package/docs/cost-optimization.md +6 -2
- package/docs/faq.md +36 -52
- package/docs/final-launch.md +34 -0
- package/docs/index.md +124 -7
- package/docs/migration-guide.md +54 -0
- package/docs/protocol.md +58 -0
- package/docs/public/favicon.png +0 -0
- package/docs/public/humans.txt +13 -0
- package/docs/public/llms-full.txt +73 -0
- package/docs/public/llms.txt +34 -0
- package/docs/public/logo.png +0 -0
- package/docs/public/robots.txt +4 -0
- package/docs/public/sitemap.xml +68 -0
- package/docs/quickstart.md +10 -6
- package/docs/release-policy.md +33 -0
- package/docs/stable-protocol.md +70 -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 +36 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Final Launch Guidelines (v1.1.0)
|
|
2
|
+
|
|
3
|
+
This document details the final launch guidelines and distribution routines for the public releases of MultiModel Dev OS.
|
|
4
|
+
|
|
5
|
+
> **Use when**: Executing pre-flight local audits, managing release announcements, or verifying package integrity.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Local Pre-flight Verification
|
|
10
|
+
|
|
11
|
+
Prior to pushing files to the remote repository, ensure that:
|
|
12
|
+
- The exact target version `1.1.0` is configured in `package.json`.
|
|
13
|
+
- The cross-platform verify script completes cleanly:
|
|
14
|
+
```bash
|
|
15
|
+
npm run verify
|
|
16
|
+
```
|
|
17
|
+
- The VitePress documentation compiles without warnings or errors:
|
|
18
|
+
```bash
|
|
19
|
+
npm run docs:build
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 2. Launch Announcement Outlines
|
|
25
|
+
|
|
26
|
+
When publishing the stable release, communicate the key advantages clearly:
|
|
27
|
+
- **Portability**: Write-once configurations working seamlessly across Cursor, Claude, Gemini, Antigravity, and VS Code.
|
|
28
|
+
- **Context Economy**: Up to 79% reduction in prompt tokens through Caveman Mode configurations.
|
|
29
|
+
- **Zero Dependencies**: A completely self-contained CLI for lightning-fast setups.
|
|
30
|
+
- **AI Discoverability**: Ready-to-ingest discoverability guides (`llms.txt` / `llms-full.txt`) for LLM agents.
|
|
31
|
+
|
|
32
|
+
Refer to `docs/launch-kit.md` for specific copy blocks ready for distribution on Twitter/X, LinkedIn, Hacker News, and Reddit.
|
|
33
|
+
|
|
34
|
+
Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
|
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,125 @@ 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
|
+
}
|
|
74
|
+
.works-with-grid {
|
|
75
|
+
display: grid;
|
|
76
|
+
grid-template-columns: repeat(auto-fit, minmax(140px, 1fr));
|
|
77
|
+
gap: 1rem;
|
|
78
|
+
margin-top: 1.5rem;
|
|
79
|
+
margin-bottom: 2.5rem;
|
|
80
|
+
}
|
|
81
|
+
.works-with-item {
|
|
82
|
+
border: 1px solid var(--vp-c-bg-mute);
|
|
83
|
+
background-color: var(--vp-c-bg-soft);
|
|
84
|
+
border-radius: 6px;
|
|
85
|
+
padding: 1rem;
|
|
86
|
+
text-align: center;
|
|
87
|
+
font-weight: 500;
|
|
88
|
+
font-size: 0.95rem;
|
|
89
|
+
}
|
|
45
90
|
</style>
|
|
46
91
|
|
|
92
|
+
## Quick Start Setup
|
|
93
|
+
|
|
94
|
+
Scaffold a tool-neutral workspace instantly:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
npx multimodel-dev-os@latest init
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Works With
|
|
103
|
+
|
|
104
|
+
MultiModel Dev OS maps repository context directly to all major developer tools and coding agents:
|
|
105
|
+
|
|
106
|
+
<div class="works-with-grid">
|
|
107
|
+
<div class="works-with-item">🤖 Codex</div>
|
|
108
|
+
<div class="works-with-item">🪐 Antigravity</div>
|
|
109
|
+
<div class="works-with-item">🎯 Cursor</div>
|
|
110
|
+
<div class="works-with-item">⚡ Claude Code</div>
|
|
111
|
+
<div class="works-with-item">🧠 Gemini</div>
|
|
112
|
+
<div class="works-with-item">💻 VS Code</div>
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Core Specifications & Playbooks
|
|
118
|
+
|
|
119
|
+
<div class="grid-container">
|
|
120
|
+
<a href="/quickstart" class="card-item">
|
|
121
|
+
<div class="card-title">🚀 Quickstart Guide</div>
|
|
122
|
+
<div class="card-desc">Deploy adapters and root contracts in under 2 minutes.</div>
|
|
123
|
+
</a>
|
|
124
|
+
<a href="/templates/" class="card-item">
|
|
125
|
+
<div class="card-title">📦 Template Gallery</div>
|
|
126
|
+
<div class="card-desc">5 premium, production-ready stack configurations for developers.</div>
|
|
127
|
+
</a>
|
|
128
|
+
<a href="/stable-protocol" class="card-item">
|
|
129
|
+
<div class="card-title">🛡️ Stable Protocol</div>
|
|
130
|
+
<div class="card-desc">Explore the officially frozen Layer 1-3 directory and file contracts.</div>
|
|
131
|
+
</a>
|
|
132
|
+
<a href="/cost-optimization" class="card-item">
|
|
133
|
+
<div class="card-title">⚡ Cost Optimization</div>
|
|
134
|
+
<div class="card-desc">Cuts your prompting token bills by up to 79% using Caveman shortcuts.</div>
|
|
135
|
+
</a>
|
|
136
|
+
<a href="/case-studies/" class="card-item">
|
|
137
|
+
<div class="card-title">💼 Case Studies Gallery</div>
|
|
138
|
+
<div class="card-desc">5 real-world integration guides mapping SaaS schemas and sequential handoffs.</div>
|
|
139
|
+
</a>
|
|
140
|
+
<a href="/migration-guide" class="card-item">
|
|
141
|
+
<div class="card-title">📈 Migration Playbook</div>
|
|
142
|
+
<div class="card-desc">Upgrade older workspaces to v1.1.0 standards cleanly.</div>
|
|
143
|
+
</a>
|
|
144
|
+
<a href="/v1-checklist" class="card-item">
|
|
145
|
+
<div class="card-title">🏁 Release Checklist</div>
|
|
146
|
+
<div class="card-desc">Audit repository compliance with the strict release quality gates.</div>
|
|
147
|
+
</a>
|
|
148
|
+
<a href="/llms.txt" class="card-item" target="_blank">
|
|
149
|
+
<div class="card-title">🤖 AI Discovery (llms.txt)</div>
|
|
150
|
+
<div class="card-desc">A highly concise, structured overview formatted specifically for AI context ingestion.</div>
|
|
151
|
+
</a>
|
|
152
|
+
</div>
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## For AI Assistants and Coding Agents
|
|
157
|
+
|
|
158
|
+
To support modern AI search, GEO discovery, and developer agents:
|
|
159
|
+
- We provide [llms.txt](/llms.txt) and [llms-full.txt](/llms-full.txt) at the root of the hosted documentation to allow Large Language Models and AEO utilities to read full workspace specs in single, token-optimized files.
|
|
160
|
+
- The officially frozen protocol guarantees that agents can read and write workspace rules without manual supervision or instruction drift.
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
47
164
|
## Cost & Context Optimization
|
|
48
165
|
|
|
49
166
|
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,58 @@
|
|
|
1
|
+
# MultiModel Dev OS Protocol Specification (v1.1.0)
|
|
2
|
+
|
|
3
|
+
This document defines the official, stable architectural protocol and design contracts for MultiModel Dev OS, establishing portable AI project context conventions.
|
|
4
|
+
|
|
5
|
+
> **Use when**: Implementing a custom CLI client, creating private adapters, or auditing Layer 1-3 protocol compliance.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Protocol Architecture Layers
|
|
10
|
+
|
|
11
|
+
The protocol is divided into three distinct decoupled layers to guarantee portability:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
┌────────────────────────────────────────────────────────┐
|
|
15
|
+
│ LAYER 1: Root Contracts (Single Source of Truth) │
|
|
16
|
+
│ AGENTS.md • MEMORY.md • TASKS.md • RUNBOOK.md │
|
|
17
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
18
|
+
│ Centralizes project context
|
|
19
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
20
|
+
│ LAYER 2: Configuration & Modules (.ai/) │
|
|
21
|
+
│ context/ • agents/ • skills/ • prompts/ • checks/ │
|
|
22
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
23
|
+
│ routes files dynamically
|
|
24
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
25
|
+
│ LAYER 3: Tool & IDE Adapters │
|
|
26
|
+
│ .cursorrules • CLAUDE.md • .vscode/ • .gemini/ │
|
|
27
|
+
└────────────────────────────────────────────────────────┘
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 2. Stability Matrix (v1.1.0 Freeze)
|
|
33
|
+
|
|
34
|
+
To prevent breaking changes, protocol definitions are designated as **Stable** or **Experimental**:
|
|
35
|
+
|
|
36
|
+
### A. Stable Protocol Components
|
|
37
|
+
These features are fully frozen. No breaking changes or renaming will occur in `v1.x`:
|
|
38
|
+
- **Core Workspace Contracts:** The names and root directories of `AGENTS.md`, `MEMORY.md`, `TASKS.md`, and `RUNBOOK.md` are completely frozen.
|
|
39
|
+
- **Scaffolding Subfolders:** Target folders `.ai/context/`, `.ai/skills/`, and `.ai/session-logs/` are strictly required by the sync CLI.
|
|
40
|
+
- **Adapters Interface:** Mappings to Cursor (`.cursorrules`), Claude (`CLAUDE.md`), VS Code (`.vscode/settings.json`), and Gemini (`GEMINI.md`) are guaranteed.
|
|
41
|
+
- **Core Commands:** Subcommands `init`, `verify`, `validate`, `doctor`, and `templates` will retain their signatures.
|
|
42
|
+
|
|
43
|
+
### B. Experimental Components
|
|
44
|
+
These components represent early specs and may undergo minor tweaks in future minor releases:
|
|
45
|
+
- **Caveman Mode Custom Overrides:** Custom manual template modifications under `.ai/templates/`.
|
|
46
|
+
- **Dynamic Context Routing:** Pre-implementation check validations inside `.ai/checks/context-budget.md`.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 3. CLI Command Contracts
|
|
51
|
+
|
|
52
|
+
All compliant MultiModel Dev OS CLIs must strictly support the following execution contracts:
|
|
53
|
+
- **`init` Scaffolding:** Recursively writes root documents and links requested adapters.
|
|
54
|
+
- **`validate` Quality Gate:** Asserts that required folders and enabled adapter rules exist on disk.
|
|
55
|
+
- **`doctor` Diagnostic:** Advisory audit of `.gitignore` setups and folder compatibility.
|
|
56
|
+
- **`templates` Inspector:** Displays available stack configurations.
|
|
57
|
+
|
|
58
|
+
Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
|
|
Binary file
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/* TEAM */
|
|
2
|
+
Maintainer: rizvee
|
|
3
|
+
GitHub: https://github.com/rizvee
|
|
4
|
+
|
|
5
|
+
/* THANKS */
|
|
6
|
+
Special thanks to: All Open Source contributors, AI agents, and early adoptions teams!
|
|
7
|
+
|
|
8
|
+
/* SITE */
|
|
9
|
+
Canonical: https://rizvee.github.io/multimodel-dev-os/
|
|
10
|
+
Codebase: https://github.com/rizvee/multimodel-dev-os
|
|
11
|
+
License: MIT License
|
|
12
|
+
Language: JavaScript
|
|
13
|
+
Framework: VitePress
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# MultiModel Dev OS — Comprehensive AI Assistant Discoverability Guide
|
|
2
|
+
|
|
3
|
+
MultiModel Dev OS is a repository-level porting specification designed to align context and instructions across diverse developer tools and AI models.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Core Architecture Layers
|
|
8
|
+
|
|
9
|
+
The protocol decouples the centralized workspace context from the individual tool rules:
|
|
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
|
+
### Layer 1: Root Documents
|
|
29
|
+
- **`AGENTS.md`**: Defines teams, capabilities, boundaries, and model instructions.
|
|
30
|
+
- **`MEMORY.md`**: Holds architectural decisions, repository milestones, and tech stacks.
|
|
31
|
+
- **`TASKS.md`**: Active backlog tracking items.
|
|
32
|
+
- **`RUNBOOK.md`**: Operational verification commands and post-deployment routines.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 2. CLI Command specifications
|
|
37
|
+
|
|
38
|
+
All compliant MultiModel Dev OS CLIs strictly enforce the following command contracts:
|
|
39
|
+
- **`init`**: Scaffolds the standard `.ai/` context configuration directories.
|
|
40
|
+
- **`verify`**: Automated release script that checks structure integrity.
|
|
41
|
+
- **`templates`**: Lists built-in stack specifications (`nextjs-saas`, `wordpress-site`, `ecommerce-store`, `seo-landing-page`, `general-app`).
|
|
42
|
+
- **`validate`**: Strict Quality Gate checking the layout rules on disk.
|
|
43
|
+
- **`doctor`**: Advisory checkup warning you about unignored compiler caches or large folder directories.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 3. Adapters & Mappings
|
|
48
|
+
|
|
49
|
+
Adapters read context directly from `AGENTS.md` and translate them into native configs:
|
|
50
|
+
- **Cursor** targets root `.cursorrules`
|
|
51
|
+
- **Claude Code** targets root `CLAUDE.md`
|
|
52
|
+
- **VS Code** targets `.vscode/settings.json`
|
|
53
|
+
- **Gemini** targets root `GEMINI.md`
|
|
54
|
+
- **Antigravity** targets `.gemini/settings.json`
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## 4. Key Context Optimization (Caveman Mode)
|
|
59
|
+
|
|
60
|
+
Toggling **Caveman Mode** dynamically reduces system prompt instructions to highly-optimized shorthand symbols, reducing rule tokens footprint by **~79%** for low-cost token execution budgets:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx multimodel-dev-os@latest init --caveman
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 5. Canonical Links
|
|
69
|
+
- **Documentation site**: https://rizvee.github.io/multimodel-dev-os/
|
|
70
|
+
- **GitHub Codebase**: https://github.com/rizvee/multimodel-dev-os
|
|
71
|
+
- **Release Policies**: https://rizvee.github.io/multimodel-dev-os/release-policy
|
|
72
|
+
- **LTS Support Policies**: https://rizvee.github.io/multimodel-dev-os/support-policy
|
|
73
|
+
- **Upgrade Playbook**: https://rizvee.github.io/multimodel-dev-os/migration-guide
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# MultiModel Dev OS (v1.1.0)
|
|
2
|
+
|
|
3
|
+
Portable, vendor-neutral workspace configuration standard for multi-agent AI pair-programming workflows.
|
|
4
|
+
|
|
5
|
+
## What It Does
|
|
6
|
+
Provides a unified repository-level specification using root markdown files (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`) and bridges them dynamically to multiple developer tools, ensuring zero instruction drift and up to 79% token context savings.
|
|
7
|
+
|
|
8
|
+
## Fast Setup
|
|
9
|
+
```bash
|
|
10
|
+
npx multimodel-dev-os@latest init
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Supported Tools
|
|
14
|
+
- **Cursor** (`.cursorrules`)
|
|
15
|
+
- **Claude Code** (`CLAUDE.md`)
|
|
16
|
+
- **VS Code** (`.vscode/settings.json`)
|
|
17
|
+
- **Gemini** (`GEMINI.md`)
|
|
18
|
+
- **Antigravity** (`.gemini/settings.json`)
|
|
19
|
+
- **Codex** (`adapters/codex/AGENTS.md`)
|
|
20
|
+
|
|
21
|
+
## Core Resources
|
|
22
|
+
- **Canonical Website**: https://rizvee.github.io/multimodel-dev-os/
|
|
23
|
+
- **GitHub Repository**: https://github.com/rizvee/multimodel-dev-os
|
|
24
|
+
- **NPM Registry Package**: https://www.npmjs.com/package/multimodel-dev-os
|
|
25
|
+
- **Stable Protocol Specification**: https://rizvee.github.io/multimodel-dev-os/stable-protocol
|
|
26
|
+
- **Cost/Context Optimization Playbook**: https://rizvee.github.io/multimodel-dev-os/cost-optimization
|
|
27
|
+
- **5-Day Adoption Roadmap**: https://rizvee.github.io/multimodel-dev-os/5-day-roadmap
|
|
28
|
+
|
|
29
|
+
## Standard Templates
|
|
30
|
+
- `nextjs-saas` (App Router, Prisma ORM, Stripe)
|
|
31
|
+
- `wordpress-site` (Custom Block Themes, secure PHP guidelines)
|
|
32
|
+
- `ecommerce-store` (PCI checkout, Webhooks, card state)
|
|
33
|
+
- `seo-landing-page` (Astro static builds, JSON-LD, optimal LCP)
|
|
34
|
+
- `general-app` (Universal baseline configurations)
|
|
Binary file
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
3
|
+
<url>
|
|
4
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/</loc>
|
|
5
|
+
<changefreq>daily</changefreq>
|
|
6
|
+
<priority>1.0</priority>
|
|
7
|
+
</url>
|
|
8
|
+
<url>
|
|
9
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/quickstart</loc>
|
|
10
|
+
<changefreq>weekly</changefreq>
|
|
11
|
+
<priority>0.8</priority>
|
|
12
|
+
</url>
|
|
13
|
+
<url>
|
|
14
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/templates/</loc>
|
|
15
|
+
<changefreq>weekly</changefreq>
|
|
16
|
+
<priority>0.8</priority>
|
|
17
|
+
</url>
|
|
18
|
+
<url>
|
|
19
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/protocol</loc>
|
|
20
|
+
<changefreq>weekly</changefreq>
|
|
21
|
+
<priority>0.7</priority>
|
|
22
|
+
</url>
|
|
23
|
+
<url>
|
|
24
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/stable-protocol</loc>
|
|
25
|
+
<changefreq>weekly</changefreq>
|
|
26
|
+
<priority>0.9</priority>
|
|
27
|
+
</url>
|
|
28
|
+
<url>
|
|
29
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/compatibility</loc>
|
|
30
|
+
<changefreq>weekly</changefreq>
|
|
31
|
+
<priority>0.7</priority>
|
|
32
|
+
</url>
|
|
33
|
+
<url>
|
|
34
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/migration-guide</loc>
|
|
35
|
+
<changefreq>weekly</changefreq>
|
|
36
|
+
<priority>0.7</priority>
|
|
37
|
+
</url>
|
|
38
|
+
<url>
|
|
39
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/cost-optimization</loc>
|
|
40
|
+
<changefreq>weekly</changefreq>
|
|
41
|
+
<priority>0.8</priority>
|
|
42
|
+
</url>
|
|
43
|
+
<url>
|
|
44
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/5-day-roadmap</loc>
|
|
45
|
+
<changefreq>monthly</changefreq>
|
|
46
|
+
<priority>0.6</priority>
|
|
47
|
+
</url>
|
|
48
|
+
<url>
|
|
49
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/case-studies/</loc>
|
|
50
|
+
<changefreq>weekly</changefreq>
|
|
51
|
+
<priority>0.8</priority>
|
|
52
|
+
</url>
|
|
53
|
+
<url>
|
|
54
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/demo</loc>
|
|
55
|
+
<changefreq>weekly</changefreq>
|
|
56
|
+
<priority>0.7</priority>
|
|
57
|
+
</url>
|
|
58
|
+
<url>
|
|
59
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/faq</loc>
|
|
60
|
+
<changefreq>weekly</changefreq>
|
|
61
|
+
<priority>0.6</priority>
|
|
62
|
+
</url>
|
|
63
|
+
<url>
|
|
64
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/v1-checklist</loc>
|
|
65
|
+
<changefreq>weekly</changefreq>
|
|
66
|
+
<priority>0.6</priority>
|
|
67
|
+
</url>
|
|
68
|
+
</urlset>
|
package/docs/quickstart.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
# Quickstart
|
|
1
|
+
# Quickstart Guide: AI Dev OS Deployment
|
|
2
2
|
|
|
3
|
-
Get
|
|
3
|
+
Get the MultiModel Dev OS integrated into your codebase in under 2 minutes to synchronize your multi-agent developer workflows.
|
|
4
|
+
|
|
5
|
+
> **Use when**: Setting up a new repository or aligning multiple AI tools (like Cursor, Claude Code, Gemini, Codex, and Antigravity) to prevent instruction drift and prompt token bloat.
|
|
4
6
|
|
|
5
7
|
---
|
|
6
8
|
|
|
@@ -39,7 +41,7 @@ irm https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/inst
|
|
|
39
41
|
|
|
40
42
|
## Option C: Caveman Mode (Minimal Tokens)
|
|
41
43
|
|
|
42
|
-
|
|
44
|
+
**Best for**: Context optimization for AI coding when using tight API budgets or smaller models. Reduces rules footprint by **~79%**.
|
|
43
45
|
|
|
44
46
|
```bash
|
|
45
47
|
curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/install.sh | bash -s -- --caveman
|
|
@@ -63,13 +65,13 @@ For offline execution or customized packaging within a cloned workspace:
|
|
|
63
65
|
|
|
64
66
|
## After Install
|
|
65
67
|
|
|
66
|
-
1. **Edit `AGENTS.md`** — fill in your project name, stack, and build commands.
|
|
68
|
+
1. **Edit `AGENTS.md`** — fill in your project name, stack, and build commands (portable AI project context).
|
|
67
69
|
2. **Edit `.ai/config.yaml`** — enable adapters for your tools.
|
|
68
|
-
3. **Copy adapter files** to your project root:
|
|
70
|
+
3. **Copy adapter files** to your project root (e.g., Cursor project rules, Claude Code project instructions):
|
|
69
71
|
- Cursor: `cp adapters/cursor/.cursorrules .cursorrules`
|
|
70
72
|
- Claude: `cp adapters/claude/CLAUDE.md CLAUDE.md`
|
|
71
73
|
- VS Code: `cp -r adapters/vscode/.vscode/ .vscode/`
|
|
72
|
-
4. **Start coding** — your AI
|
|
74
|
+
4. **Start coding** — your AI coding agents will read the shared configuration instantly.
|
|
73
75
|
|
|
74
76
|
---
|
|
75
77
|
|
|
@@ -87,3 +89,5 @@ node bin/multimodel-dev-os.js doctor
|
|
|
87
89
|
# Verify repository structure checks
|
|
88
90
|
npm run verify
|
|
89
91
|
```
|
|
92
|
+
|
|
93
|
+
Explore our canonical [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
|
|
@@ -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,70 @@
|
|
|
1
|
+
# Stable Protocol Specification (v1.1.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 across diverse AI coding agents.
|
|
4
|
+
|
|
5
|
+
> **Best for**: Third-party client integrations, tool adapter developers, and engineering teams establishing robust AI coding guidelines.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Frozen Layers Architecture
|
|
10
|
+
|
|
11
|
+
MultiModel Dev OS enforces a three-tier design to decouple core workspace context from individual IDE adapters:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
┌────────────────────────────────────────────────────────┐
|
|
15
|
+
│ LAYER 1: Root Contracts (Single Source of Truth) │
|
|
16
|
+
│ AGENTS.md • MEMORY.md • TASKS.md • RUNBOOK.md │
|
|
17
|
+
│ Status: FROZEN │
|
|
18
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
19
|
+
│ Centralizes project context
|
|
20
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
21
|
+
│ LAYER 2: Configuration & Modules (.ai/) │
|
|
22
|
+
│ context/ • agents/ • skills/ • prompts/ • checks/ │
|
|
23
|
+
│ Status: FROZEN │
|
|
24
|
+
└──────────────────────────┬─────────────────────────────┘
|
|
25
|
+
│ Routes files dynamically
|
|
26
|
+
┌──────────────────────────▼─────────────────────────────┐
|
|
27
|
+
│ LAYER 3: Tool & IDE Adapters │
|
|
28
|
+
│ .cursorrules • CLAUDE.md • .vscode/ • .gemini/ │
|
|
29
|
+
│ Status: FROZEN │
|
|
30
|
+
└────────────────────────────────────────────────────────┘
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 2. Layer 1: Root Contracts
|
|
36
|
+
|
|
37
|
+
The following root files serve as the workspace single source of truth and are completely frozen:
|
|
38
|
+
- **`AGENTS.md`**: Defines team structures, boundaries, and model configurations (Codex project memory / Antigravity AI workflow).
|
|
39
|
+
- **`MEMORY.md`**: Preserves key context decisions, codebase state, and repository milestones.
|
|
40
|
+
- **`TASKS.md`**: Tracks current active goals and backlog.
|
|
41
|
+
- **`RUNBOOK.md`**: Operational scripts and workspace verify procedures.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## 3. Layer 2: Scaffolding Layout
|
|
46
|
+
|
|
47
|
+
The following directories and files under `.ai/` are strictly locked:
|
|
48
|
+
- **`.ai/config.yaml`**: Standard configuration file mapping templates and active adapters.
|
|
49
|
+
- **`.ai/context/`**: Standard markdown files containing architecture guidelines, briefs, and SEO rules.
|
|
50
|
+
- **`.ai/skills/`**: High-frequency modular instructions for agent workflows.
|
|
51
|
+
- **`.ai/session-logs/`**: Standard directory for tracking agent workspace operations.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 4. Layer 3: Adapters Setup
|
|
56
|
+
|
|
57
|
+
IDE adapters translate centralized rules to tool-specific paths (Cursor project rules / Claude Code project instructions):
|
|
58
|
+
- **Cursor**: Linked via root `.cursorrules`
|
|
59
|
+
- **Claude**: Linked via root `CLAUDE.md`
|
|
60
|
+
- **Gemini**: Linked via `.gemini/settings.json`
|
|
61
|
+
- **VS Code**: Linked via `.vscode/settings.json`
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## 5. Experimental vs. Stable Scope
|
|
66
|
+
|
|
67
|
+
- **Stable**: Root files, scaffolding directories, CLI subcommand signatures, and standard config structures.
|
|
68
|
+
- **Experimental**: Custom check overrides under `.ai/checks/` and stack-specific context routing.
|
|
69
|
+
|
|
70
|
+
Explore our [Upgrades & Migration Guide](/migration-guide) or [Release Quality Checklist](/v1-checklist) for staging controls.
|