multimodel-dev-os 2.0.0 → 2.6.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/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/README.md +218 -97
- package/bin/multimodel-dev-os.js +2899 -10
- package/docs/.vitepress/config.js +23 -1
- package/docs/CLI.md +89 -2
- 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/capability-registry.md +24 -0
- package/docs/cli-roadmap.md +14 -22
- package/docs/faq.md +1 -1
- 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 +5 -5
- package/docs/learning-rules.md +36 -0
- package/docs/npm-publishing.md +16 -16
- package/docs/public/llms-full.txt +32 -2
- package/docs/public/llms.txt +43 -2
- package/docs/public/sitemap.xml +81 -1
- package/docs/quickstart.md +14 -16
- package/docs/real-repo-onboarding.md +27 -0
- package/docs/release-policy.md +5 -22
- package/docs/repository-command-center.md +52 -0
- package/docs/self-improving-codebase.md +46 -0
- package/docs/template-recommendation.md +22 -0
- package/docs/templates-guide.md +14 -3
- package/docs/tool-registry.md +21 -0
- package/docs/v2-release-checklist.md +1 -1
- package/docs/v2-roadmap.md +21 -1
- package/docs/workflow-orchestration.md +59 -0
- package/package.json +1 -1
- package/scripts/install.ps1 +1 -1
- package/scripts/install.sh +1 -1
- package/scripts/prepublish-guard.js +3 -3
- package/scripts/verify.js +107 -3
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Codebase Improvement Proposals
|
|
2
|
+
|
|
3
|
+
MultiModel Dev OS supports structured codebase optimization and refactoring proposals via a secure, proposal-based self-improvement pipeline.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Safety Principles
|
|
8
|
+
|
|
9
|
+
To guarantee repository integrity and prevent unintended changes, all self-improvement operations adhere to three core rules:
|
|
10
|
+
1. **Write-Protection**: The CLI binary, security guards, workflows, and core policies are read-only and cannot be modified by model proposals.
|
|
11
|
+
2. **Human-in-the-Loop (HITL)**: Models cannot write code directly to the workspace without explicit user verification.
|
|
12
|
+
3. **Proposal-Only Modifications**: The proposal engine compiles ideas without applying edits directly.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 2. Proposal-Review Cycle
|
|
17
|
+
|
|
18
|
+
The workflow follows these stages:
|
|
19
|
+
|
|
20
|
+
### Stage A: Proposal Generation
|
|
21
|
+
Run the following command to check codebase context and write a proposal:
|
|
22
|
+
```bash
|
|
23
|
+
npx multimodel-dev-os improve propose --title "Fix unignored config files"
|
|
24
|
+
```
|
|
25
|
+
This generates a markdown file under `.ai/proposals/proposal-YYYYMMDD-HHMMSS.md` containing Frontmatter metadata and markdown explanation.
|
|
26
|
+
|
|
27
|
+
### Stage B: Human Review
|
|
28
|
+
The developer runs the review command to inspect active proposals:
|
|
29
|
+
```bash
|
|
30
|
+
npx multimodel-dev-os improve review
|
|
31
|
+
```
|
|
32
|
+
This prints a summary table of pending, approved, and rejected proposals.
|
|
33
|
+
|
|
34
|
+
To see aggregates of proposal statuses:
|
|
35
|
+
```bash
|
|
36
|
+
npx multimodel-dev-os improve status
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## 3. Proposal Execution
|
|
40
|
+
|
|
41
|
+
Once a proposal is reviewed, you can execute it in one of two ways:
|
|
42
|
+
|
|
43
|
+
### A. Automated Application (Recommended)
|
|
44
|
+
Starting in v2.4.1, approved proposals with machine-applicable operation blocks can be executed automatically:
|
|
45
|
+
1. Edit the frontmatter metadata block to set `approval_status` to `approved`.
|
|
46
|
+
2. Validate the proposal and its safety boundaries:
|
|
47
|
+
```bash
|
|
48
|
+
npx multimodel-dev-os improve validate .ai/proposals/proposal-xxxx.md
|
|
49
|
+
```
|
|
50
|
+
3. Preview planned changes using the dry-run diff command:
|
|
51
|
+
```bash
|
|
52
|
+
npx multimodel-dev-os improve diff .ai/proposals/proposal-xxxx.md
|
|
53
|
+
```
|
|
54
|
+
4. Deterministically apply changes to the repository:
|
|
55
|
+
```bash
|
|
56
|
+
npx multimodel-dev-os improve apply .ai/proposals/proposal-xxxx.md --approved
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
For detailed specifications on safety gates, allowed operations, and audit logs, see the [Approved Proposal Application Guide](/approved-proposal-apply).
|
|
60
|
+
|
|
61
|
+
### B. Manual Implementation
|
|
62
|
+
For proposals containing vague instructions or complex edits without structured operation blocks:
|
|
63
|
+
1. Manually implement and verify the code edits within your workspace.
|
|
64
|
+
2. Edit the frontmatter metadata block to set `approval_status` to `approved` to archive.
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Command Center Integration
|
|
69
|
+
|
|
70
|
+
The [Repository Command Center](repository-command-center.md) displays active proposal counts (pending, approved, and rejected) and provides a recommended command if pending proposals are waiting for review. You can run `mmdo status` to get a quick overview of your self-improvement status.
|
package/docs/index.md
CHANGED
|
@@ -16,8 +16,8 @@ hero:
|
|
|
16
16
|
text: Stable Protocol Specs
|
|
17
17
|
link: /stable-protocol
|
|
18
18
|
- theme: alt
|
|
19
|
-
text:
|
|
20
|
-
link: /
|
|
19
|
+
text: v2 Release Checklist
|
|
20
|
+
link: /v2-release-checklist
|
|
21
21
|
- theme: alt
|
|
22
22
|
text: View Case Studies
|
|
23
23
|
link: /case-studies/
|
|
@@ -141,9 +141,9 @@ MultiModel Dev OS maps repository context directly to all major developer tools
|
|
|
141
141
|
<div class="card-title">📈 Migration Playbook</div>
|
|
142
142
|
<div class="card-desc">Upgrade older workspaces to v1.1.0 standards cleanly.</div>
|
|
143
143
|
</a>
|
|
144
|
-
<a href="/
|
|
145
|
-
<div class="card-title">🏁 Release Checklist</div>
|
|
146
|
-
<div class="card-desc">Audit repository compliance with the strict release quality gates.</div>
|
|
144
|
+
<a href="/v2-release-checklist" class="card-item">
|
|
145
|
+
<div class="card-title">🏁 v2 Release Checklist</div>
|
|
146
|
+
<div class="card-desc">Audit repository compliance with the strict v2 release quality gates.</div>
|
|
147
147
|
</a>
|
|
148
148
|
<a href="/llms.txt" class="card-item" target="_blank">
|
|
149
149
|
<div class="card-title">🤖 AI Discovery (llms.txt)</div>
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Learning Rules and Feedback Loop
|
|
2
|
+
|
|
3
|
+
MultiModel Dev OS captures developer corrections and instruction overrides to compile reusable system rules that refine subsequent agent proposal generations.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Feedback Loop Commands
|
|
8
|
+
|
|
9
|
+
### 1. Log Feedback
|
|
10
|
+
To log a design preference or instruction override, run:
|
|
11
|
+
```bash
|
|
12
|
+
npx multimodel-dev-os feedback add "Prefer vanilla CSS or CSS Modules in legacy components" --type preference --tags styling --files "src/components/legacy/*"
|
|
13
|
+
```
|
|
14
|
+
This logs a structured JSON entry to `.ai/intelligence/feedback-log.jsonl`.
|
|
15
|
+
|
|
16
|
+
### 2. List Logged Feedback
|
|
17
|
+
To view all feedback entries in a formatted list:
|
|
18
|
+
```bash
|
|
19
|
+
npx multimodel-dev-os feedback list
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 3. Summarize Feedback
|
|
23
|
+
To compile the raw feedback log into instructions that agents read:
|
|
24
|
+
```bash
|
|
25
|
+
npx multimodel-dev-os feedback summarize
|
|
26
|
+
```
|
|
27
|
+
This aggregates the logs by type and writes `.ai/intelligence/learning-rules.md`.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 2. Context Ingestion by Agents
|
|
32
|
+
|
|
33
|
+
Prior to generating proposals or refactoring components:
|
|
34
|
+
1. Model agents read `.ai/intelligence/learning-rules.md` as context.
|
|
35
|
+
2. The rules act as prompt constraints matching specific file target patterns.
|
|
36
|
+
3. This prevents agents from repeating previously corrected mistakes.
|
package/docs/npm-publishing.md
CHANGED
|
@@ -12,13 +12,13 @@ Before publishing, always test the built package locally by compiling a compress
|
|
|
12
12
|
```bash
|
|
13
13
|
npm pack
|
|
14
14
|
```
|
|
15
|
-
This creates a file named like `multimodel-dev-os-0.
|
|
15
|
+
This creates a file named like `multimodel-dev-os-2.0.1.tgz` in your directory root.
|
|
16
16
|
|
|
17
17
|
2. **Verify bundle contents:**
|
|
18
18
|
Create an empty temporary workspace, extract the tarball, and confirm that only required scaffold folders are included (no `.github/`, test configurations, or local system files):
|
|
19
19
|
```bash
|
|
20
20
|
mkdir -p /tmp/package-test && cd /tmp/package-test
|
|
21
|
-
tar -xzf /path/to/multimodel-dev-os-0.
|
|
21
|
+
tar -xzf /path/to/multimodel-dev-os-2.0.1.tgz
|
|
22
22
|
ls -la package/
|
|
23
23
|
```
|
|
24
24
|
|
|
@@ -61,34 +61,34 @@ Execute these validation actions strictly in sequence before triggering a releas
|
|
|
61
61
|
## 3. Versioning & Rollback Strategy
|
|
62
62
|
|
|
63
63
|
* **Semantic Versioning (SemVer) Discipline:**
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
64
|
+
* **Patch Release (e.g. 2.0.1):** Backward-compatible bug fixes or documentation updates.
|
|
65
|
+
* **Minor Release (e.g. 2.1.0):** Backward-compatible new features (like new adapter sync mechanisms).
|
|
66
|
+
* **Major Release (e.g. 3.0.0):** Breaking changes to core specification files.
|
|
67
67
|
|
|
68
68
|
* **Rollback & Deprecation Guidelines:**
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
69
|
+
* Since published versions cannot be republished or overwritten, **never unpublish** unless absolutely necessary.
|
|
70
|
+
* If a critical bug is discovered, immediately publish a new patch version (e.g. `v2.0.1`).
|
|
71
|
+
* If a version is broken, flag it as deprecated to inform downstream installers:
|
|
72
|
+
```bash
|
|
73
|
+
npm deprecate multimodel-dev-os@2.0.0 "Critical bug found, please use v2.0.1 instead."
|
|
74
|
+
```
|
|
75
75
|
|
|
76
76
|
---
|
|
77
77
|
|
|
78
|
-
## 4. Prepublish Safety Guard (v2.0.
|
|
78
|
+
## 4. Prepublish Safety Guard (v2.0.1 Stable)
|
|
79
79
|
|
|
80
80
|
> [!IMPORTANT]
|
|
81
|
-
> **v2.0.
|
|
81
|
+
> **v2.0.1 is the active stable release.** NPM publishing is no longer paused.
|
|
82
82
|
|
|
83
83
|
### Source vs. Registry Strategy
|
|
84
|
-
* **GitHub main branch (Source)**: Contains the current stable `v2.0.
|
|
84
|
+
* **GitHub main branch (Source)**: Contains the current stable `v2.0.1` codebase.
|
|
85
85
|
* **npm latest (Registry)**: Pulled and installed globally or via npx.
|
|
86
86
|
|
|
87
87
|
### Prepublish Safety Guard
|
|
88
88
|
To prevent accidental `npm publish` executions on developer environments, a local validation script has been added to package hooks. If you run `npm publish`, it is blocked by default.
|
|
89
89
|
|
|
90
|
-
To bypass this check during
|
|
91
|
-
1. Ensure the version in `package.json` starts with `2.` (e.g. `2.0.
|
|
90
|
+
To bypass this check during approved release windows:
|
|
91
|
+
1. Ensure the version in `package.json` starts with `2.` (e.g. `2.0.1`).
|
|
92
92
|
2. Run publication with the override env variable:
|
|
93
93
|
```powershell
|
|
94
94
|
# PowerShell
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# MultiModel Dev OS — Comprehensive AI Assistant Discoverability Guide (v2.
|
|
1
|
+
# MultiModel Dev OS — Comprehensive AI Assistant Discoverability Guide (v2.6.0 Stable Release)
|
|
2
2
|
|
|
3
3
|
MultiModel Dev OS is a repository-level porting specification designed to align context and instructions across diverse developer tools and AI models.
|
|
4
4
|
|
|
@@ -38,13 +38,43 @@ The protocol decouples the centralized workspace context from the individual too
|
|
|
38
38
|
|
|
39
39
|
All compliant MultiModel Dev OS CLIs strictly enforce the following command contracts:
|
|
40
40
|
- **`init`**: Scaffolds the standard `.ai/` context configuration directories. Supports `--template`, `--caveman`, `--adapter`, and dynamic registries mapping.
|
|
41
|
+
- **`status`**: Displays a compact project intelligence dashboard summarizing package details, frameworks, memory freshness, feedback logs, improvement proposals, and audit execution metrics.
|
|
42
|
+
- **`scan`**: Performs a read-only codebase scan to detect frameworks, package managers, MultiModel Dev OS configurations, and potential context-bloat or security risks.
|
|
43
|
+
- **`onboard`**: Safely integrates MultiModel Dev OS into existing repositories. Subcommands:
|
|
44
|
+
- `analyze`: Scans repository structure, frameworks, languages, and risk markers. Read-only.
|
|
45
|
+
- `recommend`: Runs scanner diagnostics and recommendations for templates and adapters. Read-only.
|
|
46
|
+
- `plan`: Generates onboarding plan `.ai/intelligence/onboarding.plan.json` and report `.ai/intelligence/onboarding.report.md`. Read-only.
|
|
47
|
+
- `apply`: Copies configuration templates to target directory. Overwrites require `--force` and automatically generate backups.
|
|
48
|
+
- `status`: Show progress and completeness percentage dashboard.
|
|
49
|
+
- **`adapter`**: Manage and sync rule/settings files for IDE adapters. Subcommands:
|
|
50
|
+
- `status`: Show rules files status and enable/disable states from config.
|
|
51
|
+
- `diff <adapter>`: Show rules diff between bundled template and target root file.
|
|
52
|
+
- `sync <adapter|all>`: Synchronizes rule files (requires `--approved`). Overwrites require `--force` and automatically generate backups.
|
|
53
|
+
- **`memory`**: Compiles or reviews codebase hash-compressed memory. Subcommands:
|
|
54
|
+
- `build`: Scans target codebase and writes memory metadata to `.ai/intelligence/memory.hash.json` and `.ai/intelligence/memory.summary.md`.
|
|
55
|
+
- `refresh`: Incremental update comparing changed file hashes to update the memory files.
|
|
56
|
+
- `diff`: Prints added, removed, or changed files compared to `memory.hash.json` without executing writes.
|
|
57
|
+
- **`feedback`**: Manage developer feedback loops. Subcommands:
|
|
58
|
+
- `add`: Logs raw developer feedback to `feedback-log.jsonl`.
|
|
59
|
+
- `list`: Lists logged feedback entries.
|
|
60
|
+
- `summarize`: Compiles feedback entries into `learning-rules.md`.
|
|
61
|
+
- **`improve`**: Manage codebase self-improvement proposals. Subcommands:
|
|
62
|
+
- `propose`: Scans context and writes a proposal file under `.ai/proposals/`.
|
|
63
|
+
- `review`: Lists proposals and their active statuses.
|
|
64
|
+
- `status`: Shows aggregates of proposal statuses.
|
|
65
|
+
- `validate`: Validate proposal safety gates and operations block.
|
|
66
|
+
- `diff`: Preview proposed changes in unified diff format without modifying files.
|
|
67
|
+
- `apply`: Deterministically apply approved operations to the target codebase (requires `--approved`).
|
|
68
|
+
- `log`: Display Applied Proposals Audit Log execution history.
|
|
69
|
+
- **`workflow`**: Orchestrate read-only development workflows (list, show, plan, run). Steps are restricted to safe, non-destructive CLI functions.
|
|
70
|
+
- **`handoff`**: Compile token-compressed session context (build, show) at `.ai/intelligence/handoff.md` to transfer state to a new agent or model session.
|
|
41
71
|
- **`verify`**: Automated release script that checks structure integrity.
|
|
42
72
|
- **`templates`**: Lists built-in template profiles (supports overrides via `--registry <path>`).
|
|
43
73
|
- **`validate`**: Strict Quality Gate checking the layout rules on disk (supports `--all-registries`).
|
|
44
74
|
- **`validate-template`**: Scans a template registry entry and source directory structure for completeness.
|
|
45
75
|
- **`validate-adapter`**: Audits an adapter config file and directory setup compliance.
|
|
46
76
|
- **`validate-skill`**: Checks a custom skill file against standard Markdown headers.
|
|
47
|
-
- **`doctor`**: Advisory checkup auditing ignored folders and token footprint (supports `--tokens
|
|
77
|
+
- **`doctor`**: Advisory checkup auditing ignored folders and token footprint (supports `--tokens`, `--release`, `--intelligence`, and `--onboarding`).
|
|
48
78
|
|
|
49
79
|
---
|
|
50
80
|
|
package/docs/public/llms.txt
CHANGED
|
@@ -1,10 +1,51 @@
|
|
|
1
|
-
# MultiModel Dev OS (v2.
|
|
1
|
+
# MultiModel Dev OS (v2.6.0 Stable Release)
|
|
2
2
|
|
|
3
3
|
Portable, vendor-neutral workspace configuration standard for multi-agent AI pair-programming workflows.
|
|
4
4
|
|
|
5
|
-
## Fast Setup (Stable npm @latest)
|
|
5
|
+
## Fast Setup & Commands (Stable npm @latest)
|
|
6
6
|
```bash
|
|
7
|
+
# Initialize workspace
|
|
7
8
|
npx multimodel-dev-os@latest init
|
|
9
|
+
|
|
10
|
+
# Scan codebase signals & check status
|
|
11
|
+
npx multimodel-dev-os@latest scan
|
|
12
|
+
npx multimodel-dev-os@latest status
|
|
13
|
+
|
|
14
|
+
# Onboard existing repositories safely
|
|
15
|
+
npx multimodel-dev-os@latest onboard analyze
|
|
16
|
+
npx multimodel-dev-os@latest onboard recommend
|
|
17
|
+
npx multimodel-dev-os@latest onboard plan
|
|
18
|
+
npx multimodel-dev-os@latest onboard apply --approved
|
|
19
|
+
npx multimodel-dev-os@latest onboard status
|
|
20
|
+
|
|
21
|
+
# Manage and sync IDE adapter configuration files
|
|
22
|
+
npx multimodel-dev-os@latest adapter status
|
|
23
|
+
npx multimodel-dev-os@latest adapter diff cursor
|
|
24
|
+
npx multimodel-dev-os@latest adapter sync cursor --approved
|
|
25
|
+
|
|
26
|
+
# Build/refresh memory index
|
|
27
|
+
npx multimodel-dev-os@latest memory build
|
|
28
|
+
npx multimodel-dev-os@latest memory refresh
|
|
29
|
+
|
|
30
|
+
# Run automated workflow cycles
|
|
31
|
+
npx multimodel-dev-os@latest workflow run repo-health
|
|
32
|
+
npx multimodel-dev-os@latest workflow list
|
|
33
|
+
|
|
34
|
+
# Compile session handoff spec
|
|
35
|
+
npx multimodel-dev-os@latest handoff build
|
|
36
|
+
npx multimodel-dev-os@latest handoff show
|
|
37
|
+
|
|
38
|
+
# Manage developer feedback loop
|
|
39
|
+
npx multimodel-dev-os@latest feedback add "Avoid Tailwind CSS" --type preference
|
|
40
|
+
npx multimodel-dev-os@latest feedback summarize
|
|
41
|
+
|
|
42
|
+
# Draft, review, validate, and apply codebase improvement proposals
|
|
43
|
+
npx multimodel-dev-os@latest improve propose --title "Fix config issues"
|
|
44
|
+
npx multimodel-dev-os@latest improve review
|
|
45
|
+
npx multimodel-dev-os@latest improve validate .ai/proposals/proposal-xxxx.md
|
|
46
|
+
npx multimodel-dev-os@latest improve diff .ai/proposals/proposal-xxxx.md
|
|
47
|
+
npx multimodel-dev-os@latest improve apply .ai/proposals/proposal-xxxx.md --approved
|
|
48
|
+
npx multimodel-dev-os@latest improve log
|
|
8
49
|
```
|
|
9
50
|
|
|
10
51
|
## Supported Tools
|
package/docs/public/sitemap.xml
CHANGED
|
@@ -61,8 +61,88 @@
|
|
|
61
61
|
<priority>0.6</priority>
|
|
62
62
|
</url>
|
|
63
63
|
<url>
|
|
64
|
-
<loc>https://rizvee.github.io/multimodel-dev-os/
|
|
64
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/v2-release-checklist</loc>
|
|
65
65
|
<changefreq>weekly</changefreq>
|
|
66
66
|
<priority>0.6</priority>
|
|
67
67
|
</url>
|
|
68
|
+
<url>
|
|
69
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/model-routing</loc>
|
|
70
|
+
<changefreq>weekly</changefreq>
|
|
71
|
+
<priority>0.7</priority>
|
|
72
|
+
</url>
|
|
73
|
+
<url>
|
|
74
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/local-models</loc>
|
|
75
|
+
<changefreq>weekly</changefreq>
|
|
76
|
+
<priority>0.7</priority>
|
|
77
|
+
</url>
|
|
78
|
+
<url>
|
|
79
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/provider-strategy</loc>
|
|
80
|
+
<changefreq>weekly</changefreq>
|
|
81
|
+
<priority>0.7</priority>
|
|
82
|
+
</url>
|
|
83
|
+
<url>
|
|
84
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/agent-compatibility</loc>
|
|
85
|
+
<changefreq>weekly</changefreq>
|
|
86
|
+
<priority>0.7</priority>
|
|
87
|
+
</url>
|
|
88
|
+
<url>
|
|
89
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/adapter-authoring</loc>
|
|
90
|
+
<changefreq>weekly</changefreq>
|
|
91
|
+
<priority>0.7</priority>
|
|
92
|
+
</url>
|
|
93
|
+
<url>
|
|
94
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/template-authoring</loc>
|
|
95
|
+
<changefreq>weekly</changefreq>
|
|
96
|
+
<priority>0.7</priority>
|
|
97
|
+
</url>
|
|
98
|
+
<url>
|
|
99
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/skill-authoring</loc>
|
|
100
|
+
<changefreq>weekly</changefreq>
|
|
101
|
+
<priority>0.7</priority>
|
|
102
|
+
</url>
|
|
103
|
+
<url>
|
|
104
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/v2-migration</loc>
|
|
105
|
+
<changefreq>weekly</changefreq>
|
|
106
|
+
<priority>0.7</priority>
|
|
107
|
+
</url>
|
|
108
|
+
<url>
|
|
109
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/package-safety</loc>
|
|
110
|
+
<changefreq>weekly</changefreq>
|
|
111
|
+
<priority>0.7</priority>
|
|
112
|
+
</url>
|
|
113
|
+
<url>
|
|
114
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/registry-contribution</loc>
|
|
115
|
+
<changefreq>weekly</changefreq>
|
|
116
|
+
<priority>0.7</priority>
|
|
117
|
+
</url>
|
|
118
|
+
<url>
|
|
119
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/future-proof-architecture</loc>
|
|
120
|
+
<changefreq>weekly</changefreq>
|
|
121
|
+
<priority>0.7</priority>
|
|
122
|
+
</url>
|
|
123
|
+
<url>
|
|
124
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/self-improving-codebase</loc>
|
|
125
|
+
<changefreq>weekly</changefreq>
|
|
126
|
+
<priority>0.7</priority>
|
|
127
|
+
</url>
|
|
128
|
+
<url>
|
|
129
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/hash-compressed-memory</loc>
|
|
130
|
+
<changefreq>weekly</changefreq>
|
|
131
|
+
<priority>0.7</priority>
|
|
132
|
+
</url>
|
|
133
|
+
<url>
|
|
134
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/feedback-learning</loc>
|
|
135
|
+
<changefreq>weekly</changefreq>
|
|
136
|
+
<priority>0.7</priority>
|
|
137
|
+
</url>
|
|
138
|
+
<url>
|
|
139
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/capability-registry</loc>
|
|
140
|
+
<changefreq>weekly</changefreq>
|
|
141
|
+
<priority>0.7</priority>
|
|
142
|
+
</url>
|
|
143
|
+
<url>
|
|
144
|
+
<loc>https://rizvee.github.io/multimodel-dev-os/tool-registry</loc>
|
|
145
|
+
<changefreq>weekly</changefreq>
|
|
146
|
+
<priority>0.7</priority>
|
|
147
|
+
</url>
|
|
68
148
|
</urlset>
|
package/docs/quickstart.md
CHANGED
|
@@ -8,7 +8,7 @@ Get the MultiModel Dev OS integrated into your codebase in under 2 minutes to sy
|
|
|
8
8
|
|
|
9
9
|
## Option A: NPX Scaffolding (Stable Packages)
|
|
10
10
|
|
|
11
|
-
Initialize any project instantly using our public npm registry. Note that this pulls the latest stable npm-published release (`v2.0.
|
|
11
|
+
Initialize any project instantly using our public npm registry. Note that this pulls the latest stable npm-published release (`v2.0.1`):
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
# Standard interactive initialization in the current directory
|
|
@@ -49,18 +49,13 @@ curl -fsSL https://raw.githubusercontent.com/rizvee/multimodel-dev-os/main/scrip
|
|
|
49
49
|
|
|
50
50
|
---
|
|
51
51
|
|
|
52
|
-
## Option D:
|
|
52
|
+
## Option D: Scaffold Target Directory (NPX Direct)
|
|
53
53
|
|
|
54
|
-
If you prefer to
|
|
54
|
+
If you prefer to initialize a target project path directly:
|
|
55
55
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
```
|
|
60
|
-
2. Run the CLI directly from the cloned repository source:
|
|
61
|
-
```bash
|
|
62
|
-
node bin/multimodel-dev-os.js init --target /path/to/your-project --template nextjs-saas --adapter cursor
|
|
63
|
-
```
|
|
56
|
+
```bash
|
|
57
|
+
npx multimodel-dev-os@latest init --target /path/to/your-project --template nextjs-saas --adapter cursor
|
|
58
|
+
```
|
|
64
59
|
|
|
65
60
|
---
|
|
66
61
|
|
|
@@ -78,17 +73,20 @@ If you prefer to run directly from cloned source without global installation:
|
|
|
78
73
|
|
|
79
74
|
## Verify & Diagnose
|
|
80
75
|
|
|
81
|
-
|
|
76
|
+
Validate structural health, run codebase scans, and build hash-compressed memory:
|
|
82
77
|
|
|
83
78
|
```bash
|
|
84
79
|
# Strict directory schema validation
|
|
85
|
-
|
|
80
|
+
npx multimodel-dev-os validate
|
|
86
81
|
|
|
87
82
|
# Advisory doctor workspace compatibility audit
|
|
88
|
-
|
|
83
|
+
npx multimodel-dev-os doctor
|
|
84
|
+
|
|
85
|
+
# Advisory codebase scanner
|
|
86
|
+
npx multimodel-dev-os scan
|
|
89
87
|
|
|
90
|
-
#
|
|
91
|
-
|
|
88
|
+
# Build codebase memory index
|
|
89
|
+
npx multimodel-dev-os memory build
|
|
92
90
|
```
|
|
93
91
|
|
|
94
92
|
Explore our canonical [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Onboarding Existing Repositories
|
|
2
|
+
|
|
3
|
+
MultiModel Dev OS provides a safe, step-by-step onboarding protocol to configure coding agents in any existing codebase without modifying application source files.
|
|
4
|
+
|
|
5
|
+
## Onboarding Commands
|
|
6
|
+
|
|
7
|
+
To onboard an existing repository, run the following commands:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# 1. Analyze the project structure, language, framework, and security signals
|
|
11
|
+
npx multimodel-dev-os onboard analyze --target .
|
|
12
|
+
|
|
13
|
+
# 2. Output template recommendations and suggested next steps
|
|
14
|
+
npx multimodel-dev-os onboard recommend --target .
|
|
15
|
+
|
|
16
|
+
# 3. Generate a structured onboarding plan and markdown report
|
|
17
|
+
npx multimodel-dev-os onboard plan --target .
|
|
18
|
+
|
|
19
|
+
# 4. Safely apply the onboarding plan to generate AI Dev OS scaffolding
|
|
20
|
+
npx multimodel-dev-os onboard apply --target . --approved
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Security & Safety Guarantees
|
|
24
|
+
|
|
25
|
+
* **Read-only Commands**: `analyze`, `recommend`, and `plan` are read-only and make no modifications.
|
|
26
|
+
* **No Source Code Mutation**: `apply` only creates/updates MultiModel Dev OS configuration files (`.ai/`, `AGENTS.md`, `MEMORY.md`, etc.). It never touches your application source code.
|
|
27
|
+
* **Backup Support**: If a file already exists, the onboard engine skips it. To overwrite, use `--force`, which creates a `.bak` backup file first.
|
package/docs/release-policy.md
CHANGED
|
@@ -34,26 +34,9 @@ No package shall be merged or released without:
|
|
|
34
34
|
|
|
35
35
|
---
|
|
36
36
|
|
|
37
|
-
## 4.
|
|
38
|
-
|
|
39
|
-
To ensure high stability and thorough testing of the Template Galaxy and Model Compatibility Layers, package publishing to the public npm registry is paused during all `v1.2.x` minor releases:
|
|
40
|
-
* **GitHub Repository (Source)**: Serve as the primary, active source branch containing unreleased v1.2+ features (such as template extensions, model registries, and CLI expansions).
|
|
41
|
-
* **NPM Registry (Latest)**: Remains on the last approved stable version.
|
|
42
|
-
* **v2.0.0 (Next Target)**: Will serve as the next stable release published to the npm registry, packaging the hardened registries and Template Galaxy features.
|
|
43
|
-
|
|
44
|
-
### Local Source & Verification Procedures
|
|
45
|
-
|
|
46
|
-
Contributors and developers must verify and test unreleased `v1.2.x` features locally rather than running publication steps:
|
|
47
|
-
1. **Execute commands from the source binary:**
|
|
48
|
-
```bash
|
|
49
|
-
node bin/multimodel-dev-os.js init
|
|
50
|
-
node bin/multimodel-dev-os.js verify
|
|
51
|
-
```
|
|
52
|
-
2. **Compile and test the package bundle locally:**
|
|
53
|
-
```bash
|
|
54
|
-
npm pack
|
|
55
|
-
```
|
|
56
|
-
This generates a local `.tgz` archive. Install it in a target test project to run validations.
|
|
57
|
-
|
|
58
|
-
Never execute `npm publish` in the main workspace unless actively packaging the approved `v2.0.0` release.
|
|
37
|
+
## 4. Release Channel & Staging Controls
|
|
59
38
|
|
|
39
|
+
MultiModel Dev OS releases new versions directly to the public NPM registry:
|
|
40
|
+
* **Stable Releases (`npx multimodel-dev-os`)**: Published to the public registry under semantic version categories (e.g. `2.0.0`, `2.0.1`).
|
|
41
|
+
* **Release Candidates**: Built and validated locally via the automated verification script (`scripts/verify.js`) before tags or packaging runs.
|
|
42
|
+
* **Staging Verification**: To test new configurations prior to publishing, package the bundle locally (`npm pack`) and run CLI checkups in clean test directories.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Repository Command Center Guide
|
|
2
|
+
|
|
3
|
+
The **Repository Command Center** introduced in `v2.5.0` provides a unified, read-only operational dashboard summarizing the entire repository intelligence status of a MultiModel Dev OS workspace.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Using the `status` Command
|
|
8
|
+
|
|
9
|
+
The `status` command allows developers and AI agents to instantly check project health and progress.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx multimodel-dev-os status
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Or target a specific subdirectory:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx multimodel-dev-os status --target ./some-subproject
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Dashboard View
|
|
22
|
+
|
|
23
|
+
Running `status` prints a formatted, color-coded status summary:
|
|
24
|
+
|
|
25
|
+
1. **Project Info**: Displays the package name and package version from the root `package.json`.
|
|
26
|
+
2. **Framework & Dependency Signals**: Summarizes detected languages, framework engines (e.g. Next.js, Express, React), and package lockfiles (e.g. `package-lock.json`).
|
|
27
|
+
3. **Memory State**:
|
|
28
|
+
* `CURRENT` (Green): Memory index is fully built and matches the filesystem.
|
|
29
|
+
* `STALE` (Yellow): Modifications have been made. Lists number of added, removed, or modified files.
|
|
30
|
+
* `MISSING` (Red): No memory files have been built yet.
|
|
31
|
+
4. **Feedback Loop & Rules**: Displays total count of developer feedback entries and whether compiled learning rules are active.
|
|
32
|
+
5. **Improvement Proposals**: Lists total optimization proposals, categorized by approval status (`pending`, `approved`, `rejected`).
|
|
33
|
+
6. **Apply Audit Log**: Counts applied proposal runs.
|
|
34
|
+
7. **Next Recommended Command**: Offers dynamic advice on what to execute next (e.g., refreshing memory, review proposals, running health checks).
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 2. Benefits for Multi-Agent Workflows
|
|
39
|
+
|
|
40
|
+
* **Context Discovery**: Instantly summarizes active templates, environment structures, and boundaries.
|
|
41
|
+
* **Zero-Dependency Parsing**: Fast initialization checks that don't load external libraries.
|
|
42
|
+
* **Actionable Next Steps**: Guides developers and AI models to the correct command sequence, preventing execution drift.
|
|
43
|
+
|
|
44
|
+
## 3. Onboarding Status
|
|
45
|
+
|
|
46
|
+
For uninitialized repositories, you can inspect the onboarding status directly:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npx multimodel-dev-os onboard status
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
This prints a checklist of crucial MultiModel Dev OS files and an overall completeness percentage score.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Self-Improving Codebase Operations
|
|
2
|
+
|
|
3
|
+
MultiModel Dev OS supports codebase refactoring, styling, and structural optimizations through a secure, proposal-based self-improvement pipeline.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Safety Principles
|
|
8
|
+
|
|
9
|
+
To guarantee repository integrity and prevent unintended changes, all self-improvement operations adhere to three core rules:
|
|
10
|
+
1. **Write-Protection**: The CLI binary, security guards, workflows, and core policies are read-only and cannot be modified by model proposals.
|
|
11
|
+
2. **Human-in-the-Loop (HITL)**: Models cannot write code directly to the workspace without explicit user verification.
|
|
12
|
+
3. **Diff-Validated Execution**: Every modification must pass local verification tests, with manual commit approval.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 2. Proposal-Review Cycle
|
|
17
|
+
|
|
18
|
+
The execution path follows two stages:
|
|
19
|
+
|
|
20
|
+
### Stage A: Proposal Generation
|
|
21
|
+
Before compiling a proposal, the agent scans the codebase using `mmdo scan` and builds the hash-compressed memory index via `mmdo memory build` to ensure the proposal is context-aware and token-efficient. The agent then identifies an optimization and saves a structured document under `.ai/proposals/proposal-YYYYMMDD-HHMMSS.md`. The proposal specifies the rationale, affected files list, risk level, test command, and rollback steps.
|
|
22
|
+
|
|
23
|
+
### Stage B: Human Review
|
|
24
|
+
The developer runs the review CLI command:
|
|
25
|
+
```bash
|
|
26
|
+
npx multimodel-dev-os improve review
|
|
27
|
+
```
|
|
28
|
+
This shows the proposed changes, affected files, risk levels, and verify commands.
|
|
29
|
+
|
|
30
|
+
To view status:
|
|
31
|
+
```bash
|
|
32
|
+
npx multimodel-dev-os improve status
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
*Note: Starting in v2.4.1, automated proposal application is supported via the `improve apply` command, provided that a valid operations JSON block exists in the proposal file and the developer passes the `--approved` flag. Vague proposals or those targeting protected files/paths must still be executed manually.*
|
|
36
|
+
|
|
37
|
+
For complete automated application details, please refer to the [Approved Proposal Application Guide](/approved-proposal-apply).
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Command Center Integration
|
|
42
|
+
|
|
43
|
+
The [Repository Command Center](repository-command-center.md) serves as the unified dashboard for the self-improvement loop. Running `mmdo status` displays the counts of pending/approved/rejected proposals, memory state, and feedback logs. Developers can orchestrate the review cycle safely by executing the `proposal-review` workflow:
|
|
44
|
+
```bash
|
|
45
|
+
npx multimodel-dev-os workflow run proposal-review
|
|
46
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Template Recommendation Engine
|
|
2
|
+
|
|
3
|
+
The recommendation engine matches existing codebases to the best-fit template profile.
|
|
4
|
+
|
|
5
|
+
## Heuristics & Confidence Scores
|
|
6
|
+
|
|
7
|
+
The engine assigns weights to file signatures and package dependencies:
|
|
8
|
+
|
|
9
|
+
* **Next.js SaaS (`nextjs-saas`)**: Matches if `next.config.js` or `next.config.ts` is present (Weight: +0.6) or `package.json` contains `next` dependency (Weight: +0.4).
|
|
10
|
+
* **Android Expo Mobile (`expo-react-native-android`)**: Matches if `app.json` or `eas.json` is present (Weight: +0.8).
|
|
11
|
+
* **WordPress Theme/Plugin (`wordpress-theme-plugin`)**: Matches if `wp-content` directory or header-decorated PHP style files are found (Weight: +0.8).
|
|
12
|
+
* **E-Commerce Store (`ecommerce-store`)**: Matches if Stripe, Shopify, or checkout-related dependencies are present (Weight: +0.4).
|
|
13
|
+
* **SEO Landing Page (`seo-landing-page`)**: Matches if raw HTML files + Tailwind configs exist without framework elements (Weight: +0.5).
|
|
14
|
+
* **General App (`general-app`)**: Serves as the fallback profile if no other template achieves a confidence score greater than 0.4.
|
|
15
|
+
|
|
16
|
+
## Command
|
|
17
|
+
|
|
18
|
+
To check template recommendations for your project:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx multimodel-dev-os onboard recommend --target .
|
|
22
|
+
```
|