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
@@ -0,0 +1,75 @@
1
+ # Production Mobile Android Setup (Expo + React Native)
2
+
3
+ MultiModel Dev OS v1.2.0 adds a dedicated production-ready template for mobile Android clients under [examples/expo-react-native-android/](file:///F:/multimodel-dev-os/examples/expo-react-native-android/).
4
+
5
+ This guide describes how to customize and deploy this template using Expo EAS Build pipelines.
6
+
7
+ ---
8
+
9
+ ## 1. Directory Structure
10
+
11
+ The `expo-react-native-android` template structures standard mobile files:
12
+
13
+ * **`app.json`**: Global metadata mapping package namespaces (`com.multimodel.devos`), app icons, orientation constraints, and runtime permissions.
14
+ * **`eas.json`**: Configuration profile mapping for Expo EAS Build pipelines.
15
+ * **`app.config.ts`**: TypeScript config dynamically mapping environment profiles.
16
+ * **`src/services/api-client.ts`**: Standardized fetch client with connection timeout limits.
17
+ * **`src/lib/secure-storage.ts`**: Storage wrapper interface utilizing `expo-secure-store`.
18
+ * **`src/app/_layout.tsx`**: Expo Router root Layout component displaying loading/offline network states.
19
+ * **`jest.config.js`**: Jest configuration setting up native Expo mocks and test suites.
20
+
21
+ ---
22
+
23
+ ## 2. Environment Configurations
24
+
25
+ EAS Build uses the `APP_ENV` environment variable to direct endpoint paths:
26
+
27
+ | Profile / APP_ENV | Target API BaseUrl | Distribution Method |
28
+ | :--- | :--- | :--- |
29
+ | `development` | `http://10.0.2.2:3000/api` | Expo Go Dev Client |
30
+ | `staging` | `https://staging-api.multimodel.dev` | Internal testing APK |
31
+ | `production` | `https://api.multimodel.dev` | Play Store AAB Bundle |
32
+
33
+ ---
34
+
35
+ ## 3. Build & Submission Command Lines
36
+
37
+ To trigger builds on EAS servers:
38
+ ```bash
39
+ # Build development client APK
40
+ eas build --profile development --platform android
41
+
42
+ # Build staging preview APK
43
+ eas build --profile preview --platform android
44
+
45
+ # Build production bundle AAB
46
+ eas build --profile production --platform android
47
+ ```
48
+
49
+ ---
50
+
51
+ ## 4. Mobile Quality Assurance (QA) Checklist
52
+
53
+ To verify app compliance before distribution:
54
+ 1. **No committed secrets**: Do not write keys inside `app.config.ts` or `app.json`. Use EAS secrets vault.
55
+ 2. **Offline Handlers**: Verify layout redirects properly to connection failure views when network states drop.
56
+ 3. **Session Encryptions**: Confirm tokens are stored exclusively inside `secure-storage.ts` (`expo-secure-store`), not `AsyncStorage`.
57
+
58
+ ---
59
+
60
+ ## 5. Android & Expo Template FAQ
61
+
62
+ ### Q: Why does the API call fail in the Android Emulator when using localhost?
63
+ In Android emulators, `localhost` or `127.0.0.1` refers to the emulator's loopback interface itself, not your host computer. The host computer's loopback interface is mapped to the special IP address `10.0.2.2`. The `api-client` automatically resolves this default when `APP_ENV` is set to `development`.
64
+
65
+ ### Q: How do I handle EAS credentials errors during eas build?
66
+ EAS credentials errors usually occur when the `projectId` or `owner` in `app.config.ts` does not match your Expo Developer account. To resolve this:
67
+ 1. Log in to your Expo account via command line: `npx eas login`.
68
+ 2. Configure your own Expo username in `app.config.ts` under `owner`.
69
+ 3. Generate a project ID on your Expo dashboard and update the `projectId` placeholder in `app.config.ts`.
70
+
71
+ ### Q: How do I test the API client's retry mechanism locally?
72
+ You can toggle offline mock responses by setting `useMockData: true` inside [api-client.ts](file:///f:/multimodel-dev-os/examples/expo-react-native-android/src/services/api-client.ts) constructor, or you can temporarily disconnect your development server to watch the console log warning attempts:
73
+ `[ApiClient] Attempt 1 failed: fetch failed. Retrying...`
74
+ The client will automatically retry up to 3 times before returning a `Max retries exceeded` error.
75
+
@@ -0,0 +1,65 @@
1
+ # Model Compatibility & Capabilities Registry
2
+
3
+ MultiModel Dev OS v1.2.0 introduces a centralized, registry-driven configuration layer to specify target AI model behaviors, token windows, cost metrics, and specialized capabilities.
4
+
5
+ This ensures that agentic coding workflows are future-proof, allowing developers to route prompts to optimal engines without updating core codebase packages.
6
+
7
+ ---
8
+
9
+ ## Central Registry File
10
+ The core system registry resides in [.ai/models/registry.yaml](file:///F:/multimodel-dev-os/.ai/models/registry.yaml):
11
+
12
+ ```yaml
13
+ models:
14
+ claude-sonnet-latest:
15
+ provider: anthropic
16
+ alias: claude-3-5-sonnet
17
+ official_id: claude-3-5-sonnet-20241022
18
+ context_window: 200000
19
+ tiers:
20
+ cost: high
21
+ speed: medium
22
+ reasoning: premium
23
+ coding: premium
24
+ capabilities:
25
+ vision: true
26
+ tool_use: true
27
+
28
+ gemini-flash-latest:
29
+ provider: google
30
+ alias: gemini-1.5-flash
31
+ official_id: gemini-1.5-flash-001
32
+ context_window: 1048576
33
+ tiers:
34
+ cost: low
35
+ speed: fast
36
+ reasoning: medium
37
+ coding: medium
38
+ capabilities:
39
+ vision: true
40
+ tool_use: true
41
+ ```
42
+
43
+ ---
44
+
45
+ ## Schema Attributes Reference
46
+
47
+ | Property | Type | Description |
48
+ | :--- | :--- | :--- |
49
+ | `provider` | String | Matches identifier in [providers.yaml](file:///F:/multimodel-dev-os/.ai/models/providers.yaml). |
50
+ | `alias` | String | Common developer name or shortcut (e.g. `gpt-4o`). |
51
+ | `official_id` | String | Precise API endpoint identifier string. |
52
+ | `context_window` | Integer | Maximum token capacity of the model. |
53
+ | `tiers` | Object | Speed, cost, reasoning, and coding classifications (low/medium/high/premium). |
54
+ | `capabilities` | Object | Toggles indicating `vision` or `tool_use` (function calling) support. |
55
+
56
+ ---
57
+
58
+ ## Dynamic Placeholders
59
+ If a model name is future-facing or unverified, it is registered as a configurable placeholder or alias:
60
+ * `gpt-coding-latest`
61
+ * `deepseek-coder-latest`
62
+ * `local-coder-model`
63
+ * `open-weight-reasoner`
64
+
65
+ This strategy prevents hardcoding unverified API configurations and allows instant mapping via localized parameters.
@@ -0,0 +1,45 @@
1
+ # Multi-Model Routing & Presets Guide
2
+
3
+ To optimize context budgets and API costs, MultiModel Dev OS separates agent roles and routes tasks to specialized model families based on their complexity.
4
+
5
+ ---
6
+
7
+ ## Central Routing Configuration
8
+ Routing policies and presets reside in [.ai/models/routing-presets.yaml](file:///F:/multimodel-dev-os/.ai/models/routing-presets.yaml):
9
+
10
+ ```yaml
11
+ presets:
12
+ planning:
13
+ primary: claude-sonnet-latest
14
+ fallback: gemini-pro-latest
15
+ debugging:
16
+ primary: deepseek-coder-latest
17
+ fallback: gemini-flash-latest
18
+ ```
19
+
20
+ ---
21
+
22
+ ## Standard Presets Matrix
23
+
24
+ ### 1. Planning (`planning` Preset)
25
+ * **Goal**: Architect implementation files, outline tasks checklists, and coordinate directory hierarchies.
26
+ * **Primary Target**: Premium reasoning models (e.g. `claude-sonnet-latest`, `gemini-pro-latest`).
27
+ * **Requirements**: Comprehensive context processing, high structured-output obedience.
28
+
29
+ ### 2. Code Writing (`coding` Preset)
30
+ * **Goal**: Generate precise diffs and write modular, functional scripts.
31
+ * **Primary Target**: Fast, high-accuracy coding models (e.g. `deepseek-coder-latest`, `claude-sonnet-latest`).
32
+ * **Requirements**: Coding tier premium classification.
33
+
34
+ ### 3. Quick Fixes & Verification (`verification` Preset)
35
+ * **Goal**: Run unit tests, verify CLI diagnostic outputs, and perform style compliance checks.
36
+ * **Primary Target**: Low-cost, fast inference models (e.g. `gemini-flash-latest`).
37
+ * **Requirements**: Speed tier fast classification, tool calling support.
38
+
39
+ ---
40
+
41
+ ## Fallback Routing Logic
42
+ When executing commands via terminal agents or local adapters:
43
+ 1. Verify target provider key exists (e.g. `GEMINI_API_KEY`).
44
+ 2. If primary model endpoint fails, check `capabilities.fallback` mapping in `registry.yaml`.
45
+ 3. Route queries automatically to fallback options or fallback to `local-coder-model`.
@@ -72,3 +72,30 @@ Execute these validation actions strictly in sequence before triggering a releas
72
72
  ```bash
73
73
  npm deprecate multimodel-dev-os@0.3.0 "Critical bug found, please use v0.3.1 instead."
74
74
  ```
75
+
76
+ ---
77
+
78
+ ## 4. Prepublish Safety Guard (v2.0.0 Stable)
79
+
80
+ > [!IMPORTANT]
81
+ > **v2.0.0 is the active stable release.** NPM publishing is no longer paused.
82
+
83
+ ### Source vs. Registry Strategy
84
+ * **GitHub main branch (Source)**: Contains the current stable `v2.0.0` codebase.
85
+ * **npm latest (Registry)**: Pulled and installed globally or via npx.
86
+
87
+ ### Prepublish Safety Guard
88
+ To prevent accidental `npm publish` executions on developer environments, a local validation script has been added to package hooks. If you run `npm publish`, it is blocked by default.
89
+
90
+ To bypass this check during the approved `v2.0.0` release window:
91
+ 1. Ensure the version in `package.json` starts with `2.` (e.g. `2.0.0`).
92
+ 2. Run publication with the override env variable:
93
+ ```powershell
94
+ # PowerShell
95
+ $env:MMDO_ALLOW_PUBLISH="true"
96
+ npm publish --access public
97
+ ```
98
+ ```bash
99
+ # Bash
100
+ MMDO_ALLOW_PUBLISH=true npm publish --access public
101
+ ```
@@ -0,0 +1,29 @@
1
+ # Package Safety and Security Hygiene
2
+
3
+ This document defines strict safety guidelines for the MultiModel Dev OS workspace.
4
+
5
+ ## Excluded Items List
6
+
7
+ To prevent security compromises, credential exposure, or prompt bloating, the following files must **never** be included in git pushes or packaged in NPM releases:
8
+
9
+ 1. **Local Credentials & API Keys:**
10
+ * `.npmrc` (specifically containing authentication tokens)
11
+ * `.env` / `.env.local`
12
+ 2. **Build and Cache Artifacts:**
13
+ * `node_modules/`
14
+ * `dist/` / `build/`
15
+ * `docs/.vitepress/dist/`
16
+ * `docs/.vitepress/cache/`
17
+ 3. **Mobile & Android Signing Artifacts:**
18
+ * `*.keystore` / `*.jks` files
19
+ * `google-services.json`
20
+ * `GoogleService-Info.plist`
21
+ * Signing configuration credentials
22
+
23
+ ## Enforcement
24
+
25
+ The project release audit scripts strictly enforce these checks:
26
+ ```bash
27
+ npm run verify
28
+ ```
29
+ Any violation will cause verification and build pipelines to fail immediately.
package/docs/protocol.md CHANGED
@@ -1,6 +1,8 @@
1
- # MultiModel Dev OS Protocol Specification
1
+ # MultiModel Dev OS Protocol Specification (v1.1.0)
2
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.
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.
4
6
 
5
7
  ---
6
8
 
@@ -27,12 +29,12 @@ The protocol is divided into three distinct decoupled layers to guarantee portab
27
29
 
28
30
  ---
29
31
 
30
- ## 2. Stability Matrix (v1.0.0 Freeze)
32
+ ## 2. Stability Matrix (v1.1.0 Freeze)
31
33
 
32
34
  To prevent breaking changes, protocol definitions are designated as **Stable** or **Experimental**:
33
35
 
34
36
  ### A. Stable Protocol Components
35
- These features are fully frozen. No breaking changes or renaming will occur in v1.0:
37
+ These features are fully frozen. No breaking changes or renaming will occur in `v1.x`:
36
38
  - **Core Workspace Contracts:** The names and root directories of `AGENTS.md`, `MEMORY.md`, `TASKS.md`, and `RUNBOOK.md` are completely frozen.
37
39
  - **Scaffolding Subfolders:** Target folders `.ai/context/`, `.ai/skills/`, and `.ai/session-logs/` are strictly required by the sync CLI.
38
40
  - **Adapters Interface:** Mappings to Cursor (`.cursorrules`), Claude (`CLAUDE.md`), VS Code (`.vscode/settings.json`), and Gemini (`GEMINI.md`) are guaranteed.
@@ -52,3 +54,5 @@ All compliant MultiModel Dev OS CLIs must strictly support the following executi
52
54
  - **`validate` Quality Gate:** Asserts that required folders and enabled adapter rules exist on disk.
53
55
  - **`doctor` Diagnostic:** Advisory audit of `.gitignore` setups and folder compatibility.
54
56
  - **`templates` Inspector:** Displays available stack configurations.
57
+
58
+ Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
@@ -0,0 +1,44 @@
1
+ # Provider Strategy & API Keys Reference
2
+
3
+ MultiModel Dev OS supports multi-vendor API routing by centralizing provider properties, endpoints, and credentials reference schemas.
4
+
5
+ ---
6
+
7
+ ## Provider Registry Configuration
8
+ Configure base URLs and API environment variables in [.ai/models/providers.yaml](file:///F:/multimodel-dev-os/.ai/models/providers.yaml):
9
+
10
+ ```yaml
11
+ providers:
12
+ anthropic:
13
+ name: "Anthropic"
14
+ api_endpoint: "https://api.anthropic.com/v1"
15
+ env_key: "ANTHROPIC_API_KEY"
16
+ default_headers:
17
+ "anthropic-version": "2023-06-01"
18
+
19
+ google:
20
+ name: "Google Gemini"
21
+ api_endpoint: "https://generativelanguage.googleapis.com/v1beta"
22
+ env_key: "GEMINI_API_KEY"
23
+
24
+ openai:
25
+ name: "OpenAI"
26
+ api_endpoint: "https://api.openai.com/v1"
27
+ env_key: "OPENAI_API_KEY"
28
+ ```
29
+
30
+ ---
31
+
32
+ ## API Key Security Rules
33
+
34
+ To guarantee credential safety during agentic loops:
35
+ 1. **Never commit raw keys**: Add `.env` and `.env.local` files to `.gitignore` to prevent committing secrets to version control.
36
+ 2. **Centralized Environment Variables**: Centralize keys inside local shell environments or local `.env` configs.
37
+ 3. **No hardcoded defaults**: The default `providers.yaml` refers only to standard environment variable keys (e.g. `ANTHROPIC_API_KEY`), never API secrets.
38
+
39
+ ---
40
+
41
+ ## custom endpoint routing (e.g. proxy/gateways)
42
+ For companies routing traffic through centralized proxy interfaces (such as OpenRouter, Cloudflare AI Gateway, or local mocks):
43
+ * Edit `.ai/models/providers.yaml` and update the `api_endpoint` parameter of the targeted provider.
44
+ * Update `default_headers` to inject custom authentication tokens or routing parameters required by the gateway.
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,82 @@
1
+ # MultiModel Dev OS — Comprehensive AI Assistant Discoverability Guide (v2.0.0 Stable Release)
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
+ │ (And central registries under .ai/models/ & .ai/adps/) │
16
+ └──────────────────────────┬─────────────────────────────┘
17
+ │ Centralizes project context
18
+ ┌──────────────────────────▼─────────────────────────────┐
19
+ │ LAYER 2: Configuration & Modules (.ai/) │
20
+ │ context/ • agents/ • skills/ • prompts/ • checks/ │
21
+ └──────────────────────────┬─────────────────────────────┘
22
+ │ Routes files dynamically
23
+ ┌──────────────────────────▼─────────────────────────────┐
24
+ │ LAYER 3: Tool & IDE Adapters │
25
+ │ .cursorrules • CLAUDE.md • .vscode/ • .gemini/ • etc. │
26
+ └────────────────────────────────────────────────────────┘
27
+ ```
28
+
29
+ ### Layer 1: Root Documents
30
+ - **`AGENTS.md`**: Defines teams, capabilities, boundaries, and model instructions.
31
+ - **`MEMORY.md`**: Holds architectural decisions, repository milestones, and tech stacks.
32
+ - **`TASKS.md`**: Active backlog tracking items.
33
+ - **`RUNBOOK.md`**: Operational verification commands and post-deployment routines.
34
+
35
+ ---
36
+
37
+ ## 2. CLI Command Specifications
38
+
39
+ All compliant MultiModel Dev OS CLIs strictly enforce the following command contracts:
40
+ - **`init`**: Scaffolds the standard `.ai/` context configuration directories. Supports `--template`, `--caveman`, `--adapter`, and dynamic registries mapping.
41
+ - **`verify`**: Automated release script that checks structure integrity.
42
+ - **`templates`**: Lists built-in template profiles (supports overrides via `--registry <path>`).
43
+ - **`validate`**: Strict Quality Gate checking the layout rules on disk (supports `--all-registries`).
44
+ - **`validate-template`**: Scans a template registry entry and source directory structure for completeness.
45
+ - **`validate-adapter`**: Audits an adapter config file and directory setup compliance.
46
+ - **`validate-skill`**: Checks a custom skill file against standard Markdown headers.
47
+ - **`doctor`**: Advisory checkup auditing ignored folders and token footprint (supports `--tokens` and `--release`).
48
+
49
+ ---
50
+
51
+ ## 3. Registries & Mappings
52
+
53
+ ### Model Compatibility Registry
54
+ Central registry configuration resides in `.ai/models/`:
55
+ * `registry.yaml`: Maps model aliases to official provider IDs, context windows, and tiers.
56
+ * `providers.yaml`: API base urls and environment variables keys.
57
+ * `routing-presets.yaml`: Multi-model presets for task-oriented routing.
58
+ * `local-models.yaml`: Endpoint mappings for offline model engines (Ollama, Llama.cpp).
59
+
60
+ ### IDE/Agent Adapters Registry
61
+ Central adapter rules mapped under `.ai/adapters/registry.yaml`:
62
+ * Targets files like `.cursorrules`, `CLAUDE.md`, `.vscode/settings.json`, `.clinerules`, `.aider.conf.yml`, `.windsurfrules`, `.continue/config.json`.
63
+
64
+ ---
65
+
66
+ ## 4. Key Context Optimization (Caveman Mode)
67
+
68
+ 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:
69
+
70
+ ```bash
71
+ npx multimodel-dev-os@latest init --caveman
72
+ ```
73
+
74
+ ---
75
+
76
+ ## 5. Canonical Links
77
+ - **Documentation site**: https://rizvee.github.io/multimodel-dev-os/
78
+ - **GitHub Codebase**: https://github.com/rizvee/multimodel-dev-os
79
+ - **v2.0.0 Roadmap**: https://rizvee.github.io/multimodel-dev-os/v2-roadmap
80
+ - **Release Policies**: https://rizvee.github.io/multimodel-dev-os/release-policy
81
+ - **Upgrade Playbook**: https://rizvee.github.io/multimodel-dev-os/migration-guide
82
+ - **Model Compatibility**: https://rizvee.github.io/multimodel-dev-os/model-compatibility
@@ -0,0 +1,36 @@
1
+ # MultiModel Dev OS (v2.0.0 Stable Release)
2
+
3
+ Portable, vendor-neutral workspace configuration standard for multi-agent AI pair-programming workflows.
4
+
5
+ ## Fast Setup (Stable npm @latest)
6
+ ```bash
7
+ npx multimodel-dev-os@latest init
8
+ ```
9
+
10
+ ## Supported Tools
11
+ - **Cursor** (`.cursorrules`)
12
+ - **Claude Code** (`CLAUDE.md`)
13
+ - **VS Code** (`.vscode/settings.json`)
14
+ - **Gemini** (`GEMINI.md`)
15
+ - **Antigravity** (`.gemini/settings.json`)
16
+ - **Continue** (`.continue/config.json`)
17
+ - **Cline / Roo Code** (`.clinerules`)
18
+ - **Aider** (`.aider.conf.yml`)
19
+ - **Windsurf** (`.windsurfrules`)
20
+ - **Codex** (`adapters/codex/AGENTS.md`)
21
+
22
+ ## Core Resources
23
+ - **Canonical Website**: https://rizvee.github.io/multimodel-dev-os/
24
+ - **GitHub Repository**: https://github.com/rizvee/multimodel-dev-os
25
+ - **NPM Package**: https://www.npmjs.com/package/multimodel-dev-os
26
+ - **Stable Protocol Specification**: https://rizvee.github.io/multimodel-dev-os/stable-protocol
27
+ - **Model Compatibility & Routing Guide**: https://rizvee.github.io/multimodel-dev-os/model-compatibility
28
+ - **Cost/Context Optimization Playbook**: https://rizvee.github.io/multimodel-dev-os/cost-optimization
29
+
30
+ ## Standard Templates
31
+ - `nextjs-saas` (App Router, Prisma ORM, Stripe)
32
+ - `wordpress-site` (Custom Block Themes, secure PHP guidelines)
33
+ - `ecommerce-store` (PCI checkout, Webhooks, card state)
34
+ - `seo-landing-page` (Astro static builds, JSON-LD, optimal LCP)
35
+ - `expo-react-native-android` (Production Android delivery with EAS Build)
36
+ - `general-app` (Universal baseline configurations)
Binary file
@@ -0,0 +1,4 @@
1
+ User-agent: *
2
+ Allow: /
3
+
4
+ Sitemap: https://rizvee.github.io/multimodel-dev-os/sitemap.xml
@@ -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>
@@ -1,12 +1,14 @@
1
- # Quickstart
1
+ # Quickstart Guide: AI Dev OS Deployment
2
2
 
3
- Get `multimodel-dev-os` integrated into your codebase in under 2 minutes.
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
 
7
- ## Option A: NPX Scaffolding (Recommended)
9
+ ## Option A: NPX Scaffolding (Stable Packages)
8
10
 
9
- Initialize any project immediately without local clones using our public npm registry:
11
+ Initialize any project instantly using our public npm registry. Note that this pulls the latest stable npm-published release (`v2.0.0`):
10
12
 
11
13
  ```bash
12
14
  # Standard interactive initialization in the current directory
@@ -23,7 +25,7 @@ npx multimodel-dev-os@latest init --dry-run
23
25
 
24
26
  ## Option B: Fallback One-Line Scripts
25
27
 
26
- If you choose to run installation scripts directly:
28
+ If you choose to run installation scripts directly (fetches stable files):
27
29
 
28
30
  **macOS / Linux / WSL (bash):**
29
31
  ```bash
@@ -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
- Reduce token footprint by **~79%** with our lightweight variants:
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
@@ -47,14 +49,15 @@ curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scrip
47
49
 
48
50
  ---
49
51
 
50
- ## Option D: Node.js Local Scaffolding CLI
52
+ ## Option D: Node.js Local Scaffolding CLI (Direct Run)
53
+
54
+ If you prefer to run directly from cloned source without global installation:
51
55
 
52
- For offline execution or customized packaging within a cloned workspace:
53
56
  1. Clone this repository locally:
54
57
  ```bash
55
58
  git clone https://github.com/rizvee/multimodel-dev-os.git
56
59
  ```
57
- 2. Run the CLI directly using the absolute target path:
60
+ 2. Run the CLI directly from the cloned repository source:
58
61
  ```bash
59
62
  node bin/multimodel-dev-os.js init --target /path/to/your-project --template nextjs-saas --adapter cursor
60
63
  ```
@@ -63,13 +66,13 @@ For offline execution or customized packaging within a cloned workspace:
63
66
 
64
67
  ## After Install
65
68
 
66
- 1. **Edit `AGENTS.md`** — fill in your project name, stack, and build commands.
69
+ 1. **Edit `AGENTS.md`** — fill in your project name, stack, and build commands (portable AI project context).
67
70
  2. **Edit `.ai/config.yaml`** — enable adapters for your tools.
68
- 3. **Copy adapter files** to your project root:
71
+ 3. **Copy adapter files** to your project root (e.g., Cursor project rules, Claude Code project instructions):
69
72
  - Cursor: `cp adapters/cursor/.cursorrules .cursorrules`
70
73
  - Claude: `cp adapters/claude/CLAUDE.md CLAUDE.md`
71
74
  - VS Code: `cp -r adapters/vscode/.vscode/ .vscode/`
72
- 4. **Start coding** — your AI tools will read the shared configuration instantly.
75
+ 4. **Start coding** — your AI coding agents will read the shared configuration instantly.
73
76
 
74
77
  ---
75
78
 
@@ -87,3 +90,5 @@ node bin/multimodel-dev-os.js doctor
87
90
  # Verify repository structure checks
88
91
  npm run verify
89
92
  ```
93
+
94
+ Explore our canonical [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
@@ -0,0 +1,20 @@
1
+ # Registry Contribution Workflow
2
+
3
+ This document describes how to propose and contribute new models, adapters, and templates.
4
+
5
+ ## Contribution Flow
6
+
7
+ 1. **Local Authoring:** Follow the respective authoring guides:
8
+ * [Custom IDE Adapter Authoring](adapter-authoring.md)
9
+ * [Custom Template Authoring](template-authoring.md)
10
+ * [Skill Authoring](skill-authoring.md)
11
+ 2. **Local Validation:** Use validation CLI commands to ensure structural compliance:
12
+ * `node bin/multimodel-dev-os.js validate-template <name>`
13
+ * `node bin/multimodel-dev-os.js validate-adapter <name>`
14
+ * `node bin/multimodel-dev-os.js validate-skill <name>`
15
+ 3. **Registry Addition:** Insert your metadata records into:
16
+ * `.ai/templates/registry.yaml` for templates.
17
+ * `.ai/adapters/registry.yaml` for adapters.
18
+ * `.ai/models/registry.yaml` for models.
19
+ 4. **Verification suite:** Run `npm run verify` to ensure the release audit checks pass cleanly.
20
+ 5. **Submit PR:** Submit your changes via a GitHub Pull Request to `https://github.com/rizvee/multimodel-dev-os`.