multimodel-dev-os 1.1.0 → 2.0.1
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/adapters/custom-adapter.example.yaml +9 -0
- package/.ai/adapters/registry.yaml +56 -0
- package/.ai/models/README.md +14 -0
- package/.ai/models/local-models.yaml +20 -0
- package/.ai/models/providers.yaml +29 -0
- package/.ai/models/registry.yaml +73 -0
- package/.ai/models/routing-presets.yaml +23 -0
- package/.ai/skills/custom-skill.example.md +15 -0
- package/.ai/templates/custom-template.example.yaml +19 -0
- package/.ai/templates/registry.yaml +522 -0
- package/README.md +30 -18
- package/bin/multimodel-dev-os.js +835 -92
- package/docs/.vitepress/config.js +36 -1
- package/docs/adapter-authoring.md +46 -0
- package/docs/agent-compatibility.md +51 -0
- package/docs/cli-roadmap.md +12 -23
- package/docs/faq.md +1 -1
- package/docs/final-launch.md +5 -4
- package/docs/index.md +5 -5
- package/docs/local-models.md +48 -0
- package/docs/mobile-android.md +75 -0
- package/docs/model-compatibility.md +65 -0
- package/docs/model-routing.md +45 -0
- package/docs/npm-publishing.md +38 -11
- package/docs/package-safety.md +29 -0
- package/docs/provider-strategy.md +44 -0
- package/docs/public/llms-full.txt +82 -73
- package/docs/public/llms.txt +36 -34
- package/docs/public/sitemap.xml +51 -1
- package/docs/quickstart.md +11 -18
- package/docs/registry-contribution.md +20 -0
- package/docs/release-policy.md +9 -0
- package/docs/skill-authoring.md +56 -0
- package/docs/template-authoring.md +65 -0
- package/docs/templates-guide.md +3 -3
- package/docs/token-optimization.md +27 -0
- package/docs/v2-migration.md +31 -0
- package/docs/v2-release-checklist.md +30 -0
- package/docs/v2-roadmap.md +95 -0
- package/examples/expo-react-native-android/.ai/config.yaml +22 -0
- package/examples/expo-react-native-android/.ai/context/architecture.md +18 -0
- package/examples/expo-react-native-android/.ai/context/context-budget.md +4 -0
- package/examples/expo-react-native-android/.ai/context/model-map.md +6 -0
- package/examples/expo-react-native-android/.ai/context/project-brief.md +9 -0
- package/examples/expo-react-native-android/.ai/session-logs/.gitkeep +1 -0
- package/examples/expo-react-native-android/.ai/skills/expo-android-build.md +11 -0
- package/examples/expo-react-native-android/AGENTS.md +20 -0
- package/examples/expo-react-native-android/MEMORY.md +13 -0
- package/examples/expo-react-native-android/README.md +101 -0
- package/examples/expo-react-native-android/RUNBOOK.md +36 -0
- package/examples/expo-react-native-android/TASKS.md +14 -0
- package/examples/expo-react-native-android/app.config.ts +40 -0
- package/examples/expo-react-native-android/app.json +34 -0
- package/examples/expo-react-native-android/eas.json +26 -0
- package/examples/expo-react-native-android/jest.config.js +11 -0
- package/examples/expo-react-native-android/src/app/_layout.tsx +89 -0
- package/examples/expo-react-native-android/src/lib/secure-storage.ts +63 -0
- package/examples/expo-react-native-android/src/services/api-client.ts +106 -0
- package/package.json +3 -2
- package/scripts/install.ps1 +230 -230
- package/scripts/install.sh +1 -1
- package/scripts/prepublish-guard.js +43 -0
- package/scripts/verify.js +178 -1
|
@@ -1,73 +1,82 @@
|
|
|
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
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
│
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
│
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
- **`
|
|
31
|
-
- **`
|
|
32
|
-
- **`
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
- **`
|
|
41
|
-
- **`
|
|
42
|
-
- **`
|
|
43
|
-
- **`
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
1
|
+
# MultiModel Dev OS — Comprehensive AI Assistant Discoverability Guide (v2.0.1 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
|
package/docs/public/llms.txt
CHANGED
|
@@ -1,34 +1,36 @@
|
|
|
1
|
-
# MultiModel Dev OS (
|
|
2
|
-
|
|
3
|
-
Portable, vendor-neutral workspace configuration standard for multi-agent AI pair-programming workflows.
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
16
|
-
- **
|
|
17
|
-
- **
|
|
18
|
-
- **
|
|
19
|
-
- **
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
- **
|
|
24
|
-
- **
|
|
25
|
-
- **
|
|
26
|
-
- **
|
|
27
|
-
- **
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
- `
|
|
32
|
-
- `
|
|
33
|
-
- `
|
|
34
|
-
- `
|
|
1
|
+
# MultiModel Dev OS (v2.0.1 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)
|
package/docs/public/sitemap.xml
CHANGED
|
@@ -61,8 +61,58 @@
|
|
|
61
61
|
<priority>0.6</priority>
|
|
62
62
|
</url>
|
|
63
63
|
<url>
|
|
64
|
-
<loc>https://rizvee.github.io/multimodel-dev-os/
|
|
64
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/v2-release-checklist</loc>
|
|
65
65
|
<changefreq>weekly</changefreq>
|
|
66
66
|
<priority>0.6</priority>
|
|
67
67
|
</url>
|
|
68
|
+
<url>
|
|
69
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/model-routing</loc>
|
|
70
|
+
<changefreq>weekly</changefreq>
|
|
71
|
+
<priority>0.7</priority>
|
|
72
|
+
</url>
|
|
73
|
+
<url>
|
|
74
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/local-models</loc>
|
|
75
|
+
<changefreq>weekly</changefreq>
|
|
76
|
+
<priority>0.7</priority>
|
|
77
|
+
</url>
|
|
78
|
+
<url>
|
|
79
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/provider-strategy</loc>
|
|
80
|
+
<changefreq>weekly</changefreq>
|
|
81
|
+
<priority>0.7</priority>
|
|
82
|
+
</url>
|
|
83
|
+
<url>
|
|
84
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/agent-compatibility</loc>
|
|
85
|
+
<changefreq>weekly</changefreq>
|
|
86
|
+
<priority>0.7</priority>
|
|
87
|
+
</url>
|
|
88
|
+
<url>
|
|
89
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/adapter-authoring</loc>
|
|
90
|
+
<changefreq>weekly</changefreq>
|
|
91
|
+
<priority>0.7</priority>
|
|
92
|
+
</url>
|
|
93
|
+
<url>
|
|
94
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/template-authoring</loc>
|
|
95
|
+
<changefreq>weekly</changefreq>
|
|
96
|
+
<priority>0.7</priority>
|
|
97
|
+
</url>
|
|
98
|
+
<url>
|
|
99
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/skill-authoring</loc>
|
|
100
|
+
<changefreq>weekly</changefreq>
|
|
101
|
+
<priority>0.7</priority>
|
|
102
|
+
</url>
|
|
103
|
+
<url>
|
|
104
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/v2-migration</loc>
|
|
105
|
+
<changefreq>weekly</changefreq>
|
|
106
|
+
<priority>0.7</priority>
|
|
107
|
+
</url>
|
|
108
|
+
<url>
|
|
109
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/package-safety</loc>
|
|
110
|
+
<changefreq>weekly</changefreq>
|
|
111
|
+
<priority>0.7</priority>
|
|
112
|
+
</url>
|
|
113
|
+
<url>
|
|
114
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/registry-contribution</loc>
|
|
115
|
+
<changefreq>weekly</changefreq>
|
|
116
|
+
<priority>0.7</priority>
|
|
117
|
+
</url>
|
|
68
118
|
</urlset>
|
package/docs/quickstart.md
CHANGED
|
@@ -6,9 +6,9 @@ Get the MultiModel Dev OS integrated into your codebase in under 2 minutes to sy
|
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
## Option A: NPX Scaffolding (
|
|
9
|
+
## Option A: NPX Scaffolding (Stable Packages)
|
|
10
10
|
|
|
11
|
-
Initialize any project
|
|
11
|
+
Initialize any project instantly using our public npm registry. Note that this pulls the latest stable npm-published release (`v2.0.1`):
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
# Standard interactive initialization in the current directory
|
|
@@ -25,7 +25,7 @@ npx multimodel-dev-os@latest init --dry-run
|
|
|
25
25
|
|
|
26
26
|
## Option B: Fallback One-Line Scripts
|
|
27
27
|
|
|
28
|
-
If you choose to run installation scripts directly:
|
|
28
|
+
If you choose to run installation scripts directly (fetches stable files):
|
|
29
29
|
|
|
30
30
|
**macOS / Linux / WSL (bash):**
|
|
31
31
|
```bash
|
|
@@ -49,17 +49,13 @@ curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scrip
|
|
|
49
49
|
|
|
50
50
|
---
|
|
51
51
|
|
|
52
|
-
## Option D:
|
|
52
|
+
## Option D: Scaffold Target Directory (NPX Direct)
|
|
53
53
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
2. Run the CLI directly using the absolute target path:
|
|
60
|
-
```bash
|
|
61
|
-
node bin/multimodel-dev-os.js init --target /path/to/your-project --template nextjs-saas --adapter cursor
|
|
62
|
-
```
|
|
54
|
+
If you prefer to initialize a target project path directly:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npx multimodel-dev-os@latest init --target /path/to/your-project --template nextjs-saas --adapter cursor
|
|
58
|
+
```
|
|
63
59
|
|
|
64
60
|
---
|
|
65
61
|
|
|
@@ -81,13 +77,10 @@ You can run our strict validation check or advisory doctor checkup to validate s
|
|
|
81
77
|
|
|
82
78
|
```bash
|
|
83
79
|
# Strict directory schema validation
|
|
84
|
-
|
|
80
|
+
npx multimodel-dev-os validate
|
|
85
81
|
|
|
86
82
|
# Advisory doctor workspace compatibility audit
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
# Verify repository structure checks
|
|
90
|
-
npm run verify
|
|
83
|
+
npx multimodel-dev-os doctor
|
|
91
84
|
```
|
|
92
85
|
|
|
93
86
|
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`.
|
package/docs/release-policy.md
CHANGED
|
@@ -31,3 +31,12 @@ No package shall be merged or released without:
|
|
|
31
31
|
- Building the documentation site without dead links (`npm run docs:build`).
|
|
32
32
|
- Running packaging validation (`npm pack --dry-run`).
|
|
33
33
|
- Executing smoke tests on all templates.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 4. Release Channel & Staging Controls
|
|
38
|
+
|
|
39
|
+
MultiModel Dev OS releases new versions directly to the public NPM registry:
|
|
40
|
+
* **Stable Releases (`npx multimodel-dev-os`)**: Published to the public registry under semantic version categories (e.g. `2.0.0`, `2.0.1`).
|
|
41
|
+
* **Release Candidates**: Built and validated locally via the automated verification script (`scripts/verify.js`) before tags or packaging runs.
|
|
42
|
+
* **Staging Verification**: To test new configurations prior to publishing, package the bundle locally (`npm pack`) and run CLI checkups in clean test directories.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Skill Authoring Guide
|
|
2
|
+
|
|
3
|
+
This guide explains how to construct high-fidelity reusable skills for MultiModel Dev OS.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Skills are custom prompts placed in the `.ai/skills/` directory of a project workspace. They instruct coding agents on exactly how to perform specific coding, refactoring, validation, or deployment routines.
|
|
8
|
+
|
|
9
|
+
## Required Structure
|
|
10
|
+
|
|
11
|
+
Every reusable skill file must be a Markdown (`.md`) file containing the following key sections:
|
|
12
|
+
|
|
13
|
+
```markdown
|
|
14
|
+
# Purpose
|
|
15
|
+
Describe what this skill accomplishes.
|
|
16
|
+
|
|
17
|
+
# Activation Trigger
|
|
18
|
+
Specify when a developer or agent should invoke this skill.
|
|
19
|
+
|
|
20
|
+
# Input Context
|
|
21
|
+
List the dependencies, files, or information required before executing this skill.
|
|
22
|
+
|
|
23
|
+
# Output Contract
|
|
24
|
+
Define the expected deliverables, formats, or file updates.
|
|
25
|
+
|
|
26
|
+
# Token Budget
|
|
27
|
+
Expected prompt footprint and limits.
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Example Skill File
|
|
31
|
+
|
|
32
|
+
```markdown
|
|
33
|
+
# Purpose
|
|
34
|
+
Deploy a Next.js Server Action with security gates.
|
|
35
|
+
|
|
36
|
+
# Activation Trigger
|
|
37
|
+
Trigger when building or modifying API endpoints / React Server Actions.
|
|
38
|
+
|
|
39
|
+
# Input Context
|
|
40
|
+
* Target action file
|
|
41
|
+
* Schema validations definitions
|
|
42
|
+
|
|
43
|
+
# Output Contract
|
|
44
|
+
Return the modified action file containing secure CSRF/Origin validation rules.
|
|
45
|
+
|
|
46
|
+
# Token Budget
|
|
47
|
+
~500 tokens
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Validating a Skill
|
|
51
|
+
|
|
52
|
+
To test your skill structure compliance, run:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
node bin/multimodel-dev-os.js validate-skill my-skill-name
|
|
56
|
+
```
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Custom Template Authoring Guide
|
|
2
|
+
|
|
3
|
+
This guide explains how to author a custom workspace configuration template for MultiModel Dev OS.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
A template packages a set of boilerplate markdown files (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`), a central `.ai/config.yaml` file, and stack-specific context files and skills.
|
|
8
|
+
|
|
9
|
+
## Structure of a Template Source
|
|
10
|
+
|
|
11
|
+
A template resides in the `examples/` directory of the project, or can be loaded dynamically from a custom path using `--registry` if declared in the registry.
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
examples/my-custom-template/
|
|
15
|
+
├── AGENTS.md # Core workspace contracts
|
|
16
|
+
├── MEMORY.md
|
|
17
|
+
├── TASKS.md
|
|
18
|
+
├── RUNBOOK.md
|
|
19
|
+
└── .ai/
|
|
20
|
+
├── config.yaml # Core configuration rules
|
|
21
|
+
├── context/ # Context templates
|
|
22
|
+
│ ├── project-brief.md
|
|
23
|
+
│ ├── architecture.md
|
|
24
|
+
│ └── context-budget.md
|
|
25
|
+
└── skills/ # Custom reusable skill files
|
|
26
|
+
└── custom-action.md
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Creating a Registry Entry
|
|
30
|
+
|
|
31
|
+
Add your template metadata to `.ai/templates/registry.yaml`:
|
|
32
|
+
|
|
33
|
+
```yaml
|
|
34
|
+
templates:
|
|
35
|
+
my-custom-template:
|
|
36
|
+
name: "my-custom-template"
|
|
37
|
+
description: "My custom framework stack workspace baseline."
|
|
38
|
+
stack: "My Framework, TypeScript, PostgreSQL"
|
|
39
|
+
skill: "custom-action.md"
|
|
40
|
+
skillDesc: "Framework specific secure execution rules."
|
|
41
|
+
category: "Web"
|
|
42
|
+
status: "stable"
|
|
43
|
+
maturity: "production-ready"
|
|
44
|
+
required_files:
|
|
45
|
+
- AGENTS.md
|
|
46
|
+
- MEMORY.md
|
|
47
|
+
- TASKS.md
|
|
48
|
+
- RUNBOOK.md
|
|
49
|
+
- .ai/config.yaml
|
|
50
|
+
- .ai/context/project-brief.md
|
|
51
|
+
- .ai/skills/custom-action.md
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Validation Rules
|
|
55
|
+
|
|
56
|
+
You can validate your template configuration using the CLI:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
node bin/multimodel-dev-os.js validate-template my-custom-template
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Validation ensures:
|
|
63
|
+
1. The template metadata matches the registry schema.
|
|
64
|
+
2. The template source directory exists.
|
|
65
|
+
3. All files listed in `required_files` are present.
|
package/docs/templates-guide.md
CHANGED
|
@@ -55,13 +55,13 @@ To view and list templates directly from your shell:
|
|
|
55
55
|
|
|
56
56
|
```bash
|
|
57
57
|
# List all templates
|
|
58
|
-
|
|
58
|
+
npx multimodel-dev-os templates
|
|
59
59
|
|
|
60
60
|
# Inspect nextjs-saas layout details
|
|
61
|
-
|
|
61
|
+
npx multimodel-dev-os show-template nextjs-saas
|
|
62
62
|
|
|
63
63
|
# Bootstrap target using a template
|
|
64
|
-
|
|
64
|
+
npx multimodel-dev-os init --target ../my-new-app --template nextjs-saas
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
---
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Token Optimization & Budget Policy
|
|
2
|
+
|
|
3
|
+
In agentic coding workflows, token overheads are the single largest source of API latency and cost. MultiModel Dev OS integrates tools and policies to optimize context inputs.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Caveman Mode
|
|
8
|
+
* **Goal**: Reduce baseline context token footprint by ~79%.
|
|
9
|
+
* **CLI Flag**: `node bin/multimodel-dev-os.js init --caveman`
|
|
10
|
+
* **Behavior**: Instantiates minimal `.caveman.md` files for `AGENTS.md`, `MEMORY.md`, `TASKS.md`, and `RUNBOOK.md`, omitting explanatory files and dense markdown guidelines.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 2. Context Budget Auditing
|
|
15
|
+
* Define strict context bounds inside [.ai/context/context-budget.md](file:///F:/multimodel-dev-os/.ai/context/context-budget.md).
|
|
16
|
+
* **CLI Command**: `node bin/multimodel-dev-os.js doctor --tokens`
|
|
17
|
+
* Checks if build outputs or caches (`node_modules/`, `dist/`, `.next/`, `build/`) are missing from `.gitignore` or are being exposed to LLM scan scopes.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 3. Policy Guidelines
|
|
22
|
+
|
|
23
|
+
### Keep Checklist Files Short
|
|
24
|
+
Use `TASKS.md` exclusively for active sprint tasks. Move completed or historical backlogs to archive directories or logs.
|
|
25
|
+
|
|
26
|
+
### Model Handoff Compression
|
|
27
|
+
When switching from reasoning models to quick-fixing models, use [.ai/prompts/compress-context.md](file:///F:/multimodel-dev-os/.ai/prompts/compress-context.md) to distill findings into high-density prompts.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# MultiModel Dev OS v2 Migration Guide
|
|
2
|
+
|
|
3
|
+
This guide describes how to migrate your developer configurations and workspace setup to the new Layered Architecture of MultiModel Dev OS v2.
|
|
4
|
+
|
|
5
|
+
## What is Changing
|
|
6
|
+
|
|
7
|
+
* **Version 1.1.0 and prior:** Handled flat configurations directly at the project root with individual configurations manually copied across.
|
|
8
|
+
* **Version 2.0.0 (and source milestones 1.2–1.5):** Establishes a clean, three-layered architecture where root contracts (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`) are automatically routed to adapters via the `.ai/` directory.
|
|
9
|
+
|
|
10
|
+
## Migration Steps
|
|
11
|
+
|
|
12
|
+
### 1. Upgrade the CLI
|
|
13
|
+
Run the latest v2 setup utility via npx:
|
|
14
|
+
```bash
|
|
15
|
+
npx multimodel-dev-os@latest init --template general-app
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### 2. Move Legacy Configuration Files
|
|
19
|
+
If you have custom system instructions or rules:
|
|
20
|
+
* Move `.cursorrules` custom rules to `.ai/skills/` as custom markdown skills.
|
|
21
|
+
* Re-generate adapter links:
|
|
22
|
+
```bash
|
|
23
|
+
npx multimodel-dev-os@latest init --adapter cursor --adapter claude
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### 3. Verify Migration Integrity
|
|
27
|
+
Run diagnostics to verify that ignored folders, boundaries, and files are clean:
|
|
28
|
+
```bash
|
|
29
|
+
npx multimodel-dev-os@latest doctor
|
|
30
|
+
npx multimodel-dev-os@latest validate
|
|
31
|
+
```
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# v2 Release Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist to verify compliance before publishing `multimodel-dev-os` to the npm registry.
|
|
4
|
+
|
|
5
|
+
## Pre-Flight Requirements
|
|
6
|
+
|
|
7
|
+
- [x] Ensure version string in `package.json` is set to `2.0.1`.
|
|
8
|
+
- [x] Verify version strings in documentation and install scripts (`scripts/install.sh`, `scripts/install.ps1`) align with the release.
|
|
9
|
+
- [x] Run full release verification:
|
|
10
|
+
```bash
|
|
11
|
+
npm run verify
|
|
12
|
+
```
|
|
13
|
+
- [x] Run registry checks:
|
|
14
|
+
```bash
|
|
15
|
+
node bin/multimodel-dev-os.js validate --all-registries
|
|
16
|
+
```
|
|
17
|
+
- [x] Run release doctor:
|
|
18
|
+
```bash
|
|
19
|
+
node bin/multimodel-dev-os.js doctor --release
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Packaging Verification
|
|
23
|
+
|
|
24
|
+
- [x] Execute dry pack run:
|
|
25
|
+
```bash
|
|
26
|
+
npm pack --dry-run
|
|
27
|
+
```
|
|
28
|
+
- [x] Inspect generated tarball file listing to verify only necessary directories (`.ai/`, `adapters/`, `bin/`, `docs/`, `examples/`, `scripts/`, `assets/`) are included.
|
|
29
|
+
- [x] Verify that the prepublish guard is bypassed only for the official production run.
|
|
30
|
+
- [x] Confirm no `.env` or sensitive `.npmrc` configurations are packaged.
|