multimodel-dev-os 2.6.0 → 2.8.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/plugins/README.md +30 -0
- package/.ai/plugins/plugin.example.yaml +32 -0
- package/.ai/schema/plugin.schema.json +56 -0
- package/README.md +76 -219
- package/assets/adapter-sync-flow.svg +84 -0
- package/assets/architecture-preview.svg +46 -31
- package/assets/onboarding-flow.svg +79 -0
- package/assets/social-preview.svg +1 -1
- package/assets/terminal-demo.svg +22 -23
- package/bin/multimodel-dev-os.js +683 -2
- package/docs/.vitepress/config.js +25 -8
- package/docs/5-day-roadmap.md +9 -9
- package/docs/CLI.md +250 -111
- package/docs/architecture.md +31 -7
- package/docs/comparison.md +72 -25
- package/docs/compatibility.md +2 -2
- package/docs/dashboard.md +107 -0
- package/docs/demo.md +23 -60
- package/docs/demos/adapter-sync.md +103 -0
- package/docs/demos/existing-repo-onboarding.md +125 -0
- package/docs/demos/index.md +91 -0
- package/docs/demos/multi-agent-handoff.md +88 -0
- package/docs/demos/release-check.md +109 -0
- package/docs/demos/safe-improvement-loop.md +119 -0
- package/docs/distribution.md +195 -0
- package/docs/faq.md +91 -24
- package/docs/index.md +192 -81
- package/docs/installers.md +18 -4
- package/docs/launch-kit.md +97 -49
- package/docs/npm-publishing.md +6 -6
- package/docs/plugin-authoring.md +99 -0
- package/docs/plugin-hooks.md +89 -0
- package/docs/public/assets/adapter-sync-flow.svg +84 -0
- package/docs/public/assets/onboarding-flow.svg +79 -0
- package/docs/public/llms-full.txt +16 -3
- package/docs/public/llms.txt +13 -1
- package/docs/public/sitemap.xml +55 -0
- package/docs/quickstart.md +80 -26
- package/docs/repository-command-center.md +16 -0
- package/docs/tui-safety.md +59 -0
- package/docs/use-cases.md +21 -0
- package/docs/v2-roadmap.md +80 -88
- package/docs/workflow-orchestration.md +3 -0
- package/examples/adapter-sync/README.md +45 -0
- package/examples/command-center/README.md +59 -0
- package/examples/real-repo-onboarding/README.md +53 -0
- package/examples/safe-improvement-loop/README.md +48 -0
- package/package.json +1 -1
- package/scripts/install.ps1 +1 -1
- package/scripts/install.sh +1 -1
- package/scripts/verify.js +88 -0
package/docs/comparison.md
CHANGED
|
@@ -1,34 +1,81 @@
|
|
|
1
|
-
# Comparison Guide:
|
|
1
|
+
# Comparison Guide: MultiModel Dev OS vs. Alternatives
|
|
2
2
|
|
|
3
|
-
Selecting how to manage AI instructions inside a codebase
|
|
3
|
+
Selecting how to manage AI instructions inside a codebase impacts developer speed, token consumption, and context drift. This document contrasts `multimodel-dev-os` with common alternatives.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Quick Decision Matrix
|
|
6
8
|
|
|
7
|
-
| Feature | AGENTS.md Only (DIY) |
|
|
8
|
-
| :--- | :--- | :--- | :--- |
|
|
9
|
-
| **
|
|
10
|
-
| **Instruction
|
|
11
|
-
| **Token
|
|
12
|
-
| **Structural
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
9
|
+
| Feature | AGENTS.md Only (DIY) | .cursorrules / CLAUDE.md | Prompt Packs | **MultiModel Dev OS** |
|
|
10
|
+
| :--- | :--- | :--- | :--- | :--- |
|
|
11
|
+
| **Multi-tool support** | ❌ Manual duplication | ❌ Single tool only | ❌ Vendor-locked | ✅ **6+ tools from one source** |
|
|
12
|
+
| **Instruction sync** | ❌ Copy-paste drift | ❌ No sync possible | ❌ No sync | ✅ **Auto adapter sync** |
|
|
13
|
+
| **Token optimization** | ❌ Full rules every time | ❌ No budgeting | ❌ Static rules | ✅ **Caveman Mode (−79%)** |
|
|
14
|
+
| **Structural validation** | ❌ None | ❌ None | ❌ None | ✅ **validate + doctor + verify** |
|
|
15
|
+
| **Templates** | ❌ Start from scratch | ❌ Start from scratch | ⚠️ Generic starters | ✅ **6 production-ready templates** |
|
|
16
|
+
| **Memory & learning** | ❌ None | ❌ None | ❌ None | ✅ **Hash-compressed memory + feedback loops** |
|
|
17
|
+
| **CI/CD integration** | ❌ None | ❌ None | ❌ None | ✅ **214+ assertion verification suite** |
|
|
18
|
+
| **Onboarding existing repos** | ❌ Manual setup | ❌ Manual setup | ❌ Manual setup | ✅ **`onboard analyze` workflow** |
|
|
19
|
+
| **Interactive TUI Dashboard** | ❌ None | ❌ None | ❌ None | ✅ **Zero-dependency TUI Menu** |
|
|
20
|
+
| **Declarative Plugins** | ❌ None | ❌ None | ❌ None | ✅ **Safe whitelist YAML plugins** |
|
|
21
|
+
| **Cost** | Free | Free | Free–Paid | ✅ **Free & open source** |
|
|
16
22
|
|
|
17
23
|
---
|
|
18
24
|
|
|
19
|
-
## Detailed
|
|
25
|
+
## Detailed Comparison
|
|
26
|
+
|
|
27
|
+
### 1. The DIY Approach (Single AGENTS.md)
|
|
28
|
+
|
|
29
|
+
Many developers start by dropping a single `AGENTS.md` in their project root. This is better than nothing, but it breaks down fast:
|
|
30
|
+
|
|
31
|
+
- **Drift:** You update a build command in `AGENTS.md`, but forget to update Cursor's `.cursorrules`. Cursor keeps running the old build script.
|
|
32
|
+
- **Clutter:** The file bloats with styling rules, deployment procedures, and troubleshooting steps. The AI spends 10,000+ tokens reading instructions every turn.
|
|
33
|
+
- **No validation:** There's no way to check if your instructions are well-formed or complete.
|
|
34
|
+
|
|
35
|
+
### 2. Tool-Specific Rules (`.cursorrules`, `CLAUDE.md`, etc.)
|
|
36
|
+
|
|
37
|
+
Each tool has its own configuration format. Using only one locks you into that vendor:
|
|
38
|
+
|
|
39
|
+
- **No portability:** If your team uses Cursor for coding and Claude Code for debugging, you must manually translate and duplicate rules for both.
|
|
40
|
+
- **No collaboration:** Co-workers using different IDEs or agents can't benefit from the same context.
|
|
41
|
+
- **No onboarding:** New team members must discover and configure each tool manually.
|
|
42
|
+
|
|
43
|
+
### 3. Community Prompt Packs
|
|
20
44
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
- **
|
|
24
|
-
- **
|
|
45
|
+
Various community projects offer pre-built instruction sets for specific tools:
|
|
46
|
+
|
|
47
|
+
- **Vendor lock:** Prompt packs are built for one tool — switching means starting over.
|
|
48
|
+
- **Generic rules:** Community packs optimize for broad use, not your specific project architecture.
|
|
49
|
+
- **No intelligence:** No memory, no feedback loops, no self-improvement capabilities.
|
|
50
|
+
|
|
51
|
+
### 4. MultiModel Dev OS
|
|
52
|
+
|
|
53
|
+
`multimodel-dev-os` creates a lightweight, vendor-neutral layer that decouples your project's rules from specific tools:
|
|
54
|
+
|
|
55
|
+
- **Write once, read everywhere:** Define build parameters once in `AGENTS.md`. Adapters expose these configurations cleanly to Cursor, Claude, Antigravity, VS Code, Codex, and more.
|
|
56
|
+
- **Continuous integration:** Add `multimodel-dev-os verify` to your CI pipeline or pre-commit hooks to guarantee all developers share healthy, correctly-formatted AI configurations.
|
|
57
|
+
- **Self-improving:** The feedback loop compiles developer corrections into reusable rules. The proposal engine suggests codebase improvements with strict safety gates.
|
|
58
|
+
- **Instant onboarding:** The `onboard analyze` command scans existing projects and recommends the optimal template and adapter configuration.
|
|
59
|
+
|
|
60
|
+
### 5. Agentic CLIs & Extensions (Aider, Roo Code, Continue, Cline)
|
|
61
|
+
|
|
62
|
+
While advanced AI coding assistants like **Aider**, **Roo Code (Cline)**, and **Continue** provide powerful code generation and agentic capabilities, they serve a different layer of the stack than MultiModel Dev OS:
|
|
63
|
+
|
|
64
|
+
- **Complementary, Not Competitive:** MultiModel Dev OS is not a chatbot or code generator. It is a **configuration and governance layer**. It formats and syncs workspace context so that tools like Aider, Roo Code, and Continue can read the exact same project boundaries.
|
|
65
|
+
- **Rules Portability:** Roo Code or Continue read custom instructions, but they are stored in tool-specific config formats. If you switch to Aider in the CLI, you have to recreate those instructions. MultiModel Dev OS bridges this gap by auto-generating target configurations from `AGENTS.md`.
|
|
66
|
+
- **Quality Gates & Backups:** MultiModel Dev OS provides built-in `validate`, `doctor`, and `onboard` commands, plus structured proposal safety gates. This prevents external agents from making unchecked, destructive changes directly to your main branch.
|
|
67
|
+
|
|
68
|
+
---
|
|
25
69
|
|
|
26
|
-
|
|
27
|
-
Using tools like `Cursorrules` websites or Claude Code presets locks your project configuration into one vendor's ecosystem:
|
|
28
|
-
- **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.
|
|
29
|
-
- **No Collaboration:** Co-workers using different IDEs or terminal utilities cannot benefit from the unified context.
|
|
70
|
+
## When to Use What
|
|
30
71
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
72
|
+
```
|
|
73
|
+
Do you use only one AI coding tool?
|
|
74
|
+
├── Yes → Tool-specific rules (e.g., .cursorrules) might be enough
|
|
75
|
+
│ But consider MMDO if you want templates, validation, or memory
|
|
76
|
+
│
|
|
77
|
+
└── No → Do you switch between 2+ tools?
|
|
78
|
+
├── Yes → MultiModel Dev OS is built for this
|
|
79
|
+
└── Maybe later → Start with MMDO anyway — it's backward-compatible
|
|
80
|
+
and takes 30 seconds to set up
|
|
81
|
+
```
|
package/docs/compatibility.md
CHANGED
|
@@ -39,8 +39,8 @@ To guarantee validation compliance:
|
|
|
39
39
|
|
|
40
40
|
---
|
|
41
41
|
|
|
42
|
-
## 4.
|
|
42
|
+
## 4. Compatibility Guarantee
|
|
43
43
|
|
|
44
|
-
The supported tool matrix and custom specifications listed here represent the officially frozen contracts of MultiModel Dev OS `v1.
|
|
44
|
+
The supported tool matrix and custom specifications listed here represent the officially frozen contracts of MultiModel Dev OS. The core Layer 1 protocol has been stable since `v1.0.0` and all subsequent `v1.x` and `v2.x` releases maintain full backward compatibility.
|
|
45
45
|
|
|
46
46
|
Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Interactive TUI Dashboard
|
|
2
|
+
|
|
3
|
+
MultiModel Dev OS provides an interactive, terminal-based command center to manage all repository operations, adapter syncs, memory builds, proposals, and diagnostics from a single interface.
|
|
4
|
+
|
|
5
|
+
## Launching the Dashboard
|
|
6
|
+
|
|
7
|
+
Run either of the following commands to launch the TUI:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx multimodel-dev-os@latest dashboard
|
|
11
|
+
# or the short alias
|
|
12
|
+
npx multimodel-dev-os@latest ui
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Controls
|
|
18
|
+
|
|
19
|
+
The dashboard is built using Node.js's native `readline` module. It does not load external UI frameworks or npm prompt dependencies, keeping the execution extremely fast and light.
|
|
20
|
+
|
|
21
|
+
* **Up / Down Arrows**: Navigate through the menu options.
|
|
22
|
+
* **Return (Enter)**: Select and run the highlighted command or enter a submenu.
|
|
23
|
+
* **Escape / Ctrl+C**: Exit the dashboard or return to the shell.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Dashboard Structure
|
|
28
|
+
|
|
29
|
+
The dashboard contains a hierarchical structure mapping to all MMDO CLI actions:
|
|
30
|
+
|
|
31
|
+
```mermaid
|
|
32
|
+
graph TD
|
|
33
|
+
Dashboard[TUI Command Center]
|
|
34
|
+
Dashboard --> Status[Active Workspace Status]
|
|
35
|
+
Dashboard --> Scan[Codebase Scan Analysis]
|
|
36
|
+
Dashboard --> Onboard[Onboarding Operations...]
|
|
37
|
+
Dashboard --> Adapter[Adapter Synchronization...]
|
|
38
|
+
Dashboard --> Memory[Memory & Intelligence...]
|
|
39
|
+
Dashboard --> Feedback[Developer Feedback Loops...]
|
|
40
|
+
Dashboard --> Quality[Quality Gates & Diagnostics...]
|
|
41
|
+
Dashboard --> Plugins[Plugins Status Overview]
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Main Sections
|
|
45
|
+
|
|
46
|
+
1. **Active Workspace Status**: Runs the equivalent of `status` to print the current state of packages, active workspace structure, and recommendations.
|
|
47
|
+
2. **Codebase Scan Analysis**: Runs the equivalent of `scan` to analyze framework signals and potential token sink risks.
|
|
48
|
+
3. **Onboarding Operations**:
|
|
49
|
+
* Analyze Repository (`onboard analyze`)
|
|
50
|
+
* Recommendation Summary (`onboard recommend`)
|
|
51
|
+
* Generate Integration Plan (`onboard plan`)
|
|
52
|
+
* Apply Configs in Dry Run (`onboard apply --dry-run`)
|
|
53
|
+
* View Status Heuristics (`onboard status`)
|
|
54
|
+
4. **Adapter Synchronization**:
|
|
55
|
+
* Check Sync Status (`adapter status`)
|
|
56
|
+
* Sync All rule files in Dry Run (`adapter sync all --dry-run`)
|
|
57
|
+
* Diff Cursor Rules (`adapter diff cursor`)
|
|
58
|
+
* Diff Claude Rules (`adapter diff claude`)
|
|
59
|
+
5. **Memory & Intelligence**:
|
|
60
|
+
* Memory Build Index (`memory build`)
|
|
61
|
+
* Memory Refresh Changes (`memory refresh`)
|
|
62
|
+
* Memory Diff Index (`memory diff`)
|
|
63
|
+
* Handoff Build Session Summary (`handoff build`)
|
|
64
|
+
* Print Session Summary to Console (`handoff show`)
|
|
65
|
+
6. **Developer Feedback Loops & Proposals**:
|
|
66
|
+
* List developer corrections (`feedback list`)
|
|
67
|
+
* Summarize feedback logs (`feedback summarize`)
|
|
68
|
+
* Propose improvement proposal (`improve propose`)
|
|
69
|
+
* Review active proposals list (`improve review`)
|
|
70
|
+
7. **Quality Gates & Diagnostics**:
|
|
71
|
+
* Run Advisory Diagnostics (`doctor`)
|
|
72
|
+
* Strict Schema Compliance (`validate`)
|
|
73
|
+
* Run Release verification tests (`verify`)
|
|
74
|
+
8. **Plugins Status Overview**: Checks the status of all installed declarative plugins (`plugin status`).
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Zero-Hanging CI Fallback (Non-Interactive Mode)
|
|
79
|
+
|
|
80
|
+
In automated environments (CI/CD pipelines, GitHub Actions) or when piped, the terminal does not have interactive stdin capabilities.
|
|
81
|
+
|
|
82
|
+
To prevent execution from hanging indefinitely, the TUI automatically detects non-TTY environments:
|
|
83
|
+
* **Interactive Mode**: Triggered when both `process.stdout.isTTY` and `process.stdin.isTTY` are true.
|
|
84
|
+
* **Headless Fallback**: Triggered when run in non-interactive shells, or if `--dry-run` or `--list-actions` is passed. The dashboard immediately prints a structured, grouped list of all menu options along with their corresponding CLI execution strings (including active target flags) and exits cleanly.
|
|
85
|
+
|
|
86
|
+
Example headless output:
|
|
87
|
+
|
|
88
|
+
```txt
|
|
89
|
+
📊 MultiModel Dev OS Command Center (Headless/CI Preview)
|
|
90
|
+
Target Workspace: /workspace
|
|
91
|
+
==================================================
|
|
92
|
+
• Active Workspace Status → npx multimodel-dev-os status
|
|
93
|
+
• Codebase Scan Analysis → npx multimodel-dev-os scan
|
|
94
|
+
|
|
95
|
+
[Onboarding Operations]
|
|
96
|
+
└─ Onboard: Analyze Repository → npx multimodel-dev-os onboard analyze
|
|
97
|
+
└─ Onboard: Recommendation Summary → npx multimodel-dev-os onboard recommend
|
|
98
|
+
...
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Safety Controls
|
|
104
|
+
|
|
105
|
+
1. **No Destructive Operations**: Subcommands that modify files (such as `adapter sync`, `onboard apply`, or `improve apply`) are run in **dry-run** mode by default inside the dashboard menu.
|
|
106
|
+
2. **Bold Command Printing**: Before executing any command from the menu, the dashboard prints the exact command it is running (e.g. `npx multimodel-dev-os memory build`). This ensures that developers can learn the underlying CLI commands and transition to direct CLI operations when scripting.
|
|
107
|
+
3. **Subprocess Isolation**: When running subprocess actions, the TUI temporarily detaches keyboard listeners and raw mode, allowing the command to render its output and handle prompts cleanly before restoring TUI control.
|
package/docs/demo.md
CHANGED
|
@@ -1,79 +1,42 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Guided Demo Workflows
|
|
2
2
|
|
|
3
|
-
Experience
|
|
3
|
+
Experience MultiModel Dev OS in action. We provide structured, interactive demo workflows that you can copy-paste and run in under 2 minutes.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Interactive Mockup
|
|
8
8
|
|
|
9
|
-
Here is
|
|
9
|
+
Here is the automatic onboarding, scaffolding, and sync pipeline in action:
|
|
10
10
|
|
|
11
11
|

|
|
12
12
|
|
|
13
13
|
---
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## 5 Guided Workflows
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Select a workflow to get started:
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
# Scaffold a specific technology stack template and set up adapter status automatically
|
|
28
|
-
npx multimodel-dev-os@latest init --template nextjs-saas --adapter cursor --adapter claude
|
|
29
|
-
|
|
30
|
-
# Run a dry-run preview to verify planned file actions without modifying the disk
|
|
31
|
-
npx multimodel-dev-os@latest init --dry-run
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
#### Core Scaffolding Activities:
|
|
35
|
-
- **Directory Guarantee:** Assures target paths (`.ai/context`, `.ai/skills`, `.ai/session-logs`) exist.
|
|
36
|
-
- **Contract Scaffold:** Creates the root source-of-truth instructions (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`).
|
|
37
|
-
- **Adapter Linking:** Translates and copies rule files (like `.cursorrules`, `CLAUDE.md`, or `.vscode/`) directly to your workspace root.
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
### 2. The `templates` Gallery Inspector
|
|
42
|
-
|
|
43
|
-
Allows developers to view, inspect, and choose real-world configuration templates.
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
# List all pre-configured stack templates
|
|
47
|
-
npx multimodel-dev-os templates
|
|
48
|
-
|
|
49
|
-
# Display detailed configuration rules and files of a specific template
|
|
50
|
-
npx multimodel-dev-os show-template nextjs-saas
|
|
51
|
-
```
|
|
19
|
+
| Workflow Demo | Description | Duration |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| 🚀 **[Safe Repo Onboarding](/demos/existing-repo-onboarding)** | Safely analyze and bootstrap a real, existing project. | ~2 mins |
|
|
22
|
+
| 🔄 **[Universal Adapter Sync](/demos/adapter-sync)** | Write rules once in `AGENTS.md` and sync Cursor, Claude, and Gemini. | ~1 min |
|
|
23
|
+
| 🤝 **[Multi-Agent Handoff](/demos/multi-agent-handoff)** | Seamlessly pass session context between terminal and editor agents. | ~2 mins |
|
|
24
|
+
| 🔁 **[Safe Improvement Loop](/demos/safe-improvement-loop)** | Capture user feedback, propose upgrades, and apply with safety gates. | ~3 mins |
|
|
25
|
+
| 🩺 **[Release Verification](/demos/release-check)** | Run pre-flight checks and verify version alignment before npm publishing. | ~1 min |
|
|
52
26
|
|
|
53
27
|
---
|
|
54
28
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
Enforce strict formatting conventions inside your repository before checking in code:
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
# Strict directory schema and file validation checkup
|
|
61
|
-
npx multimodel-dev-os validate
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
If any core agent file (`AGENTS.md`, `MEMORY.md`) is missing or is structurally invalid, the CLI exits with non-zero exit codes to fail pull requests or pre-commit hooks, guarding workspace health.
|
|
65
|
-
|
|
66
|
-
---
|
|
29
|
+
## Under the Hood: Core CLI Commands
|
|
67
30
|
|
|
68
|
-
|
|
31
|
+
MultiModel Dev OS is a zero-dependency CLI. Here are the main commands that power these workflows:
|
|
69
32
|
|
|
70
|
-
|
|
33
|
+
### 1. Scaffolding & Setup
|
|
34
|
+
- `init`: Bootstraps shared workspace contract files and enables target adapters.
|
|
35
|
+
- `onboard analyze`: Safely scans an existing repository to suggest the best template fit.
|
|
71
36
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
37
|
+
### 2. Synchronization & Verification
|
|
38
|
+
- `adapter sync`: Pushes rules in `AGENTS.md` out to `.cursorrules`, `CLAUDE.md`, `.gemini/settings`, and more.
|
|
39
|
+
- `validate`: Enforces structural compliance, perfect for pre-commit hooks and CI.
|
|
40
|
+
- `doctor`: Audits `.gitignore` hygiene and active adapter status.
|
|
76
41
|
|
|
77
|
-
|
|
78
|
-
- IDE cache directories (like `node_modules` or `.vitepress/dist`) are not listed in your `.gitignore` file.
|
|
79
|
-
- Enabled adapter configurations inside `.ai/config.yaml` lack corresponding physical rule files on the disk.
|
|
42
|
+
For the full CLI command reference, see the **[CLI Documentation](/CLI)**.
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# Demo: Adapter Sync
|
|
2
|
+
|
|
3
|
+
> **Who**: Developers using 2+ AI coding tools who want rules synced automatically.
|
|
4
|
+
> **Time**: ~1 minute | **Prerequisites**: Node.js 18+, a MultiModel Dev OS workspace (run `init` first)
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Starting State
|
|
9
|
+
|
|
10
|
+
You have a project with MultiModel Dev OS initialized. Your `AGENTS.md` has been customized with your project's build commands and coding conventions. Now you want those rules pushed to `.cursorrules`, `CLAUDE.md`, `.vscode/settings.json`, etc.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Workflow
|
|
15
|
+
|
|
16
|
+
### Step 1: Check adapter status
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx multimodel-dev-os@latest adapter status
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**Expected output**:
|
|
23
|
+
```
|
|
24
|
+
🔌 Adapter Status:
|
|
25
|
+
cursor: enabled → .cursorrules (missing from root)
|
|
26
|
+
claude: enabled → CLAUDE.md (missing from root)
|
|
27
|
+
vscode: enabled → .vscode/settings.json (missing from root)
|
|
28
|
+
gemini: disabled
|
|
29
|
+
antigravity: disabled
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Step 2: Preview differences
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx multimodel-dev-os@latest adapter diff cursor
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**What happens**: Shows the diff between the bundled adapter template and your current root file (if it exists). Read-only.
|
|
39
|
+
|
|
40
|
+
### Step 3: Sync all enabled adapters
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx multimodel-dev-os@latest adapter sync all --approved
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**What happens**: Copies rule files from `adapters/*/` to your project root. Existing files require `--force` to overwrite, and `.bak` backups are created automatically.
|
|
47
|
+
|
|
48
|
+
**Expected output**:
|
|
49
|
+
```
|
|
50
|
+
🔄 Syncing adapters...
|
|
51
|
+
CREATE .cursorrules
|
|
52
|
+
CREATE CLAUDE.md
|
|
53
|
+
CREATE .vscode/settings.json
|
|
54
|
+
✅ 3 adapters synced.
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Step 4: Verify
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npx multimodel-dev-os@latest validate
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## What Gets Created
|
|
66
|
+
|
|
67
|
+
| File | Source Adapter |
|
|
68
|
+
|------|--------------|
|
|
69
|
+
| `.cursorrules` | `adapters/cursor/.cursorrules` |
|
|
70
|
+
| `CLAUDE.md` | `adapters/claude/CLAUDE.md` |
|
|
71
|
+
| `.vscode/settings.json` | `adapters/vscode/.vscode/settings.json` |
|
|
72
|
+
| `.gemini/settings.json` | `adapters/antigravity/.gemini/settings.json` |
|
|
73
|
+
| `GEMINI.md` | `adapters/gemini/GEMINI.md` |
|
|
74
|
+
|
|
75
|
+
Only enabled adapters are synced.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Safety Notes
|
|
80
|
+
|
|
81
|
+
- **Step 1-2 are read-only** — no files are modified
|
|
82
|
+
- **Step 3 writes files** but never overwrites without `--force`
|
|
83
|
+
- All overwrites create `.bak` backup files
|
|
84
|
+
- Adapter enable/disable is controlled by `.ai/config.yaml`
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Cleanup
|
|
89
|
+
|
|
90
|
+
Remove synced adapter files:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
rm -f .cursorrules CLAUDE.md GEMINI.md
|
|
94
|
+
rm -rf .vscode/ .gemini/
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Next Steps
|
|
100
|
+
|
|
101
|
+
- **Edit your rules**: Customize `AGENTS.md` → re-run `adapter sync all --approved` to propagate
|
|
102
|
+
- **Build memory**: `npx multimodel-dev-os@latest memory build` → [Multi-Agent Handoff Demo](/demos/multi-agent-handoff)
|
|
103
|
+
- **Run health check**: `npx multimodel-dev-os@latest workflow run repo-health`
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# Demo: Existing Repo Onboarding
|
|
2
|
+
|
|
3
|
+
> **Who**: Developers with an existing codebase who want to add AI Dev OS configs without breaking anything.
|
|
4
|
+
> **Time**: ~2 minutes | **Prerequisites**: Node.js 18+, an existing project directory
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Starting State
|
|
9
|
+
|
|
10
|
+
You have a project directory with source code — for example a Next.js app, a Python API, or a WordPress site. No MultiModel Dev OS files exist yet.
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
cd /path/to/your-project
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Workflow
|
|
19
|
+
|
|
20
|
+
### Step 1: Analyze your project
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx multimodel-dev-os@latest onboard analyze
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**What happens**: Scans your directory for frameworks, languages, package managers, and existing AI config files. Read-only — no files are created or modified.
|
|
27
|
+
|
|
28
|
+
**Expected output**:
|
|
29
|
+
```
|
|
30
|
+
🔍 Analyzing repository: /path/to/your-project
|
|
31
|
+
Detected: package.json (Node.js)
|
|
32
|
+
Detected: next.config.js (Next.js)
|
|
33
|
+
Detected: tsconfig.json (TypeScript)
|
|
34
|
+
Frameworks: nextjs, typescript
|
|
35
|
+
Adapters found: none
|
|
36
|
+
Risk markers: 0
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Step 2: Get recommendations
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx multimodel-dev-os@latest onboard recommend
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**What happens**: Based on the analysis, recommends the best template and adapter configuration. Read-only.
|
|
46
|
+
|
|
47
|
+
**Expected output**:
|
|
48
|
+
```
|
|
49
|
+
📋 Recommendations for /path/to/your-project
|
|
50
|
+
Template: nextjs-saas (confidence: 85%)
|
|
51
|
+
Adapters: cursor, claude (detected IDE signals)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Step 3: Generate an onboarding plan
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npx multimodel-dev-os@latest onboard plan
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**What happens**: Creates a structured plan file at `.ai/intelligence/onboarding.plan.json` and a human-readable report at `.ai/intelligence/onboarding.report.md`. These are gitignored by default.
|
|
61
|
+
|
|
62
|
+
### Step 4: Apply the plan
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npx multimodel-dev-os@latest onboard apply --approved
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
**What happens**: Copies configuration templates to your project. Existing files are **never overwritten** unless you pass `--force`, and automatic `.bak` backups are created.
|
|
69
|
+
|
|
70
|
+
### Step 5: Check status
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
npx multimodel-dev-os@latest onboard status
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Expected output**:
|
|
77
|
+
```
|
|
78
|
+
📊 Onboarding Status: /path/to/your-project
|
|
79
|
+
Completeness: 100%
|
|
80
|
+
Root files: AGENTS.md ✓ MEMORY.md ✓ TASKS.md ✓ RUNBOOK.md ✓
|
|
81
|
+
Config: .ai/config.yaml ✓
|
|
82
|
+
Adapters: cursor ✓ claude ✓
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## What Gets Created
|
|
88
|
+
|
|
89
|
+
| File | Purpose |
|
|
90
|
+
|------|---------|
|
|
91
|
+
| `AGENTS.md` | Project instructions for all AI tools |
|
|
92
|
+
| `MEMORY.md` | Architectural decisions and milestones |
|
|
93
|
+
| `TASKS.md` | Active task backlog |
|
|
94
|
+
| `RUNBOOK.md` | Operational verification commands |
|
|
95
|
+
| `.ai/config.yaml` | Central configuration |
|
|
96
|
+
| `.ai/context/` | Project context files |
|
|
97
|
+
| `.ai/intelligence/onboarding.plan.json` | Onboarding plan (gitignored) |
|
|
98
|
+
| `.ai/intelligence/onboarding.report.md` | Human-readable report (gitignored) |
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Safety Notes
|
|
103
|
+
|
|
104
|
+
- **Steps 1-3 are fully read-only** — no files are written to your project
|
|
105
|
+
- **Step 4 writes files** but never overwrites existing files without `--force`
|
|
106
|
+
- All overwrites create `.bak` backup files automatically
|
|
107
|
+
- Plan and report files are placed under `.ai/intelligence/` which is gitignored
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## Cleanup
|
|
112
|
+
|
|
113
|
+
To remove all MultiModel Dev OS files from your project:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
rm -rf .ai/ AGENTS.md MEMORY.md TASKS.md RUNBOOK.md
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Next Steps
|
|
122
|
+
|
|
123
|
+
- **Sync IDE adapters**: `npx multimodel-dev-os@latest adapter sync all --approved` → [Adapter Sync Demo](/demos/adapter-sync)
|
|
124
|
+
- **Build memory index**: `npx multimodel-dev-os@latest memory build`
|
|
125
|
+
- **Run workspace health check**: `npx multimodel-dev-os@latest workflow run repo-health`
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Demo Workflows
|
|
2
|
+
|
|
3
|
+
Hands-on, copy-paste workflows that show MultiModel Dev OS in action. Each demo takes **under 2 minutes** and requires only `npx` — no global install, no dependencies.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Choose a Demo
|
|
8
|
+
|
|
9
|
+
<div class="demo-grid">
|
|
10
|
+
<a href="/demos/existing-repo-onboarding" class="demo-card">
|
|
11
|
+
<div class="demo-icon">📁</div>
|
|
12
|
+
<div class="demo-title">Existing Repo Onboarding</div>
|
|
13
|
+
<div class="demo-desc">Analyze a real project, get template recommendations, and safely bootstrap AI Dev OS configs.</div>
|
|
14
|
+
<div class="demo-time">~2 min</div>
|
|
15
|
+
</a>
|
|
16
|
+
<a href="/demos/adapter-sync" class="demo-card">
|
|
17
|
+
<div class="demo-icon">🔄</div>
|
|
18
|
+
<div class="demo-title">Adapter Sync</div>
|
|
19
|
+
<div class="demo-desc">Mirror rule files across Cursor, Claude, VS Code, and Gemini automatically.</div>
|
|
20
|
+
<div class="demo-time">~1 min</div>
|
|
21
|
+
</a>
|
|
22
|
+
<a href="/demos/safe-improvement-loop" class="demo-card">
|
|
23
|
+
<div class="demo-icon">🧠</div>
|
|
24
|
+
<div class="demo-title">Safe Improvement Loop</div>
|
|
25
|
+
<div class="demo-desc">Capture feedback, propose improvements, validate safety, and apply changes with audit trails.</div>
|
|
26
|
+
<div class="demo-time">~2 min</div>
|
|
27
|
+
</a>
|
|
28
|
+
<a href="/demos/multi-agent-handoff" class="demo-card">
|
|
29
|
+
<div class="demo-icon">🤝</div>
|
|
30
|
+
<div class="demo-title">Multi-Agent Handoff</div>
|
|
31
|
+
<div class="demo-desc">Compile token-compressed session context and hand off state between agents or models.</div>
|
|
32
|
+
<div class="demo-time">~1 min</div>
|
|
33
|
+
</a>
|
|
34
|
+
<a href="/demos/release-check" class="demo-card">
|
|
35
|
+
<div class="demo-icon">🚀</div>
|
|
36
|
+
<div class="demo-title">Release Check</div>
|
|
37
|
+
<div class="demo-desc">Run the full pre-flight verification suite, doctor audit, and package hygiene check.</div>
|
|
38
|
+
<div class="demo-time">~1 min</div>
|
|
39
|
+
</a>
|
|
40
|
+
</div>
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Prerequisites
|
|
45
|
+
|
|
46
|
+
All demos require:
|
|
47
|
+
- **Node.js 18+** installed
|
|
48
|
+
- A terminal (bash, zsh, PowerShell, or cmd)
|
|
49
|
+
- An existing project directory (or create a temp one)
|
|
50
|
+
|
|
51
|
+
No global install needed — every command uses `npx multimodel-dev-os@latest`.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Demo Philosophy
|
|
56
|
+
|
|
57
|
+
Every demo follows the same structure:
|
|
58
|
+
|
|
59
|
+
1. **Starting State** — what you need before running
|
|
60
|
+
2. **Workflow** — step-by-step commands with expected output
|
|
61
|
+
3. **What Gets Created** — files and directories produced
|
|
62
|
+
4. **Safety Notes** — what is read-only vs. what writes
|
|
63
|
+
5. **Cleanup** — how to undo
|
|
64
|
+
6. **Next Steps** — where to go after
|
|
65
|
+
|
|
66
|
+
<style>
|
|
67
|
+
.demo-grid {
|
|
68
|
+
display: grid;
|
|
69
|
+
grid-template-columns: repeat(auto-fit, minmax(260px, 1fr));
|
|
70
|
+
gap: 1.25rem;
|
|
71
|
+
margin: 2rem 0;
|
|
72
|
+
}
|
|
73
|
+
.demo-card {
|
|
74
|
+
border: 1px solid var(--vp-c-bg-mute);
|
|
75
|
+
background: var(--vp-c-bg-soft);
|
|
76
|
+
border-radius: 10px;
|
|
77
|
+
padding: 1.5rem;
|
|
78
|
+
text-decoration: none !important;
|
|
79
|
+
color: inherit !important;
|
|
80
|
+
transition: border-color 0.25s, transform 0.25s;
|
|
81
|
+
display: block;
|
|
82
|
+
}
|
|
83
|
+
.demo-card:hover {
|
|
84
|
+
border-color: var(--vp-c-brand-1);
|
|
85
|
+
transform: translateY(-3px);
|
|
86
|
+
}
|
|
87
|
+
.demo-icon { font-size: 2rem; margin-bottom: 0.5rem; }
|
|
88
|
+
.demo-title { font-weight: 700; font-size: 1.1rem; margin-bottom: 0.4rem; }
|
|
89
|
+
.demo-desc { font-size: 0.9rem; color: var(--vp-c-text-2); margin-bottom: 0.5rem; }
|
|
90
|
+
.demo-time { font-size: 0.8rem; color: var(--vp-c-brand-1); font-weight: 600; }
|
|
91
|
+
</style>
|