multimodel-dev-os 2.0.1 → 2.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ai/intelligence/README.md +14 -0
- package/.ai/intelligence/apply-log.schema.json +65 -0
- package/.ai/intelligence/feedback-log.example.jsonl +2 -0
- package/.ai/intelligence/feedback.schema.json +47 -0
- package/.ai/intelligence/improvement-proposal.schema.json +70 -0
- package/.ai/intelligence/learning-rules.example.md +18 -0
- package/.ai/intelligence/memory.schema.json +97 -0
- package/.ai/plugins/README.md +30 -0
- package/.ai/plugins/plugin.example.yaml +32 -0
- package/.ai/policies/approval-gates.md +35 -0
- package/.ai/policies/memory-policy.md +30 -0
- package/.ai/policies/self-improvement-policy.md +39 -0
- package/.ai/proposals/README.md +44 -0
- package/.ai/proposals/apply-operation.example.json +22 -0
- package/.ai/registries/capabilities.yaml +73 -0
- package/.ai/registries/tools.yaml +84 -0
- package/.ai/registries/workflows.yaml +217 -0
- package/.ai/schema/plugin.schema.json +56 -0
- package/README.md +116 -138
- 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 +3472 -7
- package/docs/.vitepress/config.js +46 -7
- package/docs/5-day-roadmap.md +9 -9
- package/docs/CLI.md +260 -34
- package/docs/adapter-sync.md +27 -0
- package/docs/adapters.md +16 -0
- package/docs/agent-handoff.md +40 -0
- package/docs/approved-proposal-apply.md +156 -0
- package/docs/architecture.md +31 -7
- package/docs/capability-registry.md +24 -0
- package/docs/comparison.md +72 -25
- package/docs/compatibility.md +2 -2
- package/docs/dashboard.md +105 -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/feedback-learning.md +33 -0
- package/docs/future-proof-architecture.md +22 -0
- package/docs/hash-compressed-memory.md +72 -0
- package/docs/improvement-proposals.md +70 -0
- package/docs/index.md +192 -81
- package/docs/installers.md +18 -4
- package/docs/launch-kit.md +97 -49
- package/docs/learning-rules.md +36 -0
- package/docs/npm-publishing.md +6 -6
- package/docs/plugin-authoring.md +99 -0
- package/docs/plugin-hooks.md +80 -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 +47 -4
- package/docs/public/llms.txt +55 -2
- package/docs/public/sitemap.xml +85 -0
- package/docs/quickstart.md +82 -22
- package/docs/real-repo-onboarding.md +27 -0
- package/docs/repository-command-center.md +68 -0
- package/docs/self-improving-codebase.md +46 -0
- package/docs/template-recommendation.md +22 -0
- package/docs/templates-guide.md +11 -0
- package/docs/tool-registry.md +21 -0
- package/docs/tui-safety.md +59 -0
- package/docs/use-cases.md +21 -0
- package/docs/v2-roadmap.md +78 -71
- package/docs/workflow-orchestration.md +62 -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 +107 -3
|
@@ -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>
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# Demo: Multi-Agent Handoff
|
|
2
|
+
|
|
3
|
+
> **Who**: Developers switching between AI models (e.g., Claude → Gemini → Cursor) mid-session.
|
|
4
|
+
> **Time**: ~1 minute | **Prerequisites**: Node.js 18+, a MultiModel Dev OS workspace with some history
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Starting State
|
|
9
|
+
|
|
10
|
+
You've been coding with Claude Code for an hour. You want to switch to Gemini for an audit pass, but you don't want to lose the session context.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Workflow
|
|
15
|
+
|
|
16
|
+
### Step 1: Build the memory index
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx multimodel-dev-os@latest memory build
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**What happens**: Scans your codebase and writes a hash-compressed index to `.ai/intelligence/memory.hash.json` and a human-readable summary to `.ai/intelligence/memory.summary.md`. Both are gitignored.
|
|
23
|
+
|
|
24
|
+
### Step 2: Compile the handoff spec
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx multimodel-dev-os@latest handoff build
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
**What happens**: Compiles a token-compressed session context document at `.ai/intelligence/handoff.md`. This includes:
|
|
31
|
+
- Project structure summary
|
|
32
|
+
- Active tasks from `TASKS.md`
|
|
33
|
+
- Recent memory state
|
|
34
|
+
- Feedback log highlights
|
|
35
|
+
- Proposal status
|
|
36
|
+
|
|
37
|
+
### Step 3: View the handoff
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx multimodel-dev-os@latest handoff show
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Expected output**: Prints the handoff document to stdout — ready to paste into your next agent session.
|
|
44
|
+
|
|
45
|
+
### Step 4: Check workspace status
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npx multimodel-dev-os@latest status
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**What happens**: Shows a compact dashboard of package details, framework signals, memory freshness, feedback counts, proposal states, and audit metrics.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## What Gets Created
|
|
56
|
+
|
|
57
|
+
| File | Purpose | Gitignored? |
|
|
58
|
+
|------|---------|-------------|
|
|
59
|
+
| `.ai/intelligence/memory.hash.json` | Hash-compressed file index | ✅ |
|
|
60
|
+
| `.ai/intelligence/memory.summary.md` | Human-readable memory summary | ✅ |
|
|
61
|
+
| `.ai/intelligence/handoff.md` | Token-compressed session context | ✅ |
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Safety Notes
|
|
66
|
+
|
|
67
|
+
- **All commands are read-only** except `memory build` and `handoff build` which write to gitignored `.ai/intelligence/` paths
|
|
68
|
+
- No project source files are modified
|
|
69
|
+
- Handoff documents are designed to be ephemeral — rebuild before each agent switch
|
|
70
|
+
- Secret-safety exclusions automatically skip `.env`, `.npmrc`, `.keystore` files
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Cleanup
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
rm -f .ai/intelligence/memory.hash.json
|
|
78
|
+
rm -f .ai/intelligence/memory.summary.md
|
|
79
|
+
rm -f .ai/intelligence/handoff.md
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Next Steps
|
|
85
|
+
|
|
86
|
+
- **Paste handoff into your next agent** — copy the output of `handoff show` into Claude, Gemini, or Cursor
|
|
87
|
+
- **Run a health workflow**: `npx multimodel-dev-os@latest workflow run repo-health`
|
|
88
|
+
- **Refresh after more work**: `npx multimodel-dev-os@latest memory refresh`
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Demo: Release Check
|
|
2
|
+
|
|
3
|
+
> **Who**: Maintainers preparing a release or contributors validating their PR.
|
|
4
|
+
> **Time**: ~1 minute | **Prerequisites**: Node.js 18+, a MultiModel Dev OS workspace
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Starting State
|
|
9
|
+
|
|
10
|
+
You've made changes to your MultiModel Dev OS workspace and want to verify everything is healthy before committing or publishing.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Workflow
|
|
15
|
+
|
|
16
|
+
### Step 1: Run the verification suite
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx multimodel-dev-os@latest verify
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**What happens**: Runs 214+ structural assertions checking:
|
|
23
|
+
- All required files exist (root contracts, adapters, templates, schemas, docs)
|
|
24
|
+
- YAML registries parse correctly with expected root keys
|
|
25
|
+
- Package.json version matches CLI output
|
|
26
|
+
- npm pack dry-run reports correct version
|
|
27
|
+
- No runtime files (memory, feedback, proposals) are committed
|
|
28
|
+
|
|
29
|
+
**Expected output**:
|
|
30
|
+
```
|
|
31
|
+
✓ AGENTS.md
|
|
32
|
+
✓ MEMORY.md
|
|
33
|
+
...
|
|
34
|
+
✓ package.json version is valid: 2.7.0
|
|
35
|
+
✓ CLI help displays v2.7.0
|
|
36
|
+
✓ npm pack --dry-run reports version 2.7.0
|
|
37
|
+
✓ No runtime proposals committed
|
|
38
|
+
|
|
39
|
+
Pass: 213 Fail: 0 Warn: 0 Total: 213
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Step 2: Run the release doctor
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npx multimodel-dev-os@latest doctor --release
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**What happens**: Checks version alignment across `package.json`, `install.sh`, and `install.ps1`. Warns about blacklisted files (like `.npmrc`) in the package root.
|
|
49
|
+
|
|
50
|
+
**Expected output**:
|
|
51
|
+
```
|
|
52
|
+
🩺 Running release audit doctor
|
|
53
|
+
✓ package.json version: 2.7.0
|
|
54
|
+
✓ scripts/install.sh version aligns: 2.7.0
|
|
55
|
+
✓ scripts/install.ps1 version aligns: 2.7.0
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Step 3: Build the docs
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npm run docs:build
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**What happens**: Compiles the VitePress documentation site. Catches broken links, missing assets, and template errors.
|
|
65
|
+
|
|
66
|
+
### Step 4: Dry-run the npm package
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npm pack --dry-run
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**What happens**: Shows exactly what files would be included in the npm tarball without actually creating it. Verify no secrets, caches, or development artifacts are included.
|
|
73
|
+
|
|
74
|
+
### Step 5: Test CLI commands
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npx multimodel-dev-os@latest --help
|
|
78
|
+
npx multimodel-dev-os@latest doctor --onboarding
|
|
79
|
+
npx multimodel-dev-os@latest doctor --intelligence
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## What Gets Created
|
|
85
|
+
|
|
86
|
+
Nothing — all commands in this demo are read-only diagnostic checks.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Safety Notes
|
|
91
|
+
|
|
92
|
+
- **Every command is read-only** — no files are created, modified, or deleted
|
|
93
|
+
- The verification suite has a non-zero exit code on failure, making it CI-compatible
|
|
94
|
+
- `npm pack --dry-run` does not create a tarball file
|
|
95
|
+
- `docs:build` outputs to `docs/.vitepress/dist/` which is gitignored
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Cleanup
|
|
100
|
+
|
|
101
|
+
No cleanup needed — this demo creates no files.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Next Steps
|
|
106
|
+
|
|
107
|
+
- **Commit your changes**: `git add . && git commit -m "your message"`
|
|
108
|
+
- **Create a release**: Follow the [Distribution Guide](/distribution)
|
|
109
|
+
- **Publish to npm**: Follow the [NPM Publishing Runbook](/npm-publishing)
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Demo: Safe Improvement Loop
|
|
2
|
+
|
|
3
|
+
> **Who**: Teams who want their AI agents to propose codebase improvements with human-in-the-loop safety.
|
|
4
|
+
> **Time**: ~2 minutes | **Prerequisites**: Node.js 18+, a MultiModel Dev OS workspace
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Starting State
|
|
9
|
+
|
|
10
|
+
You have a project with MultiModel Dev OS initialized and at least one coding session completed. You've noticed patterns you want the system to learn.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Workflow
|
|
15
|
+
|
|
16
|
+
### Step 1: Record developer feedback
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx multimodel-dev-os@latest feedback add "Always use TypeScript strict mode" --type preference
|
|
20
|
+
npx multimodel-dev-os@latest feedback add "Avoid Tailwind CSS in this project" --type override
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**What happens**: Logs feedback entries to `.ai/intelligence/feedback-log.jsonl` (gitignored). Each entry is timestamped and typed.
|
|
24
|
+
|
|
25
|
+
### Step 2: Compile feedback into learning rules
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx multimodel-dev-os@latest feedback summarize
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**What happens**: Reads all feedback entries and compiles them into `.ai/intelligence/learning-rules.md` — a human-readable file that AI agents can reference. Gitignored.
|
|
32
|
+
|
|
33
|
+
### Step 3: Propose an improvement
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npx multimodel-dev-os@latest improve propose --title "Add TypeScript strict config"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**What happens**: Creates a structured proposal file under `.ai/proposals/` with frontmatter, description, and optionally a deterministic operations JSON block.
|
|
40
|
+
|
|
41
|
+
### Step 4: Review proposals
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npx multimodel-dev-os@latest improve review
|
|
45
|
+
npx multimodel-dev-os@latest improve status
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**What happens**: Lists all proposals and their statuses (draft, approved, applied, refused). Read-only.
|
|
49
|
+
|
|
50
|
+
### Step 5: Validate safety gates
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npx multimodel-dev-os@latest improve validate .ai/proposals/proposal-XXXX.md
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**What happens**: Runs 12 safety gates including path boundary checks, protected path blocks, approval status, and operation type validation. Read-only.
|
|
57
|
+
|
|
58
|
+
### Step 6: Preview changes
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npx multimodel-dev-os@latest improve diff .ai/proposals/proposal-XXXX.md
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**What happens**: Shows a unified diff of what the proposal would change. No files are modified.
|
|
65
|
+
|
|
66
|
+
### Step 7: Apply the approved proposal
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx multimodel-dev-os@latest improve apply .ai/proposals/proposal-XXXX.md --approved
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**What happens**: Executes the deterministic operations (`create_file`, `append_line`, `replace_text`). Records execution in `.ai/proposals/apply-log.jsonl` with SHA-256 hashes.
|
|
73
|
+
|
|
74
|
+
### Step 8: Check the audit log
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npx multimodel-dev-os@latest improve log
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## What Gets Created
|
|
83
|
+
|
|
84
|
+
| File | Purpose | Gitignored? |
|
|
85
|
+
|------|---------|-------------|
|
|
86
|
+
| `.ai/intelligence/feedback-log.jsonl` | Raw feedback entries | ✅ |
|
|
87
|
+
| `.ai/intelligence/learning-rules.md` | Compiled learning rules | ✅ |
|
|
88
|
+
| `.ai/proposals/proposal-XXXX.md` | Improvement proposal | ❌ (reviewable) |
|
|
89
|
+
| `.ai/proposals/apply-log.jsonl` | Execution audit log | ✅ |
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Safety Notes
|
|
94
|
+
|
|
95
|
+
- **Steps 1-6 are non-destructive** — feedback logging, proposal drafting, review, and diff are all safe
|
|
96
|
+
- **Step 7 modifies files** but only through validated deterministic operations
|
|
97
|
+
- 12 safety gates must pass before any apply can execute
|
|
98
|
+
- Proposals require explicit `--approved` flag
|
|
99
|
+
- All applied changes are audited with pre/post SHA-256 file hashes
|
|
100
|
+
- Protected paths (`.git/`, `.env`, `node_modules/`, `apply-log.jsonl`) are blocked
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## Cleanup
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
# Remove feedback and proposals (gitignored files stay local)
|
|
108
|
+
rm -f .ai/intelligence/feedback-log.jsonl
|
|
109
|
+
rm -f .ai/intelligence/learning-rules.md
|
|
110
|
+
rm -rf .ai/proposals/
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Next Steps
|
|
116
|
+
|
|
117
|
+
- **Build memory index**: `npx multimodel-dev-os@latest memory build`
|
|
118
|
+
- **Run a workflow cycle**: `npx multimodel-dev-os@latest workflow run feedback-review`
|
|
119
|
+
- **Hand off to next agent**: [Multi-Agent Handoff Demo](/demos/multi-agent-handoff)
|