multimodel-dev-os 0.3.0 → 0.5.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/README.md +103 -98
- package/bin/multimodel-dev-os.js +420 -35
- package/docs/caveman-mode.md +7 -3
- package/docs/cli-roadmap.md +33 -21
- package/docs/comparison.md +33 -0
- package/docs/faq.md +21 -4
- package/docs/installers.md +1 -1
- package/docs/launch-kit.md +99 -0
- package/docs/multimodel-workflow.md +10 -11
- package/docs/npm-publishing.md +2 -2
- package/docs/quickstart.md +42 -29
- package/docs/templates-guide.md +65 -0
- package/docs/use-cases.md +39 -0
- package/examples/ecommerce-store/.ai/config.yaml +7 -4
- package/examples/ecommerce-store/.ai/context/architecture.md +6 -0
- package/examples/ecommerce-store/.ai/context/context-budget.md +4 -0
- package/examples/ecommerce-store/.ai/context/model-map.md +4 -0
- package/examples/ecommerce-store/.ai/context/project-brief.md +3 -0
- package/examples/ecommerce-store/.ai/skills/webhook-handler.md +15 -0
- package/examples/ecommerce-store/AGENTS.md +15 -2
- package/examples/ecommerce-store/MEMORY.md +4 -3
- package/examples/ecommerce-store/TASKS.md +10 -0
- package/examples/general-app/.ai/config.yaml +7 -4
- package/examples/general-app/.ai/context/architecture.md +12 -0
- package/examples/general-app/.ai/context/context-budget.md +5 -0
- package/examples/general-app/.ai/context/model-map.md +7 -0
- package/examples/general-app/.ai/context/project-brief.md +6 -0
- package/examples/general-app/.ai/skills/example-skill.md +8 -0
- package/examples/general-app/AGENTS.md +69 -4
- package/examples/general-app/MEMORY.md +32 -2
- package/examples/general-app/TASKS.md +9 -0
- package/examples/nextjs-saas/.ai/config.yaml +7 -4
- package/examples/nextjs-saas/.ai/context/architecture.md +8 -0
- package/examples/nextjs-saas/.ai/context/context-budget.md +4 -0
- package/examples/nextjs-saas/.ai/context/model-map.md +4 -0
- package/examples/nextjs-saas/.ai/context/project-brief.md +5 -0
- package/examples/nextjs-saas/.ai/skills/nextjs-action-build.md +16 -0
- package/examples/nextjs-saas/AGENTS.md +8 -2
- package/examples/nextjs-saas/MEMORY.md +7 -4
- package/examples/nextjs-saas/TASKS.md +12 -0
- package/examples/seo-landing-page/.ai/config.yaml +7 -4
- package/examples/seo-landing-page/.ai/context/architecture.md +12 -0
- package/examples/seo-landing-page/.ai/context/context-budget.md +5 -0
- package/examples/seo-landing-page/.ai/context/model-map.md +7 -0
- package/examples/seo-landing-page/.ai/context/project-brief.md +6 -0
- package/examples/seo-landing-page/.ai/skills/seo-audit.md +21 -0
- package/examples/seo-landing-page/AGENTS.md +69 -4
- package/examples/seo-landing-page/MEMORY.md +33 -4
- package/examples/seo-landing-page/TASKS.md +9 -0
- package/examples/wordpress-site/.ai/config.yaml +7 -4
- package/examples/wordpress-site/.ai/context/architecture.md +7 -0
- package/examples/wordpress-site/.ai/context/context-budget.md +4 -0
- package/examples/wordpress-site/.ai/context/model-map.md +4 -0
- package/examples/wordpress-site/.ai/context/project-brief.md +3 -0
- package/examples/wordpress-site/.ai/skills/plugin-boilerplate.md +21 -0
- package/examples/wordpress-site/AGENTS.md +16 -3
- package/examples/wordpress-site/MEMORY.md +4 -3
- package/examples/wordpress-site/TASKS.md +10 -0
- package/package.json +3 -2
- package/scripts/install.ps1 +1 -1
- package/scripts/install.sh +1 -1
- package/scripts/verify.js +274 -0
- package/scripts/verify.sh +12 -12
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Comparison Guide: multimodel-dev-os vs. Alternatives
|
|
2
|
+
|
|
3
|
+
Selecting how to manage AI instructions inside a codebase significantly impacts developer speed, token consumption, and context drift. This document contrasts `multimodel-dev-os` with standard configurations.
|
|
4
|
+
|
|
5
|
+
## The Strategy Matrix
|
|
6
|
+
|
|
7
|
+
| Feature | AGENTS.md Only (DIY) | Tool-Specific Prompt Packs | MultiModel Dev OS (`.ai/` + CLI) |
|
|
8
|
+
| :--- | :--- | :--- | :--- |
|
|
9
|
+
| **Tool Portability** | Manual copying when changing tools | Zero portability (highly vendor-locked) | **Portable & Vendor-Neutral** (Single source of truth) |
|
|
10
|
+
| **Instruction Synchronization** | Manually synchronizing `.cursorrules`, `CLAUDE.md`, etc. | No synchronization (rules drift quickly) | **Automated** (Adapters mirror root rules instantly) |
|
|
11
|
+
| **Token Optimization** | No budgeting (full rules read every time) | Vague, static rules | **Caveman Mode** (slashes token footprints by **~79%**) |
|
|
12
|
+
| **Structural Segregation** | Flat single-file instructions (easily cluttered) | Disorganized configs | **Concise modular directories** (Context, Skills, Prompts, Checks) |
|
|
13
|
+
| **CI/CD Quality Gates** | None (no structural safety checks) | None | **Verify subcommand** (`npm run verify` protects standard formats) |
|
|
14
|
+
| **Standardized Hand-offs** | Manual human explanations | Manual human explanations | **Sequential hand-off protocol** with structured session logs |
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Detailed Evaluation
|
|
19
|
+
|
|
20
|
+
### 1. The DIY Approach (AGENTS.md Only)
|
|
21
|
+
Many developers start by dropping a single `AGENTS.md` file in their root. While better than nothing, this approach quickly breaks down:
|
|
22
|
+
* **Drift:** You modify a build command in `AGENTS.md`, but forget to update Cursor's `.cursorrules`. Cursor continues running the old build script, causing confusing errors.
|
|
23
|
+
* **Clutter:** A single markdown file gets bloated with styling guidelines, deployment procedures, and troubleshooting steps. Soon, the AI spends 10,000 tokens just reading instructions on every turn.
|
|
24
|
+
|
|
25
|
+
### 2. Tool-Specific Prompt Packs
|
|
26
|
+
Using tools like `Cursorrules` websites or Claude Code presets locks your project configuration into one vendor's ecosystem:
|
|
27
|
+
* **Vendor Lock:** If your team uses Cursor for coding and Claude Code for debugging, you must duplicate and manually translate the syntax for both tools.
|
|
28
|
+
* **No Collaboration:** Co-workers using different IDEs or terminal utilities cannot benefit from the unified context.
|
|
29
|
+
|
|
30
|
+
### 3. MultiModel Dev OS
|
|
31
|
+
`multimodel-dev-os` establishes a lightweight, vendor-neutral layer that decouples your project's rules from specific tools:
|
|
32
|
+
* **Translate once, read everywhere:** You write build parameters once in the root. The CLI and adapters expose these configurations cleanly to Cursor, Claude, Antigravity, VS Code, and Codex.
|
|
33
|
+
* **Continuous Integration:** You can add `multimodel-dev-os verify` to your CI pipeline or pre-commit hooks to guarantee that all developers share healthy, correctly-formatted AI configurations.
|
package/docs/faq.md
CHANGED
|
@@ -19,16 +19,23 @@ Not "multimodal" (multiple input types like text + image).
|
|
|
19
19
|
## Setup
|
|
20
20
|
|
|
21
21
|
**Do I need Node.js?**
|
|
22
|
-
|
|
23
|
-
|
|
22
|
+
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.
|
|
25
|
+
|
|
26
|
+
**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.
|
|
24
32
|
|
|
25
33
|
**Can I use just one AI tool?**
|
|
26
34
|
Yes. Use a single adapter. The multi-agent features are optional.
|
|
27
35
|
|
|
28
36
|
**Which files are required?**
|
|
29
37
|
At minimum: `AGENTS.md`. Everything else is optional.
|
|
30
|
-
The installer creates the full structure, but you can delete what you
|
|
31
|
-
don't need.
|
|
38
|
+
The installer creates the full structure, but you can delete what you don't need.
|
|
32
39
|
|
|
33
40
|
## Adapters
|
|
34
41
|
|
|
@@ -64,3 +71,13 @@ should coordinate. Runtime orchestration is planned for v0.2+.
|
|
|
64
71
|
**Do I need the orchestrator for single-agent workflows?**
|
|
65
72
|
No. The orchestrator is only relevant when multiple agents work
|
|
66
73
|
on the same codebase.
|
|
74
|
+
|
|
75
|
+
## Diagnostics & Validation
|
|
76
|
+
|
|
77
|
+
**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.
|
|
80
|
+
|
|
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.
|
|
83
|
+
|
package/docs/installers.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
While `npx multimodel-dev-os@latest init` is the primary and recommended route to bootstrap your project, we provide cross-platform automated shell script installers as robust, dependency-free fallbacks for environments without Node.js. These are located in `scripts/`.
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# Public Launch & Social Sharing Kit
|
|
2
|
+
|
|
3
|
+
Use these curated marketing templates and outlines to announce the release of `multimodel-dev-os` to developer communities.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Product Hunt Style Launch Info
|
|
8
|
+
* **Product Tagline:** Portable, vendor-neutral project context for all your AI coding tools.
|
|
9
|
+
* **Elevator Pitch:** Stop copy-pasting system instructions when switching between Cursor, Claude Code, Antigravity, and VS Code. Run a single command to sync, verify, and optimize your codebase context.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 2. GitHub Repository Metadata
|
|
14
|
+
* **Short Description:** Portable, vendor-neutral project configuration and CLI tool for AI coding agents. Think `.editorconfig` but optimized for LLMs, Cursor, Claude Code, and VS Code.
|
|
15
|
+
* **Topics/Keywords:** `ai-dev-os`, `multi-agent`, `ai-coding`, `developer-tools`, `cursorrules`, `claude-code`, `antigravity`
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 3. X / Twitter Post (The Hook)
|
|
20
|
+
```text
|
|
21
|
+
Pair programming with AI is fast, until you switch tools.
|
|
22
|
+
|
|
23
|
+
You design architecture in Claude Code, implement locally in Cursor, and audit with Gemini. Every switch drops context, and rules start to drift.
|
|
24
|
+
|
|
25
|
+
Stop copy-pasting. Say hello to multimodel-dev-os! 🧠
|
|
26
|
+
|
|
27
|
+
npx multimodel-dev-os@latest init
|
|
28
|
+
|
|
29
|
+
👉 Single source of truth for all tools (Cursor, Claude, VS Code, Gemini, Codex)
|
|
30
|
+
👉 Slashing token consumption by up to ~79% with Caveman Mode
|
|
31
|
+
👉 Strict CLI validation commands to protect context health
|
|
32
|
+
👉 Fully vendor-neutral and zero-dependency
|
|
33
|
+
|
|
34
|
+
Check it out: https://github.com/rizvee/multimodel-dev-os
|
|
35
|
+
#AIDev #OpenSource #SoftwareEngineering #AItools
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 4. LinkedIn Post (The Deep Dive)
|
|
41
|
+
```text
|
|
42
|
+
The hidden developer tax when coding with AI: Context Drift. 💸
|
|
43
|
+
|
|
44
|
+
When pair programming with AI agents, we often switch between platforms to leverage their unique strengths:
|
|
45
|
+
- Claude Code for terminal actions and system layouts
|
|
46
|
+
- Cursor for local autocomplete and quick edits
|
|
47
|
+
- Gemini / Antigravity for large-scale security and performance audits
|
|
48
|
+
|
|
49
|
+
But there's a problem: every tool has its own custom settings, systems, and instructions files. You modify a build command in one place, forget to update it in another, and the agent breaks on compile.
|
|
50
|
+
|
|
51
|
+
To solve this, we are launching `multimodel-dev-os` — a portable, vendor-neutral operating configuration layer for AI coding tools.
|
|
52
|
+
|
|
53
|
+
Think `.editorconfig` but designed for LLMs.
|
|
54
|
+
|
|
55
|
+
How it works:
|
|
56
|
+
1. Initialize in seconds: `npx multimodel-dev-os@latest init`
|
|
57
|
+
2. Configure your instructions in one root directory (AGENTS.md, MEMORY.md, TASKS.md)
|
|
58
|
+
3. Zero-duplication adapters dynamically present these instructions to Cursor (.cursorrules), Claude (CLAUDE.md), VS Code, and Gemini.
|
|
59
|
+
4. Slash token bills by up to ~79% using Caveman Mode for small-context turns.
|
|
60
|
+
|
|
61
|
+
Fully open-source, zero-dependency, and built to keep your context aligned across every coding tool.
|
|
62
|
+
|
|
63
|
+
GitHub: https://github.com/rizvee/multimodel-dev-os
|
|
64
|
+
Let me know what you think in the comments! 👇
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 5. Reddit-Style Post (/r/webdev, /r/LocalLLaMA)
|
|
70
|
+
* **Title:** Show Show HN / Show Reddit: I built multimodel-dev-os — a vendor-neutral context management layer for Cursor, Claude Code, and VS Code.
|
|
71
|
+
* **Content:**
|
|
72
|
+
Hey everyone,
|
|
73
|
+
|
|
74
|
+
If you pair program with multiple AI tools, you've probably noticed how fast rules drift. You edit a command in your system prompts, but forget to update Cursor's `.cursorrules`, causing the model to continuously fail.
|
|
75
|
+
|
|
76
|
+
I built **multimodel-dev-os** to solve this. It's a simple, zero-dependency CLI that scaffolds a unified context layout and uses lightweight adapters to route a single source of truth to all your tools.
|
|
77
|
+
|
|
78
|
+
### Key Features:
|
|
79
|
+
* **Primary Init:** Run `npx multimodel-dev-os@latest init` to bootstrap in 2 seconds.
|
|
80
|
+
* **Vendor-Neutral:** One config routes to Cursor (`.cursorrules`), Claude Code (`CLAUDE.md`), VS Code (`settings.json`), and Gemini/Antigravity (`settings.json`).
|
|
81
|
+
* **Caveman Mode:** Strips out examples and descriptions to save **~79% of tokens** when context budgets are tight.
|
|
82
|
+
* **Linter Guard:** Run `npx multimodel-dev-os@latest verify` to confirm structure health before pushing commits.
|
|
83
|
+
|
|
84
|
+
Open-source and MIT licensed. I'd love to hear your feedback on the layout structure!
|
|
85
|
+
|
|
86
|
+
GitHub: https://github.com/rizvee/multimodel-dev-os
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 6. Dev.to Article Outline
|
|
91
|
+
* **Title:** Stop Copy-Pasting AI Prompts: How to Build a Portable Context Layer in Your Codebase
|
|
92
|
+
* **Outline:**
|
|
93
|
+
1. **Introduction:** The multi-model developer reality (switching Cursor, Claude, Gemini).
|
|
94
|
+
2. **The Problem:** The "context synchronization tax" and rules drift.
|
|
95
|
+
3. **The Concept:** Decoupling rules from specific IDE extension configurations.
|
|
96
|
+
4. **Introducing multimodel-dev-os:** Setup in seconds using `npx multimodel-dev-os@latest init`.
|
|
97
|
+
5. **Deep Dive on Token Budgeting:** How Caveman Mode preserves structural intent while cutting token usage by ~79%.
|
|
98
|
+
6. **CI/CD Integration:** Adding `verify` commands to enforce healthy setups across team repositories.
|
|
99
|
+
7. **Conclusion & CTA:** Join the open-source project and build custom adapters.
|
|
@@ -104,18 +104,17 @@ Both: read shared MEMORY.md, coordinate via TASKS.md
|
|
|
104
104
|
3. **Atomic tasks** — each agent completes a coherent unit before handing off
|
|
105
105
|
4. **Single writer** — only one agent should modify a given file at a time
|
|
106
106
|
|
|
107
|
-
## Limitations (v0.
|
|
107
|
+
## Limitations (v0.3)
|
|
108
108
|
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
- Handoff logs must be written manually by the agent
|
|
109
|
+
- Local structural audits and templates are automated, but active daemon runtime orchestrations are not yet implemented.
|
|
110
|
+
- Handoff logs are structured but must be generated by agents/humans at task completion.
|
|
111
|
+
- Real-time model-to-model active messaging is not supported.
|
|
113
112
|
|
|
114
113
|
## Roadmap
|
|
115
114
|
|
|
116
|
-
| Version | Feature |
|
|
117
|
-
|
|
118
|
-
| v0.2 | CLI
|
|
119
|
-
| v0.3 |
|
|
120
|
-
| v0.4 |
|
|
121
|
-
| v0.5 |
|
|
115
|
+
| Version | Feature | Status |
|
|
116
|
+
|---------|---------|--------|
|
|
117
|
+
| v0.2.0 | Local CLI & stack templates | ✅ Completed |
|
|
118
|
+
| v0.3.0 | npm / npx dynamic installer integrations | ✅ Completed |
|
|
119
|
+
| v0.4.0 | Adapter automated synchronization (`sync`) | 📋 Planned |
|
|
120
|
+
| v0.5.0 | Dynamic conflict assertions & daemon tracking | 📋 Planned |
|
package/docs/npm-publishing.md
CHANGED
|
@@ -12,13 +12,13 @@ Before publishing, always test the built package locally by compiling a compress
|
|
|
12
12
|
```bash
|
|
13
13
|
npm pack
|
|
14
14
|
```
|
|
15
|
-
This creates a file named like `multimodel-dev-os-0.
|
|
15
|
+
This creates a file named like `multimodel-dev-os-0.3.0.tgz` in your directory root.
|
|
16
16
|
|
|
17
17
|
2. **Verify bundle contents:**
|
|
18
18
|
Create an empty temporary workspace, extract the tarball, and confirm that only required scaffold folders are included (no `.github/`, test configurations, or local system files):
|
|
19
19
|
```bash
|
|
20
20
|
mkdir -p /tmp/package-test && cd /tmp/package-test
|
|
21
|
-
tar -xzf /path/to/multimodel-dev-os-0.
|
|
21
|
+
tar -xzf /path/to/multimodel-dev-os-0.3.0.tgz
|
|
22
22
|
ls -la package/
|
|
23
23
|
```
|
|
24
24
|
|
package/docs/quickstart.md
CHANGED
|
@@ -2,7 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
Get multimodel-dev-os into your project in under 2 minutes.
|
|
4
4
|
|
|
5
|
-
## Option A:
|
|
5
|
+
## Option A: NPX Scaffolding (Recommended)
|
|
6
|
+
|
|
7
|
+
Initialize any project immediately without local clones using our public npm registry:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Standard interactive initialization in current directory
|
|
11
|
+
npx multimodel-dev-os@latest init
|
|
12
|
+
|
|
13
|
+
# Target specific stack templates and specific tool adapters
|
|
14
|
+
npx multimodel-dev-os@latest init --template nextjs-saas --adapter cursor --adapter claude
|
|
15
|
+
|
|
16
|
+
# Run a dry-run preview before executing file writes
|
|
17
|
+
npx multimodel-dev-os@latest init --dry-run
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Option B: Fallback One-Line Scripts
|
|
21
|
+
|
|
22
|
+
If you choose to run installation scripts directly:
|
|
6
23
|
|
|
7
24
|
**macOS / Linux / WSL (bash):**
|
|
8
25
|
```bash
|
|
@@ -14,45 +31,38 @@ curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scrip
|
|
|
14
31
|
irm https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/install.ps1 | iex
|
|
15
32
|
```
|
|
16
33
|
|
|
17
|
-
## Option B: Manual Scaffolding
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
git clone https://github.com/rizvee/multimodel-dev-os.git /tmp/mmdos
|
|
21
|
-
cp /tmp/mmdos/AGENTS.md your-project/
|
|
22
|
-
cp /tmp/mmdos/MEMORY.md your-project/
|
|
23
|
-
cp /tmp/mmdos/TASKS.md your-project/
|
|
24
|
-
cp /tmp/mmdos/RUNBOOK.md your-project/
|
|
25
|
-
cp /tmp/mmdos/.gitattributes your-project/
|
|
26
|
-
cp -r /tmp/mmdos/.ai your-project/
|
|
27
|
-
```
|
|
28
|
-
|
|
29
34
|
## Option C: Caveman Mode (Minimal Tokens)
|
|
30
35
|
|
|
36
|
+
Reduce token footprint by **~79%** with our lightweight variants:
|
|
37
|
+
|
|
31
38
|
```bash
|
|
32
39
|
curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/install.sh | bash -s -- --caveman
|
|
33
40
|
```
|
|
34
41
|
|
|
35
|
-
## Option D: Node.js
|
|
42
|
+
## Option D: Node.js Local Scaffolding CLI
|
|
36
43
|
|
|
37
|
-
For
|
|
44
|
+
For offline execution or customized packaging within a cloned workspace:
|
|
38
45
|
1. Clone this repository locally:
|
|
39
46
|
```bash
|
|
40
47
|
git clone https://github.com/rizvee/multimodel-dev-os.git
|
|
41
48
|
```
|
|
42
|
-
2. Run the CLI
|
|
49
|
+
2. Run the CLI directly using the absolute target path:
|
|
43
50
|
```bash
|
|
44
51
|
node bin/multimodel-dev-os.js init --target /path/to/your-project --template nextjs-saas --adapter cursor
|
|
45
52
|
```
|
|
46
53
|
|
|
47
|
-
## Option E:
|
|
54
|
+
## Option E: Manual Scaffolding
|
|
48
55
|
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
# General setup
|
|
52
|
-
npx multimodel-dev-os init
|
|
56
|
+
If you prefer absolute manual control over copying files:
|
|
53
57
|
|
|
54
|
-
|
|
55
|
-
|
|
58
|
+
```bash
|
|
59
|
+
git clone https://github.com/rizvee/multimodel-dev-os.git /tmp/mmdos
|
|
60
|
+
cp /tmp/mmdos/AGENTS.md your-project/
|
|
61
|
+
cp /tmp/mmdos/MEMORY.md your-project/
|
|
62
|
+
cp /tmp/mmdos/TASKS.md your-project/
|
|
63
|
+
cp /tmp/mmdos/RUNBOOK.md your-project/
|
|
64
|
+
cp /tmp/mmdos/.gitattributes your-project/
|
|
65
|
+
cp -r /tmp/mmdos/.ai your-project/
|
|
56
66
|
```
|
|
57
67
|
|
|
58
68
|
## After Install
|
|
@@ -65,15 +75,18 @@ npx multimodel-dev-os init --template nextjs-saas --adapter cursor
|
|
|
65
75
|
- VS Code: `cp -r adapters/vscode/.vscode/ .vscode/`
|
|
66
76
|
4. **Start coding** — your AI tools will read the shared config
|
|
67
77
|
|
|
68
|
-
## Verify
|
|
78
|
+
## Verify & Diagnose
|
|
69
79
|
|
|
70
|
-
You can run our strict
|
|
80
|
+
You can run our strict validation check or advisory doctor checkup to validate structural health:
|
|
71
81
|
```bash
|
|
72
|
-
#
|
|
73
|
-
node bin/multimodel-dev-os.js
|
|
82
|
+
# Strict directory schema validation
|
|
83
|
+
node bin/multimodel-dev-os.js validate --target /path/to/your-project
|
|
74
84
|
|
|
75
|
-
#
|
|
76
|
-
|
|
85
|
+
# Advisory doctor workspace compatibility audit
|
|
86
|
+
node bin/multimodel-dev-os.js doctor --target /path/to/your-project
|
|
87
|
+
|
|
88
|
+
# Legacy verification script
|
|
89
|
+
node bin/multimodel-dev-os.js verify --target /path/to/your-project
|
|
77
90
|
```
|
|
78
91
|
|
|
79
92
|
## Next Steps
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# multimodel-dev-os Templates Guide
|
|
2
|
+
|
|
3
|
+
`multimodel-dev-os` ships with 5 production-ready, stack-specific real-world templates that turn simple directories into structured developer profiles.
|
|
4
|
+
|
|
5
|
+
## Available Templates
|
|
6
|
+
|
|
7
|
+
### 1. `nextjs-saas`
|
|
8
|
+
- **Stack:** Next.js 14 (App Router), React 18, TypeScript, Tailwind CSS, Prisma ORM, Stripe payments
|
|
9
|
+
- **Use Case:** Subscription-based applications and SaaS products.
|
|
10
|
+
- **Skill File:** `.ai/skills/nextjs-action-build.md` (React Server Actions security guidelines).
|
|
11
|
+
|
|
12
|
+
### 2. `wordpress-site`
|
|
13
|
+
- **Stack:** WordPress Core, PHP, Gutenberg Block APIs, theme customization hooks, MySQL
|
|
14
|
+
- **Use Case:** Headless or standard custom themes and plugins.
|
|
15
|
+
- **Skill File:** `.ai/skills/plugin-boilerplate.md` (Sanitization gates and `$wpdb->prepare` queries).
|
|
16
|
+
|
|
17
|
+
### 3. `ecommerce-store`
|
|
18
|
+
- **Stack:** Headless Store API, cart states, secure payment webhooks (Stripe/Medusa)
|
|
19
|
+
- **Use Case:** PCI-compliant headless e-commerce store with secure checkout loops.
|
|
20
|
+
- **Skill File:** `.ai/skills/webhook-handler.md` (Payment webhooks listener auditing).
|
|
21
|
+
|
|
22
|
+
### 4. `seo-landing-page`
|
|
23
|
+
- **Stack:** Astro, HTML5, structured JSON-LD SEO markup, asset minification frameworks
|
|
24
|
+
- **Use Case:** Ultra-fast static marketing and landing page layouts.
|
|
25
|
+
- **Skill File:** `.ai/skills/seo-audit.md` (Google Lighthouse and Core Web Vitals optimization audit).
|
|
26
|
+
|
|
27
|
+
### 5. `general-app`
|
|
28
|
+
- **Stack:** Node.js, Express, ES6 Javascript, PostgreSQL, Jest
|
|
29
|
+
- **Use Case:** Universal backend APIs, CLI tools, and default projects.
|
|
30
|
+
- **Skill File:** `.ai/skills/example-skill.md` (Generic backend standard routing/validation rules).
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Scaffolding Directory Structure
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
├── AGENTS.md # Stack building conventions
|
|
38
|
+
├── MEMORY.md # Architectural decisions record
|
|
39
|
+
├── TASKS.md # Active task tracking
|
|
40
|
+
├── RUNBOOK.md # Team operations runbook
|
|
41
|
+
└── .ai/
|
|
42
|
+
├── config.yaml # Core adapters setup
|
|
43
|
+
├── context/ # Context budgets & maps
|
|
44
|
+
│ ├── project-brief.md
|
|
45
|
+
│ ├── architecture.md
|
|
46
|
+
│ ├── model-map.md
|
|
47
|
+
│ └── context-budget.md
|
|
48
|
+
└── skills/ # High-fidelity programming skills
|
|
49
|
+
└── [template-specific-skill].md
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## CLI Configuration Commands
|
|
53
|
+
|
|
54
|
+
To view and list templates directly from your shell:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# List all templates
|
|
58
|
+
node bin/multimodel-dev-os.js templates
|
|
59
|
+
|
|
60
|
+
# Inspect nextjs-saas layout details
|
|
61
|
+
node bin/multimodel-dev-os.js show-template nextjs-saas
|
|
62
|
+
|
|
63
|
+
# Bootstrap target using a template
|
|
64
|
+
node bin/multimodel-dev-os.js init --target ../my-new-app --template nextjs-saas
|
|
65
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Use Cases & Stack Scaffolding
|
|
2
|
+
|
|
3
|
+
`multimodel-dev-os` ships with pre-configured template profiles tailored for specific development environments. This guide explains how to leverage these profiles for maximum context-efficiency.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Next.js SaaS Stack
|
|
8
|
+
Designed for modern web applications using the Next.js App Router, React, and TypeScript.
|
|
9
|
+
* **Command:** `npx multimodel-dev-os@latest init --template nextjs-saas`
|
|
10
|
+
* **Scaffolds:** Optimized `.ai/context/architecture.md` focusing on server components, edge routing, Prisma schema rules, and custom state boundaries.
|
|
11
|
+
* **Benefits:** AI agents are instantly aligned on routing rules, avoiding common imports errors (e.g. Mixing server vs. Client components).
|
|
12
|
+
|
|
13
|
+
## 2. Headless E-commerce Store
|
|
14
|
+
Tailored for fast front-ends integrated with Shopify, Stripe, or MedusaJS.
|
|
15
|
+
* **Command:** `npx multimodel-dev-os@latest init --template ecommerce-store`
|
|
16
|
+
* **Scaffolds:** Context files defining critical payment gateways flow, secure Webhook signatures, and shopping cart session logic.
|
|
17
|
+
* **Benefits:** Guides AI models to implement strict validation rules for sensitive checkout states without manual prompt injection.
|
|
18
|
+
|
|
19
|
+
## 3. SEO Static Landing Page
|
|
20
|
+
Optimized for high-performance static websites built with Astro, Hugo, or Tailwind CSS.
|
|
21
|
+
* **Command:** `npx multimodel-dev-os@latest init --template seo-landing-page`
|
|
22
|
+
* **Scaffolds:** Rules outlining Core Web Vitals targets, structured JSON-LD schemes, and image optimization constraints.
|
|
23
|
+
* **Benefits:** Establishes automatic quality gates where the AI checks metadata structures before completing edits.
|
|
24
|
+
|
|
25
|
+
## 4. WordPress Custom Site
|
|
26
|
+
Built for PHP-based environments, custom plugins, and block theme architectures.
|
|
27
|
+
* **Command:** `npx multimodel-dev-os@latest init --template wordpress-site`
|
|
28
|
+
* **Scaffolds:** Strict configurations detailing WordPress coding standards, sanitization techniques (`esc_html`, `wp_kses`), and database queries structure.
|
|
29
|
+
* **Benefits:** Prevents AI from writing insecure direct SQL statements or outdated styling actions.
|
|
30
|
+
|
|
31
|
+
## 5. General Application Scaffolding
|
|
32
|
+
The universal fallback layout for Python, Go, Rust, or general backend setups.
|
|
33
|
+
* **Command:** `npx multimodel-dev-os@latest init --template general-app`
|
|
34
|
+
* **Scaffolds:** High-level project specifications, basic memory structures, and generic agent build instructions.
|
|
35
|
+
* **Benefits:** Fast, lightweight starting point for any software repository.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
For a complete breakdown of all files, scaffolding structures, and custom developer skills included in each profile, refer to the [Templates Guide](templates-guide.md).
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# E-commerce Store — Architecture Map
|
|
2
|
+
|
|
3
|
+
## Directory Boundaries
|
|
4
|
+
- `/services` — Inventory verification and payment orchestration classes.
|
|
5
|
+
- `/api` — Checkout APIs and Stripe webhook routes.
|
|
6
|
+
- `/storefront` — Next.js or Astro UI pages representing product collections.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Skill: Secure webhook endpoint implementation
|
|
2
|
+
|
|
3
|
+
Use this skill when implementing a secure checkout webhook listener:
|
|
4
|
+
|
|
5
|
+
1. **Verify Signatures:** Always verify the incoming payload signature using the webhook secret:
|
|
6
|
+
```javascript
|
|
7
|
+
const event = stripe.webhooks.constructEvent(
|
|
8
|
+
req.body,
|
|
9
|
+
req.headers['stripe-signature'],
|
|
10
|
+
process.env.STRIPE_WEBHOOK_SECRET
|
|
11
|
+
);
|
|
12
|
+
```
|
|
13
|
+
2. **Replay Attack Mitigation:** Validate timestamp tolerances inside payload events.
|
|
14
|
+
3. **Idempotency:** Implement idempotency gates in the database so that processing the same webhook event ID twice does not duplicate order entries.
|
|
15
|
+
4. **Fast Response:** Return a `200 OK` status immediately before running heavy asynchronous background tasks to prevent Stripe from resending payloads.
|
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# E-commerce Store — Agent Instructions
|
|
2
2
|
|
|
3
3
|
project: ecommerce-headless-store
|
|
4
|
-
stack:
|
|
5
|
-
description:
|
|
4
|
+
stack: MedusaJS, Stripe API, Node, React, Redis, Postgres
|
|
5
|
+
description: Headless e-commerce system with Stripe checkout loops and cart state validations.
|
|
6
|
+
|
|
7
|
+
## Build Commands
|
|
8
|
+
```
|
|
9
|
+
dev: npm run dev
|
|
10
|
+
build: npm run build
|
|
11
|
+
test: npm run test
|
|
12
|
+
lint: npm run lint
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Coding Conventions
|
|
16
|
+
- **Language:** ES6 TypeScript/JavaScript.
|
|
17
|
+
- **PCI-Compliance:** Never log or save raw credit card details on server logs; delegate billing operations strictly to Stripe.
|
|
18
|
+
- **Cart Validation:** Validate all quantities and product variant IDs against the backend database before creating checkout sessions.
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
# E-commerce Store — Memory
|
|
1
|
+
# E-commerce Store — Project Memory
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
-
|
|
3
|
+
## Architectural Decisions
|
|
4
|
+
- **Stripe Session Handlers:** Utilized Stripe checkout sessions directly to minimize custom database operations for token vaults.
|
|
5
|
+
- **Webhook Security:** Configured secure, cryptographically validated stripe webhook receivers in order routers to mitigate replay attacks.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# E-commerce Store — Starter Tasks
|
|
2
|
+
|
|
3
|
+
- [ ] Catalog Setup & Inventory Check
|
|
4
|
+
- [ ] Set up basic MedusaJS product tables
|
|
5
|
+
- [ ] Implement cart inventory checks before checkout launches
|
|
6
|
+
- [ ] Payment Integrations
|
|
7
|
+
- [ ] Securely integrate Stripe API endpoints for checkouts
|
|
8
|
+
- [ ] Write a secure webhook listener for checkout session payments
|
|
9
|
+
- [ ] Deployment & PCI Verification
|
|
10
|
+
- [ ] Validate environment variable encryptions on deployment
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Architecture Map
|
|
2
|
+
|
|
3
|
+
```mermaid
|
|
4
|
+
graph TD
|
|
5
|
+
Client[Client Layer] --> Router[Express Router]
|
|
6
|
+
Router --> Middleware[Sanitization & Auth Middleware]
|
|
7
|
+
Middleware --> Controllers[Route Controller Handlers]
|
|
8
|
+
Controllers --> Services[Business Logic Services]
|
|
9
|
+
Services --> Database[(PostgreSQL Pool)]
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
The system uses standard model-view-controller (MVC) inspired REST patterns for robust API separation of concerns.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Model Map
|
|
2
|
+
|
|
3
|
+
Define LLM task allocations for the General App context:
|
|
4
|
+
|
|
5
|
+
- **Coding & Implementation:** Gemini 3.5 Pro or Claude 3.5 Sonnet for precise code writing.
|
|
6
|
+
- **Refactoring & Lint Fixing:** Gemini 3.5 Flash for rapid low-cost iteration loops.
|
|
7
|
+
- **Validation & Auditing:** Claude 3.5 Sonnet for testing and code validation pipelines.
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# Project Brief
|
|
2
|
+
|
|
3
|
+
This project acts as a general baseline application profile. It uses a lightweight Node.js/Express backend setup with relational PostgreSQL storage, designed for API microservices.
|
|
4
|
+
- Ensure strict JSON validation.
|
|
5
|
+
- Deliver secure backend routes.
|
|
6
|
+
- Focus on clean modular architecture.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Skill: Generic backend instructions and coding standards
|
|
2
|
+
|
|
3
|
+
Use this skill when developing standard backend API endpoints or refactoring general application logic:
|
|
4
|
+
|
|
5
|
+
1. **State Isolation:** Ensure clean separation of routing, middleware, controllers, and services.
|
|
6
|
+
2. **Parameters validation:** Validate all HTTP incoming payloads (body, query, headers) using validator middleware.
|
|
7
|
+
3. **Connection safety:** Ensure database connections are released back to pools even on errors.
|
|
8
|
+
4. **Environment Isolation:** Never hardcode credentials. Retrieve secrets strictly from `process.env`.
|