multimodel-dev-os 1.0.0 → 2.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.
Files changed (73) hide show
  1. package/.ai/adapters/custom-adapter.example.yaml +9 -0
  2. package/.ai/adapters/registry.yaml +56 -0
  3. package/.ai/models/README.md +14 -0
  4. package/.ai/models/local-models.yaml +20 -0
  5. package/.ai/models/providers.yaml +29 -0
  6. package/.ai/models/registry.yaml +73 -0
  7. package/.ai/models/routing-presets.yaml +23 -0
  8. package/.ai/skills/custom-skill.example.md +15 -0
  9. package/.ai/templates/custom-template.example.yaml +19 -0
  10. package/.ai/templates/registry.yaml +522 -0
  11. package/README.md +48 -22
  12. package/assets/favicon.png +0 -0
  13. package/assets/logo.png +0 -0
  14. package/bin/multimodel-dev-os.js +810 -91
  15. package/docs/.vitepress/config.js +69 -0
  16. package/docs/adapter-authoring.md +46 -0
  17. package/docs/agent-compatibility.md +51 -0
  18. package/docs/case-studies/index.md +11 -7
  19. package/docs/cli-roadmap.md +15 -18
  20. package/docs/compatibility.md +7 -3
  21. package/docs/cost-optimization.md +6 -2
  22. package/docs/faq.md +32 -56
  23. package/docs/final-launch.md +10 -4
  24. package/docs/index.md +44 -1
  25. package/docs/local-models.md +48 -0
  26. package/docs/mobile-android.md +75 -0
  27. package/docs/model-compatibility.md +65 -0
  28. package/docs/model-routing.md +45 -0
  29. package/docs/npm-publishing.md +27 -0
  30. package/docs/package-safety.md +29 -0
  31. package/docs/protocol.md +8 -4
  32. package/docs/provider-strategy.md +44 -0
  33. package/docs/public/favicon.png +0 -0
  34. package/docs/public/humans.txt +13 -0
  35. package/docs/public/llms-full.txt +82 -0
  36. package/docs/public/llms.txt +36 -0
  37. package/docs/public/logo.png +0 -0
  38. package/docs/public/robots.txt +4 -0
  39. package/docs/public/sitemap.xml +68 -0
  40. package/docs/quickstart.md +17 -12
  41. package/docs/registry-contribution.md +20 -0
  42. package/docs/release-policy.md +26 -0
  43. package/docs/skill-authoring.md +56 -0
  44. package/docs/stable-protocol.md +8 -4
  45. package/docs/template-authoring.md +65 -0
  46. package/docs/token-optimization.md +27 -0
  47. package/docs/v2-migration.md +31 -0
  48. package/docs/v2-release-checklist.md +30 -0
  49. package/docs/v2-roadmap.md +95 -0
  50. package/examples/expo-react-native-android/.ai/config.yaml +22 -0
  51. package/examples/expo-react-native-android/.ai/context/architecture.md +18 -0
  52. package/examples/expo-react-native-android/.ai/context/context-budget.md +4 -0
  53. package/examples/expo-react-native-android/.ai/context/model-map.md +6 -0
  54. package/examples/expo-react-native-android/.ai/context/project-brief.md +9 -0
  55. package/examples/expo-react-native-android/.ai/session-logs/.gitkeep +1 -0
  56. package/examples/expo-react-native-android/.ai/skills/expo-android-build.md +11 -0
  57. package/examples/expo-react-native-android/AGENTS.md +20 -0
  58. package/examples/expo-react-native-android/MEMORY.md +13 -0
  59. package/examples/expo-react-native-android/README.md +101 -0
  60. package/examples/expo-react-native-android/RUNBOOK.md +36 -0
  61. package/examples/expo-react-native-android/TASKS.md +14 -0
  62. package/examples/expo-react-native-android/app.config.ts +40 -0
  63. package/examples/expo-react-native-android/app.json +34 -0
  64. package/examples/expo-react-native-android/eas.json +26 -0
  65. package/examples/expo-react-native-android/jest.config.js +11 -0
  66. package/examples/expo-react-native-android/src/app/_layout.tsx +89 -0
  67. package/examples/expo-react-native-android/src/lib/secure-storage.ts +63 -0
  68. package/examples/expo-react-native-android/src/services/api-client.ts +106 -0
  69. package/package.json +3 -2
  70. package/scripts/install.ps1 +230 -230
  71. package/scripts/install.sh +1 -1
  72. package/scripts/prepublish-guard.js +43 -0
  73. package/scripts/verify.js +192 -1
@@ -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': '2.0.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: [
@@ -28,10 +62,44 @@ export default {
28
62
  { text: 'Stable Protocol Specification', link: '/stable-protocol' },
29
63
  { text: 'Adapter Compatibility', link: '/compatibility' },
30
64
  { text: 'Upgrades & Migration', link: '/migration-guide' },
65
+ { text: 'v2 Migration Guide', link: '/v2-migration' },
66
+ { text: 'v2 Release Checklist', link: '/v2-release-checklist' },
67
+ { text: 'Package Safety', link: '/package-safety' },
31
68
  { text: 'Templates QA Blueprint', link: '/template-qa' },
32
69
  { text: 'v1.0.0 Readiness Checklist', link: '/v1-readiness' }
33
70
  ]
34
71
  },
72
+ {
73
+ text: 'Model Compatibility Layer',
74
+ items: [
75
+ { text: 'Model Capabilities Registry', link: '/model-compatibility' },
76
+ { text: 'Model Routing & Presets', link: '/model-routing' },
77
+ { text: 'Local & Offline Models', link: '/local-models' },
78
+ { text: 'API Provider Strategy', link: '/provider-strategy' }
79
+ ]
80
+ },
81
+ {
82
+ text: 'Agent & IDE Extensions',
83
+ items: [
84
+ { text: 'Agent Compatibility Mappings', link: '/agent-compatibility' },
85
+ { text: 'Custom Adapters Guide', link: '/adapter-authoring' },
86
+ { text: 'Template Authoring Guide', link: '/template-authoring' },
87
+ { text: 'Skill Authoring Guide', link: '/skill-authoring' },
88
+ { text: 'Registry Contribution Guide', link: '/registry-contribution' }
89
+ ]
90
+ },
91
+ {
92
+ text: 'Mobile Integration & Delivery',
93
+ items: [
94
+ { text: 'Expo Android Delivery', link: '/mobile-android' }
95
+ ]
96
+ },
97
+ {
98
+ text: 'Token Cost Optimization',
99
+ items: [
100
+ { text: 'Token Budgets & Optimization', link: '/token-optimization' }
101
+ ]
102
+ },
35
103
  {
36
104
  text: 'Case Studies & Playbooks',
37
105
  items: [
@@ -74,6 +142,7 @@ export default {
74
142
  { text: 'Public Launch Checklist', link: '/launch-checklist' },
75
143
  { text: 'Release Playbook Template', link: '/release-template' },
76
144
  { text: 'CLI Roadmap', link: '/cli-roadmap' },
145
+ { text: 'v2.0.0 Roadmap', link: '/v2-roadmap' },
77
146
  { text: 'NPM Publishing Runbook', link: '/npm-publishing' },
78
147
  { text: 'Pre-flight Release Testing', link: '/testing-v0.2' },
79
148
  { text: 'Release Policy', link: '/release-policy' },
@@ -0,0 +1,46 @@
1
+ # Custom IDE Adapter Authoring Guide
2
+
3
+ MultiModel Dev OS is fully extensible. Developers and teams can build custom adapters to route protocol directives to new IDE interfaces, command-line coding agents, or company-proprietary AI environments.
4
+
5
+ ---
6
+
7
+ ## Authoring Workflow
8
+
9
+ To construct a new adapter:
10
+
11
+ ### 1. Register the Adapter Metadata
12
+ Open [.ai/adapters/registry.yaml](file:///F:/multimodel-dev-os/.ai/adapters/registry.yaml) and declare the adapter properties:
13
+ ```yaml
14
+ adapters:
15
+ my-custom-agent:
16
+ name: "My Custom Agent"
17
+ config_file: ".mycustomrules"
18
+ type: "coding-agent"
19
+ docs: "docs/adapters/my-custom-agent.md"
20
+ ```
21
+
22
+ ### 2. Scaffold the Adapter Assets
23
+ Create the adapter assets directory under `adapters/my-custom-agent/`:
24
+ * **`adapters/my-custom-agent/setup.md`**: Guide for developers enabling this adapter.
25
+ * **`adapters/my-custom-agent/.mycustomrules`**: Rule boilerplate template which contains variables (e.g. system prompts or build scripts references) to be copied to project root during CLI initialization.
26
+
27
+ ### 3. Register in CLI
28
+ Open `bin/multimodel-dev-os.js` and extend the `handleInit` mapping:
29
+ ```javascript
30
+ } else if (adapter === 'my-custom-agent') {
31
+ const srcFile = join(sourceRoot, 'adapters/my-custom-agent/.mycustomrules');
32
+ const destFile = join(options.target, '.mycustomrules');
33
+ if (existsSync(srcFile)) {
34
+ writeFileSync(destFile, readFileSync(srcFile));
35
+ }
36
+ }
37
+ ```
38
+
39
+ ### 4. Verify Compliance
40
+ Extend `scripts/verify.js` to ensure the new files are verified:
41
+ ```javascript
42
+ checkFile('adapters/my-custom-agent/setup.md');
43
+ checkFile('adapters/my-custom-agent/.mycustomrules');
44
+ ```
45
+
46
+ Run `npm run verify` to confirm all assertions pass cleanly.
@@ -0,0 +1,51 @@
1
+ # Coding Agent & IDE Adapter Compatibility
2
+
3
+ MultiModel Dev OS acts as an interoperability layer across modern developer agents, terminal assistants, and IDE extensions.
4
+
5
+ ---
6
+
7
+ ## Agent Registry Mapping
8
+ Compatible configurations and destination files are detailed in [.ai/adapters/registry.yaml](file:///F:/multimodel-dev-os/.ai/adapters/registry.yaml):
9
+
10
+ ```yaml
11
+ adapters:
12
+ continue:
13
+ name: "Continue"
14
+ config_file: ".continue/config.json"
15
+ type: "editor-extension"
16
+ docs: "docs/adapters.md"
17
+ cline:
18
+ name: "Cline"
19
+ config_file: ".clinerules"
20
+ type: "coding-agent"
21
+ docs: "docs/agent-compatibility.md"
22
+ roo-code:
23
+ name: "Roo Code"
24
+ config_file: ".clinerules"
25
+ type: "coding-agent"
26
+ docs: "docs/agent-compatibility.md"
27
+ ```
28
+
29
+ ---
30
+
31
+ ## Supported Agent Configurations
32
+
33
+ ### 1. Continue
34
+ * **File Target**: `.continue/config.json`
35
+ * **Workflow**: Integrates custom system prompts and routing matrices into the VS Code / JetBrains sidebar panel.
36
+
37
+ ### 2. Cline / Roo Code
38
+ * **File Target**: `.clinerules`
39
+ * **Workflow**: Feeds strict directory layout schemas and role assignments directly to agent context loops during project scans.
40
+
41
+ ### 3. Aider
42
+ * **File Target**: `.aider.conf.yml`
43
+ * **Workflow**: Centralizes exclude filters, auto-commit actions, and CLI test verification shortcuts.
44
+
45
+ ### 4. Windsurf
46
+ * **File Target**: `.windsurfrules`
47
+ * **Workflow**: Injects development constraints and build commands into the IDE context window.
48
+
49
+ ### 5. OpenHands / Terminal Agents
50
+ * **File Target**: `CLAUDE.md` / `adapters/codex/AGENTS.md`
51
+ * **Workflow**: Standardize shell execution targets and error-handling steps for autonomous agents.
@@ -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.
@@ -39,26 +39,23 @@ node bin/multimodel-dev-os.js verify
39
39
  | `validate` | Strict directory schema compliance checks | v0.5.0 | ✅ Completed |
40
40
  | `sync` | Regenerate adapter files from root AGENTS.md | v0.6.0 | 📋 Planned |
41
41
  | `add-adapter` | Add a new adapter to the project | v0.6.0 | 📋 Planned |
42
+ | `models` | List configured model registry entries | v1.2.0 | Source Only |
43
+ | `show-model` | Inspect settings for a model registry entry | v1.2.0 | Source Only |
44
+ | `providers` | List configured model registry providers | v1.2.0 | Source Only |
45
+ | `route-model`| Route a target prompt based on presets | v1.2.0 | Source Only |
46
+ | `adapters` | List configured adapter registry entries | v1.2.0 | Source Only |
47
+ | `show-adapter`| Inspect settings for an adapter registry entry | v1.2.0 | Source Only |
48
+ | `skills` | List configured skill registry entries | v1.2.0 | Source Only |
49
+ | `show-skill` | Inspect settings for a skill registry entry | v1.2.0 | Source Only |
42
50
 
43
- ## Requirements Completed in v0.5.0
51
+ > [!NOTE]
52
+ > All new `v1.2.0` subcommands listed as **Source Only** are fully implemented in the source code but are unreleased on the npm package registry. To run them, execute from a clone of the GitHub repository. They will be packaged officially in the `v2.0.0` stable release.
44
53
 
45
- - [x] Implemented strict `validate` CLI command for structural directory validation.
46
- - [x] Implemented advisory `doctor` command for project compatibility warnings.
47
- - [x] Implemented `templates` and `show-template` commands for built-in profiles inspection.
48
- - [x] Upgraded all 5 built-in template profiles with practical real-world contents.
49
- - [x] Implemented dynamic context budgetary constraints and skills validation.
50
- - [x] Preserved zero-dependency pure Node CLI implementations.
54
+ ## CLI v2.0.0 Stabilization Goal
51
55
 
52
- ## Future Releases (v0.6.0+)
56
+ Ahead of the `v2.0.0` release, we will run a comprehensive compatibility pass:
57
+ * **Backward Compatibility**: Ensure that all new registries configurations and subcommand syntax do not break the stable `v1.0.0` and `v1.1.0` CLI behaviors.
58
+ * **Unified Quality Gates**: Integrate model registry and adapter configuration validation parameters directly into the standard `validate` and `doctor` command pipelines.
59
+ * **Cross-Platform Hardening**: Audit all commands on Windows (PowerShell/CMD), macOS, and Linux bash environments before resuming npm package publishing.
53
60
 
54
- * **Adapter Autoregeneration (`sync`):** Parse custom override boundaries inside adapters and automatically synchronize them with updates in the root markdown source of truth.
55
- * **Interactive Mode:** Provide step-by-step CLI options if run without arguments.
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
61
 
@@ -1,6 +1,8 @@
1
1
  # Compatibility & Customization Guide
2
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.
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`.
4
6
 
5
7
  ---
6
8
 
@@ -37,6 +39,8 @@ To guarantee validation compliance:
37
39
 
38
40
  ---
39
41
 
40
- ## 4. v1.0.0 Compatibility Guarantee
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.
41
45
 
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.
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,91 +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
41
+ - Cursor → `.cursorrules`
42
+ - Claude Code → `CLAUDE.md`
43
+ - VS Code → `.vscode/settings.json`
47
44
 
48
- **My tool isn't listed. Can I add one?**
49
- Yes. See [docs/adapters.md](adapters.md) for the guide. PRs welcome.
50
-
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.
60
-
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
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.
66
51
 
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.
80
59
 
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.
60
+ ---
83
61
 
84
62
  ## Protocol & Migration
85
63
 
86
64
  **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.
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.
91
66
 
67
+ Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
@@ -1,13 +1,16 @@
1
- # Final Launch Guidelines
1
+ # Final Launch Guidelines (v2.0.0 Target)
2
2
 
3
- This document details the final launch guidelines and distribution routines for the public `v1.0.0` release of MultiModel Dev OS.
3
+ This document details the final launch guidelines and distribution routines for the public releases of MultiModel Dev OS.
4
+
5
+ > [!IMPORTANT]
6
+ > **v2.0.0 is the active stable release.** NPM publishing is no longer paused. All Template Galaxy and Model Compatibility features are now available on the public registry.
4
7
 
5
8
  ---
6
9
 
7
10
  ## 1. Local Pre-flight Verification
8
11
 
9
- Prior to pushing files to the remote repository, ensure that:
10
- - The exact target version `1.0.0` is configured in `package.json`.
12
+ Prior to pushing files or preparing a release, ensure that:
13
+ - The exact target version starts with `2.` (e.g. `2.0.0`) in `package.json` for publishing, or remains at `1.2.0` for local development.
11
14
  - The cross-platform verify script completes cleanly:
12
15
  ```bash
13
16
  npm run verify
@@ -25,5 +28,8 @@ When publishing the stable release, communicate the key advantages clearly:
25
28
  - **Portability**: Write-once configurations working seamlessly across Cursor, Claude, Gemini, Antigravity, and VS Code.
26
29
  - **Context Economy**: Up to 79% reduction in prompt tokens through Caveman Mode configurations.
27
30
  - **Zero Dependencies**: A completely self-contained CLI for lightning-fast setups.
31
+ - **AI Discoverability**: Ready-to-ingest discoverability guides (`llms.txt` / `llms-full.txt`) for LLM agents.
28
32
 
29
33
  Refer to `docs/launch-kit.md` for specific copy blocks ready for distribution on Twitter/X, LinkedIn, Hacker News, and Reddit.
34
+
35
+ Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
package/docs/index.md CHANGED
@@ -71,6 +71,22 @@ features:
71
71
  font-size: 0.9rem;
72
72
  color: var(--vp-c-text-2);
73
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
+ }
74
90
  </style>
75
91
 
76
92
  ## Quick Start Setup
@@ -83,6 +99,21 @@ npx multimodel-dev-os@latest init
83
99
 
84
100
  ---
85
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
+
86
117
  ## Core Specifications & Playbooks
87
118
 
88
119
  <div class="grid-container">
@@ -108,16 +139,28 @@ npx multimodel-dev-os@latest init
108
139
  </a>
109
140
  <a href="/migration-guide" class="card-item">
110
141
  <div class="card-title">📈 Migration Playbook</div>
111
- <div class="card-desc">Upgrade older workspaces to v1.0.0 standards cleanly.</div>
142
+ <div class="card-desc">Upgrade older workspaces to v1.1.0 standards cleanly.</div>
112
143
  </a>
113
144
  <a href="/v1-checklist" class="card-item">
114
145
  <div class="card-title">🏁 Release Checklist</div>
115
146
  <div class="card-desc">Audit repository compliance with the strict release quality gates.</div>
116
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>
117
152
  </div>
118
153
 
119
154
  ---
120
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
+
121
164
  ## Cost & Context Optimization
122
165
 
123
166
  Minimize prompt overhead and API billing by mapping key context-reduction techniques to MultiModel Dev OS features:
@@ -0,0 +1,48 @@
1
+ # Local & Open-Weight Offline Models Guide
2
+
3
+ MultiModel Dev OS supports offline development workflows utilizing open-weight models running on local developer hardware (via Ollama, Llama.cpp, or vLLM).
4
+
5
+ ---
6
+
7
+ ## Local Models Configuration
8
+ Local model bindings are defined in [.ai/models/local-models.yaml](file:///F:/multimodel-dev-os/.ai/models/local-models.yaml):
9
+
10
+ ```yaml
11
+ local_engines:
12
+ ollama:
13
+ base_url: "http://localhost:11434/v1"
14
+ models:
15
+ - alias: local-coder-model
16
+ official_id: qwen2.5-coder:7b
17
+ - alias: open-weight-reasoner
18
+ official_id: deepseek-r1:8b
19
+ ```
20
+
21
+ ---
22
+
23
+ ## Local Setup Instructions
24
+
25
+ ### 1. Using Ollama
26
+ To spin up a local model runner and pull target coding weights:
27
+ ```bash
28
+ # Install Ollama and run server
29
+ ollama run qwen2.5-coder:7b
30
+
31
+ # In another terminal tab, run MultiModel Dev OS verify
32
+ node bin/multimodel-dev-os.js verify
33
+ ```
34
+
35
+ ### 2. Local fallback routing
36
+ To configure local fallback when remote APIs are unavailable, set your primary model map to point to the local coder model:
37
+ ```yaml
38
+ # .ai/context/model-map.md
39
+ Planning: open-weight-reasoner
40
+ Execution: local-coder-model
41
+ ```
42
+
43
+ ---
44
+
45
+ ## Benefits & Optimization
46
+ * **Zero API Cost**: Local model queries carry no token charges.
47
+ * **Privacy Compliance**: No code snippets or workspace context files leave the local host machine.
48
+ * **Offline-Ready**: Develop and build applications on flights or remote zones with zero internet dependencies.