multimodel-dev-os 2.6.0 → 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/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 +601 -1
- 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 +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/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 +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 +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 +75 -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
|
@@ -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)
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
# Distribution & Release Guide
|
|
2
|
+
|
|
3
|
+
How to distribute, verify, and publish MultiModel Dev OS releases.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Installation Methods
|
|
8
|
+
|
|
9
|
+
### NPX (Recommended)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# Initialize a new workspace
|
|
13
|
+
npx multimodel-dev-os@latest init
|
|
14
|
+
|
|
15
|
+
# Onboard an existing project
|
|
16
|
+
npx multimodel-dev-os@latest onboard analyze
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Global Install
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install -g multimodel-dev-os
|
|
23
|
+
multimodel-dev-os init
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### Fallback Scripts
|
|
27
|
+
|
|
28
|
+
**macOS / Linux / WSL:**
|
|
29
|
+
```bash
|
|
30
|
+
curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/install.sh | bash
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**Windows (PowerShell):**
|
|
34
|
+
```powershell
|
|
35
|
+
irm https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scripts/install.ps1 | iex
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Pre-Release Checklist
|
|
41
|
+
|
|
42
|
+
Before every release, run this complete verification sequence:
|
|
43
|
+
|
|
44
|
+
### 1. Version Bump
|
|
45
|
+
|
|
46
|
+
Update version strings in all 7 locations:
|
|
47
|
+
|
|
48
|
+
| File | Field |
|
|
49
|
+
|------|-------|
|
|
50
|
+
| `package.json` | `version` |
|
|
51
|
+
| `package-lock.json` | `version` (2 occurrences) |
|
|
52
|
+
| `scripts/install.sh` | `VERSION` |
|
|
53
|
+
| `scripts/install.ps1` | `$Version` |
|
|
54
|
+
| `docs/.vitepress/config.js` | `softwareVersion` in JSON-LD |
|
|
55
|
+
| `docs/public/llms.txt` | Title version |
|
|
56
|
+
| `docs/public/llms-full.txt` | Title version |
|
|
57
|
+
|
|
58
|
+
### 2. Changelog Entry
|
|
59
|
+
|
|
60
|
+
Add a new section to `CHANGELOG.md` following the Keep a Changelog format.
|
|
61
|
+
|
|
62
|
+
### 3. Verification Suite
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# Run 214+ structural assertions
|
|
66
|
+
npm run verify
|
|
67
|
+
|
|
68
|
+
# Build docs to catch broken links
|
|
69
|
+
npm run docs:build
|
|
70
|
+
|
|
71
|
+
# Dry-run the npm package
|
|
72
|
+
npm pack --dry-run
|
|
73
|
+
|
|
74
|
+
# Verify CLI version
|
|
75
|
+
node bin/multimodel-dev-os.js --help
|
|
76
|
+
|
|
77
|
+
# Release doctor
|
|
78
|
+
node bin/multimodel-dev-os.js doctor --release
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**Expected results:**
|
|
82
|
+
- `verify`: 213+ pass, 0 fail, 1 expected .npmrc warning
|
|
83
|
+
- `docs:build`: builds without errors
|
|
84
|
+
- `pack --dry-run`: reports correct version in tarball name
|
|
85
|
+
- CLI `--help`: shows correct version
|
|
86
|
+
- `doctor --release`: version alignment passes
|
|
87
|
+
|
|
88
|
+
### 4. Commit
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
git add .
|
|
92
|
+
git diff --cached --stat
|
|
93
|
+
git commit -m "docs: release vX.Y.Z [description]"
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Publishing to npm
|
|
99
|
+
|
|
100
|
+
> [!WARNING]
|
|
101
|
+
> **Manual publish only.** The `prepublish-guard.js` script blocks accidental publishes. You must explicitly set the environment variable.
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# Set the publish guard
|
|
105
|
+
export MMDO_ALLOW_PUBLISH=true # bash
|
|
106
|
+
$env:MMDO_ALLOW_PUBLISH = "true" # PowerShell
|
|
107
|
+
|
|
108
|
+
# Publish to npm
|
|
109
|
+
npm publish --access public
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Post-Publish Smoke Test
|
|
113
|
+
|
|
114
|
+
After publishing, verify the package works correctly:
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
# Create a temp directory
|
|
118
|
+
mkdir /tmp/mmdo-smoke && cd /tmp/mmdo-smoke
|
|
119
|
+
|
|
120
|
+
# Test npx execution
|
|
121
|
+
npx multimodel-dev-os@latest --help
|
|
122
|
+
npx multimodel-dev-os@latest init --dry-run
|
|
123
|
+
|
|
124
|
+
# Verify version matches
|
|
125
|
+
npx multimodel-dev-os@latest doctor --release
|
|
126
|
+
|
|
127
|
+
# Cleanup
|
|
128
|
+
cd .. && rm -rf /tmp/mmdo-smoke
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Package Hygiene
|
|
134
|
+
|
|
135
|
+
### What's Included in the Tarball
|
|
136
|
+
|
|
137
|
+
The `files` field in `package.json` controls what ships:
|
|
138
|
+
|
|
139
|
+
```
|
|
140
|
+
AGENTS.md, MEMORY.md, TASKS.md, RUNBOOK.md
|
|
141
|
+
.ai/ → Configuration, schemas, registries, templates
|
|
142
|
+
adapters/ → IDE/tool adapter files
|
|
143
|
+
scripts/ → Install scripts, verify scripts
|
|
144
|
+
docs/ → Documentation source (excluding .vitepress/dist/ and cache/)
|
|
145
|
+
examples/ → Template examples
|
|
146
|
+
bin/ → CLI executable
|
|
147
|
+
assets/ → Visual assets
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### What's Excluded
|
|
151
|
+
|
|
152
|
+
- `node_modules/` — dev dependencies only
|
|
153
|
+
- `docs/.vitepress/dist/` — built docs (deployed separately via GitHub Pages)
|
|
154
|
+
- `docs/.vitepress/cache/` — build cache
|
|
155
|
+
- `.ai/intelligence/` runtime files — memory, feedback, proposals
|
|
156
|
+
- `.npmrc` — expected warning in verify suite
|
|
157
|
+
|
|
158
|
+
### The `.npmrc` Warning
|
|
159
|
+
|
|
160
|
+
The verify suite reports 1 expected warning about `.npmrc` existing in the package root. This file contains only the registry URL and no credentials. It's flagged as a security best practice reminder. This warning is intentional and does not block publishing.
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## GitHub Releases
|
|
165
|
+
|
|
166
|
+
After publishing to npm:
|
|
167
|
+
|
|
168
|
+
1. Tag the commit: `git tag vX.Y.Z`
|
|
169
|
+
2. Push tags: `git push origin main --tags`
|
|
170
|
+
3. Create a GitHub Release from the tag
|
|
171
|
+
4. Copy the changelog entry as the release body
|
|
172
|
+
5. Verify the GitHub Pages deployment triggered
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## Prepublish Guard
|
|
177
|
+
|
|
178
|
+
The [prepublish-guard.js](../scripts/prepublish-guard.js) script runs automatically before `npm publish`. It:
|
|
179
|
+
|
|
180
|
+
1. Checks for `MMDO_ALLOW_PUBLISH=true` environment variable
|
|
181
|
+
2. If not set, prints a warning and exits with code 1
|
|
182
|
+
3. Prevents accidental publishes from CI or local dev environments
|
|
183
|
+
|
|
184
|
+
This guard ensures every publish is an intentional, reviewed action.
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## Version Alignment
|
|
189
|
+
|
|
190
|
+
The `doctor --release` command verifies version parity across:
|
|
191
|
+
- `package.json`
|
|
192
|
+
- `scripts/install.sh`
|
|
193
|
+
- `scripts/install.ps1`
|
|
194
|
+
|
|
195
|
+
Any mismatch is reported as a warning. Fix alignment before publishing.
|
package/docs/faq.md
CHANGED
|
@@ -1,67 +1,134 @@
|
|
|
1
|
-
# FAQ
|
|
1
|
+
# FAQ
|
|
2
2
|
|
|
3
|
-
Frequently asked questions
|
|
4
|
-
|
|
5
|
-
> **Use when**: Resolving setup ambiguities, understanding comparative advantages over simple rules files, or auditing CLI validations.
|
|
3
|
+
Frequently asked questions about MultiModel Dev OS, AI coding agents compatibility, and prompt context optimization.
|
|
6
4
|
|
|
7
5
|
---
|
|
8
6
|
|
|
9
7
|
## General
|
|
10
8
|
|
|
11
9
|
**What is MultiModel Dev OS?**
|
|
12
|
-
A set of markdown templates and directory structures that allow multiple AI coding tools (Codex, Cursor, Claude Code, Gemini, Antigravity, VS Code) to share a single portable AI project context.
|
|
10
|
+
A set of markdown templates and directory structures that allow multiple AI coding tools (Codex, Cursor, Claude Code, Gemini, Antigravity, VS Code) to share a single portable AI project context. Think of it as `.editorconfig` but for AI assistants.
|
|
13
11
|
|
|
14
12
|
**Is this a runtime operating system?**
|
|
15
|
-
No. It is a
|
|
13
|
+
No. It is a workspace configuration standard — standard files (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`) and a `.ai/` directory that coordinate multiple tools. There is no background process, no daemon, and no runtime overhead.
|
|
16
14
|
|
|
17
15
|
**What does "multimodel" mean?**
|
|
18
|
-
Multiple distinct AI coding models/agents (
|
|
16
|
+
Multiple distinct AI coding models/agents (like Codex, Cursor, Claude Code, and Gemini) operating on the **same workspace** without context loss or instruction drift.
|
|
17
|
+
|
|
18
|
+
**How is this different from just writing my own `.cursorrules` or `CLAUDE.md`?**
|
|
19
|
+
Those are tool-specific instruction files. If you use multiple tools, you end up maintaining duplicated rules that quickly drift out of sync. MultiModel Dev OS gives you a **single source of truth** (`AGENTS.md`) and automatically adapts it for each tool. You write rules once, every tool reads them.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Demo Workflows
|
|
24
|
+
|
|
25
|
+
**How do I run the demo workflows?**
|
|
26
|
+
Our demos are fully self-contained markdown walkthroughs. You can copy the commands directly from the demo pages, run them in your terminal, and observe the output. See the **[Demos Hub](/demos/)** for all available workflows.
|
|
27
|
+
|
|
28
|
+
**Do the demos make any changes to my system?**
|
|
29
|
+
The demos are designed to run in a safe, isolated, or dry-run configuration. For example, `onboard analyze` is entirely read-only, and onboarding plans and adapter syncs require developer approval before writing files. We also provide clear **Cleanup** sections on every demo page to undo any files created.
|
|
19
30
|
|
|
20
31
|
---
|
|
21
32
|
|
|
22
|
-
## Setup
|
|
33
|
+
## Setup & Installation
|
|
23
34
|
|
|
24
35
|
**Do I need Node.js?**
|
|
25
36
|
It depends on your installation path:
|
|
26
|
-
* **Yes:** If you
|
|
37
|
+
* **Yes:** If you use the primary `npx multimodel-dev-os@latest init` workflow (recommended).
|
|
27
38
|
* **No:** If you run the fallback bash (`install.sh`) or PowerShell (`install.ps1`) one-liners.
|
|
28
39
|
|
|
29
|
-
**
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
40
|
+
**Can I use this with an existing project?**
|
|
41
|
+
Yes! The `onboard` command suite is designed specifically for this. It analyzes your project structure, recommends the best template, generates a plan, and applies configs safely with automatic backups:
|
|
42
|
+
```bash
|
|
43
|
+
npx multimodel-dev-os@latest onboard analyze
|
|
44
|
+
npx multimodel-dev-os@latest onboard apply --approved
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
**Does this overwrite my existing files?**
|
|
48
|
+
Never by default. The CLI audits for conflicts before writing anything. To overwrite existing files, you must explicitly pass `--force`, and the system automatically creates `.bak` backups.
|
|
34
49
|
|
|
35
50
|
---
|
|
36
51
|
|
|
37
|
-
## Adapters
|
|
52
|
+
## Adapters & Tools
|
|
38
53
|
|
|
39
54
|
**Do I copy adapter files to my project root?**
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
-
|
|
43
|
-
|
|
55
|
+
You can do it automatically with the `adapter sync` command:
|
|
56
|
+
```bash
|
|
57
|
+
npx multimodel-dev-os@latest adapter sync all --approved
|
|
58
|
+
```
|
|
59
|
+
Or manually:
|
|
60
|
+
- Cursor → `cp adapters/cursor/.cursorrules .cursorrules`
|
|
61
|
+
- Claude Code → `cp adapters/claude/CLAUDE.md CLAUDE.md`
|
|
62
|
+
- VS Code → `cp -r adapters/vscode/.vscode/ .vscode/`
|
|
63
|
+
|
|
64
|
+
**Does this work with MCP tools?**
|
|
65
|
+
Yes. MultiModel Dev OS includes a `.ai/registries/tools.yaml` that defines MCP tool integrations (like gcloud, Chrome DevTools). The tool registry maps capabilities dynamically rather than hardcoding tool names.
|
|
66
|
+
|
|
67
|
+
**What AI models does this support?**
|
|
68
|
+
All of them. The `.ai/models/` directory contains a model registry with capability scores, routing presets, and provider configurations. It supports cloud models (GPT-4, Claude, Gemini), local models (Llama, Ollama), and everything in between. No model is hardcoded — the registry routes tasks based on capability scores.
|
|
44
69
|
|
|
45
70
|
---
|
|
46
71
|
|
|
47
72
|
## Caveman Mode
|
|
48
73
|
|
|
49
74
|
**When should I use Caveman Mode?**
|
|
50
|
-
|
|
75
|
+
Use Caveman Mode when you want to minimize prompt token overhead — ideal for tight API budgets, smaller context windows, or when you want to save money on API calls. It compresses the workspace rules by **~79%** using shorthand declarations.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Intelligence & Safety
|
|
80
|
+
|
|
81
|
+
**Is this safe? Can it modify my code?**
|
|
82
|
+
MultiModel Dev OS is primarily a **read-only** workspace configuration layer. The only write operations are:
|
|
83
|
+
- `init` / `onboard apply` — creates configuration files (with conflict detection)
|
|
84
|
+
- `memory build` — creates memory index files under `.ai/intelligence/` (gitignored)
|
|
85
|
+
- `improve apply` — applies approved proposals (requires explicit `--approved` flag and passes 12 safety gates)
|
|
86
|
+
|
|
87
|
+
No command can execute arbitrary shell commands, and destructive operations always require explicit developer approval.
|
|
88
|
+
|
|
89
|
+
**What are the safety gates?**
|
|
90
|
+
The improvement proposal system enforces 12 strict safety checks including path boundary containment, protected path blocks (`.git/`, `.env`, `node_modules/`), idempotency verification, and mandatory human approval. Every apply action is logged in an append-only audit trail.
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## TUI & Plugins
|
|
95
|
+
|
|
96
|
+
**What is the Interactive TUI Dashboard?**
|
|
97
|
+
It is a terminal-based operational menu (`npx multimodel-dev-os dashboard` or `ui`) that allows developers to run diagnostics, sync rules, build memory indexes, and check proposal status in a guided interface. It uses Node.js's native `readline` module for raw-keypress navigation, keeping execution zero-dependency and fast.
|
|
98
|
+
|
|
99
|
+
**Will the TUI Dashboard hang in CI/CD pipelines?**
|
|
100
|
+
No. The dashboard detects when stdin or stdout is non-interactive. In non-TTY environments, it prints a dry-run list of all options with their equivalent CLI commands and exits immediately, preventing pipelines from stalling.
|
|
101
|
+
|
|
102
|
+
**How secure is the Declarative Plugin system?**
|
|
103
|
+
Extremely secure. Plugins are strictly configuration-based (YAML manifest files). They cannot run arbitrary bash commands, execute node scripts, download npm packages, or make network calls. File copies are restricted to whitelisted `.ai/` and `adapters/` directories, and blacklists protect files like `.env`, `.git/`, `package.json`, and source code folders. Overwriting existing files requires `--force` and automatically generates backups.
|
|
51
104
|
|
|
52
105
|
---
|
|
53
106
|
|
|
54
107
|
## Diagnostics & Validation
|
|
55
108
|
|
|
56
109
|
**What is the difference between `validate` and `doctor`?**
|
|
57
|
-
* **`validate`**
|
|
58
|
-
* **`doctor`**
|
|
110
|
+
* **`validate`** — Strict compliance gate. Checks if required files exist and adapter configs are structurally correct. Exits with code 1 on failures. Use in CI/CD.
|
|
111
|
+
* **`doctor`** — Advisory audit. Warns about large unignored directories, missing `.gitignore` entries, stale memory indexes, and potential token waste. Non-blocking.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Contributing
|
|
116
|
+
|
|
117
|
+
**How do I contribute a new adapter?**
|
|
118
|
+
1. Create a directory under `adapters/{tool-name}/`
|
|
119
|
+
2. Add the tool-native instruction files referencing `/AGENTS.md` and `/MEMORY.md`
|
|
120
|
+
3. Add a clear `setup.md` installation guide
|
|
121
|
+
4. Update the adapter registry in `.ai/adapters/registry.yaml`
|
|
122
|
+
5. Submit a PR — see our [Contributing Guidelines](/contributing)
|
|
59
123
|
|
|
60
124
|
---
|
|
61
125
|
|
|
62
126
|
## Protocol & Migration
|
|
63
127
|
|
|
64
128
|
**Is the MultiModel Dev OS protocol stable?**
|
|
65
|
-
Yes.
|
|
129
|
+
Yes. The core Layer 1 specifications (root contracts and `.ai/` directory structure) are officially frozen and backward-compatible. Codebases prepared using any `v1.x` or `v2.x` release operate seamlessly with the latest version.
|
|
130
|
+
|
|
131
|
+
**How do I upgrade from an older version?**
|
|
132
|
+
Run `npx multimodel-dev-os@latest init --force` to pull the latest configuration files. Existing files will be backed up automatically. See the [Migration Guide](/migration-guide) for details.
|
|
66
133
|
|
|
67
|
-
Explore our [Stable Protocol Specification](/stable-protocol) or [
|
|
134
|
+
Explore our [Stable Protocol Specification](/stable-protocol) or [CLI Command Reference](/CLI) for more details.
|