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.
Files changed (81) hide show
  1. package/.ai/intelligence/README.md +14 -0
  2. package/.ai/intelligence/apply-log.schema.json +65 -0
  3. package/.ai/intelligence/feedback-log.example.jsonl +2 -0
  4. package/.ai/intelligence/feedback.schema.json +47 -0
  5. package/.ai/intelligence/improvement-proposal.schema.json +70 -0
  6. package/.ai/intelligence/learning-rules.example.md +18 -0
  7. package/.ai/intelligence/memory.schema.json +97 -0
  8. package/.ai/plugins/README.md +30 -0
  9. package/.ai/plugins/plugin.example.yaml +32 -0
  10. package/.ai/policies/approval-gates.md +35 -0
  11. package/.ai/policies/memory-policy.md +30 -0
  12. package/.ai/policies/self-improvement-policy.md +39 -0
  13. package/.ai/proposals/README.md +44 -0
  14. package/.ai/proposals/apply-operation.example.json +22 -0
  15. package/.ai/registries/capabilities.yaml +73 -0
  16. package/.ai/registries/tools.yaml +84 -0
  17. package/.ai/registries/workflows.yaml +217 -0
  18. package/.ai/schema/plugin.schema.json +56 -0
  19. package/README.md +116 -138
  20. package/assets/adapter-sync-flow.svg +84 -0
  21. package/assets/architecture-preview.svg +46 -31
  22. package/assets/onboarding-flow.svg +79 -0
  23. package/assets/social-preview.svg +1 -1
  24. package/assets/terminal-demo.svg +22 -23
  25. package/bin/multimodel-dev-os.js +3472 -7
  26. package/docs/.vitepress/config.js +46 -7
  27. package/docs/5-day-roadmap.md +9 -9
  28. package/docs/CLI.md +260 -34
  29. package/docs/adapter-sync.md +27 -0
  30. package/docs/adapters.md +16 -0
  31. package/docs/agent-handoff.md +40 -0
  32. package/docs/approved-proposal-apply.md +156 -0
  33. package/docs/architecture.md +31 -7
  34. package/docs/capability-registry.md +24 -0
  35. package/docs/comparison.md +72 -25
  36. package/docs/compatibility.md +2 -2
  37. package/docs/dashboard.md +105 -0
  38. package/docs/demo.md +23 -60
  39. package/docs/demos/adapter-sync.md +103 -0
  40. package/docs/demos/existing-repo-onboarding.md +125 -0
  41. package/docs/demos/index.md +91 -0
  42. package/docs/demos/multi-agent-handoff.md +88 -0
  43. package/docs/demos/release-check.md +109 -0
  44. package/docs/demos/safe-improvement-loop.md +119 -0
  45. package/docs/distribution.md +195 -0
  46. package/docs/faq.md +91 -24
  47. package/docs/feedback-learning.md +33 -0
  48. package/docs/future-proof-architecture.md +22 -0
  49. package/docs/hash-compressed-memory.md +72 -0
  50. package/docs/improvement-proposals.md +70 -0
  51. package/docs/index.md +192 -81
  52. package/docs/installers.md +18 -4
  53. package/docs/launch-kit.md +97 -49
  54. package/docs/learning-rules.md +36 -0
  55. package/docs/npm-publishing.md +6 -6
  56. package/docs/plugin-authoring.md +99 -0
  57. package/docs/plugin-hooks.md +80 -0
  58. package/docs/public/assets/adapter-sync-flow.svg +84 -0
  59. package/docs/public/assets/onboarding-flow.svg +79 -0
  60. package/docs/public/llms-full.txt +47 -4
  61. package/docs/public/llms.txt +55 -2
  62. package/docs/public/sitemap.xml +85 -0
  63. package/docs/quickstart.md +82 -22
  64. package/docs/real-repo-onboarding.md +27 -0
  65. package/docs/repository-command-center.md +68 -0
  66. package/docs/self-improving-codebase.md +46 -0
  67. package/docs/template-recommendation.md +22 -0
  68. package/docs/templates-guide.md +11 -0
  69. package/docs/tool-registry.md +21 -0
  70. package/docs/tui-safety.md +59 -0
  71. package/docs/use-cases.md +21 -0
  72. package/docs/v2-roadmap.md +78 -71
  73. package/docs/workflow-orchestration.md +62 -0
  74. package/examples/adapter-sync/README.md +45 -0
  75. package/examples/command-center/README.md +59 -0
  76. package/examples/real-repo-onboarding/README.md +53 -0
  77. package/examples/safe-improvement-loop/README.md +48 -0
  78. package/package.json +1 -1
  79. package/scripts/install.ps1 +1 -1
  80. package/scripts/install.sh +1 -1
  81. package/scripts/verify.js +107 -3
@@ -0,0 +1,156 @@
1
+ # Approved Proposal Application Engine
2
+
3
+ MultiModel Dev OS v2.4.1 (Safety & UX Patch) introduces a safe, deterministic, human-approved proposal application layer to automate the execution of approved codebase optimization proposals under strict safety constraints.
4
+
5
+ ---
6
+
7
+ ## 1. Core Workflow
8
+
9
+ Instead of requiring manual copy-pasting, the CLI can execute machine-applicable operation blocks from proposal files that have been marked as `approved` by a developer.
10
+
11
+ ```mermaid
12
+ graph TD
13
+ A[improve propose] --> B[Pending Proposal File]
14
+ B --> C{Developer Review}
15
+ C -->|Rejects| D[approval_status: rejected]
16
+ C -->|Approves & edits frontmatter| E[approval_status: approved]
17
+ E --> F[improve validate]
18
+ F -->|Validation check passes| G[improve diff]
19
+ G -->|Dry-run preview passes| H[improve apply --approved]
20
+ H --> I[Changes written to target & logged in apply-log]
21
+ ```
22
+
23
+ ---
24
+
25
+ ## 2. Machine-Applicable Operations
26
+
27
+ To automate changes, proposal files support an optional, structured JSON block embedded as a `json` code block in the markdown body:
28
+
29
+ ````markdown
30
+ ```json
31
+ {
32
+ "operations": [
33
+ {
34
+ "type": "create_file",
35
+ "path": "docs/example.md",
36
+ "content": "# Example\n",
37
+ "overwrite": true
38
+ },
39
+ {
40
+ "type": "append_line",
41
+ "path": ".gitignore",
42
+ "line": "node_modules/"
43
+ },
44
+ {
45
+ "type": "replace_text",
46
+ "path": "README.md",
47
+ "find": "old text",
48
+ "replace": "new text",
49
+ "allow_multiple": false
50
+ }
51
+ ]
52
+ }
53
+ ```
54
+ ````
55
+
56
+ ### Supported Operation Types
57
+
58
+ | Operation | Parameters | Description |
59
+ |---|---|---|
60
+ | `create_file` | `path`, `content`, `overwrite` (optional) | Creates a file with the given content. Fails if the file exists unless `overwrite: true`. |
61
+ | `append_line` | `path`, `line` | Appends a line to the file. It is idempotent; if the line already exists in the file, it will not be duplicated. |
62
+ | `replace_text` | `path`, `find`, `replace`, `allow_multiple` (optional) | Replaces search string `find` with `replace`. Fails if `find` is not found, or matches multiple times unless `allow_multiple: true`. |
63
+
64
+ ### Disallowed Operations for Safety
65
+ The following actions are strictly prohibited in the v2.4.0 application engine:
66
+ * Deleting or renaming files (`delete_file`, `rename_file`)
67
+ * Running arbitrary shell commands
68
+ * Installing npm packages or editing package dependencies
69
+ * Interacting with Git or version control
70
+ * Performing network calls
71
+ * Modifying binary files or secret files
72
+ * Modifying files outside the target workspace root folder
73
+
74
+ ---
75
+
76
+ ## 3. Strict Safety Gates
77
+
78
+ The application engine validates every proposal file against a set of strict safety rules before any file is touched:
79
+
80
+ 1. **Existence**: The target proposal markdown file must exist.
81
+ 2. **Metadata Frontmatter**: YAML frontmatter must parse successfully.
82
+ 3. **Approval Check**: `approval_status` inside the frontmatter must be explicitly set to `approved`.
83
+ 4. **CLI Flag**: `improve apply` refuses to execute unless `--approved` is passed by the user.
84
+ 5. **Operations block**: A valid JSON code block with `operations` array must be found.
85
+ 6. **Command validation**: Every listed operation type must be allowed.
86
+ 7. **Directory boundaries**: Every target path must resolve strictly inside the target root directory. Directory traversal using `..` or absolute paths resolves outside target root and fails.
87
+ 8. **Protected paths**: No protected files or directories (such as `.git/`, `node_modules/`, `.env`, `.npmrc`, SSL keys/certificates) can be written to or modified.
88
+ 9. **`replace_text` match count**: Search text `find` must match exactly once unless `allow_multiple: true` is passed.
89
+ 10. **`create_file` overwrites**: If a target file exists, the operation must explicitly specify `overwrite: true`.
90
+ 11. **`append_line` idempotency**: Line additions will not duplicate if the exact line already exists.
91
+ 12. **Dry-run diff**: Developers can preview all changes using `improve diff` prior to execution.
92
+
93
+ > [!WARNING]
94
+ > **Workflow Isolation**: The `improve apply` command can only be executed manually by a developer. The MultiModel Dev OS [Workflow Runner](workflow-orchestration.md) runs in a strictly read-only mode and is prohibited from executing `improve apply` or modifying codebase files.
95
+
96
+ ---
97
+
98
+ ## 4. CLI Commands
99
+
100
+ ### validate
101
+ Validates the proposal frontmatter, safety gates, and operation rules. Displays a color-coded Checklist showing the status of each safety gate (pass, fail, skip) and actionable fixes:
102
+ ```bash
103
+ npx multimodel-dev-os improve validate <proposal-file> --target <path>
104
+ ```
105
+
106
+ ### diff
107
+ Previews the changes grouped by operation type (Create, Append, Replace) in a token-safe truncated format:
108
+ ```bash
109
+ npx multimodel-dev-os improve diff <proposal-file> --target <path>
110
+ ```
111
+
112
+ ### apply
113
+ Deterministically executes the operations listed in the approved proposal file. Refuses to run without the `--approved` flag. Prints pre-apply summaries and detailed idempotent run indicators.
114
+ ```bash
115
+ npx multimodel-dev-os improve apply <proposal-file> --target <path> --approved
116
+ ```
117
+
118
+ ### log
119
+ Lists the history of applied proposals from the audit log:
120
+ ```bash
121
+ npx multimodel-dev-os improve log --target <path>
122
+ ```
123
+
124
+ ---
125
+
126
+ ## 5. Audit Logging
127
+
128
+ Every execution of `improve apply` writes an entry to the append-only JSON Lines audit log. Hardened in v2.4.1, it also writes records for failed/refused attempts:
129
+ * **Log Location**: `.ai/proposals/apply-log.jsonl`
130
+ * **Log Exclusion**: Automatically ignored by Git via `.gitignore` and excluded from AI scanner runs.
131
+
132
+ Each record conforms to `.ai/intelligence/apply-log.schema.json` and contains:
133
+ * `id`: Unique execution identifier (`apply-YYYYMMDD-HHMMSS`)
134
+ * `proposal_id`: Proposal file identifier
135
+ * `applied_at`: ISO timestamp of execution
136
+ * `target`: Resolved workspace target path
137
+ * `operations_count`: Total operations performed
138
+ * `files_changed`: List of relative paths modified
139
+ * `before_hashes`: SHA-256 file hashes before execution
140
+ * `after_hashes`: SHA-256 file hashes after execution
141
+ * `status`: `success`, `failed`, or `refused`
142
+ * `refused_reason`: Reason why validation was refused (when applicable)
143
+ * `notes`: Additional run information or failure reasons
144
+
145
+ ---
146
+
147
+ ## 6. Recommended Workflow
148
+
149
+ To ensure safety, consistency, and clarity, follow this workflow:
150
+
151
+ 1. **validate**: Run `npx multimodel-dev-os improve validate .ai/proposals/proposal-xxxx.md` to run safety gate audits.
152
+ 2. **diff**: Run `npx multimodel-dev-os improve diff .ai/proposals/proposal-xxxx.md` to review planned changes.
153
+ 3. **manually review**: Verify the proposal contents, target paths, and operation constraints.
154
+ 4. **apply**: Run `npx multimodel-dev-os improve apply .ai/proposals/proposal-xxxx.md --approved` to write modifications locally.
155
+ 5. **run tests**: Manually run verification tests (e.g., `npm run verify` or custom test runner).
156
+ 6. **commit**: Commit the changes manually to version control.
@@ -7,6 +7,7 @@
7
7
  3. **Zero dependencies** — no runtime, no package manager, no build step
8
8
  4. **Non-destructive** — installers never overwrite, adapters never conflict
9
9
  5. **Progressive complexity** — start with `AGENTS.md`, add orchestrator later
10
+ 6. **Safety-first** — all write operations require explicit developer approval
10
11
 
11
12
  ## Layer Architecture
12
13
 
@@ -15,24 +16,36 @@
15
16
  │ Human Layer │
16
17
  │ README.md CONTRIBUTING.md docs/ │
17
18
  ├──────────────────────────────────────┤
18
- Source of Truth Layer
19
+ Layer 1: Source of Truth
19
20
  │ AGENTS.md MEMORY.md TASKS.md │
20
21
  │ RUNBOOK.md │
21
22
  ├──────────────────────────────────────┤
22
- AI Operating Layer
23
+ Layer 2: AI Operating Layer
23
24
  │ .ai/config.yaml │
24
- │ .ai/agents/multimodel-orchestrator.md
25
- │ .ai/context/ .ai/prompts/
26
- │ .ai/skills/ .ai/checks/
27
- │ .ai/session-logs/ .ai/templates/
25
+ │ .ai/agents/ .ai/context/
26
+ │ .ai/prompts/ .ai/skills/
27
+ │ .ai/checks/ .ai/templates/
28
+ │ .ai/models/ .ai/schema/
28
29
  ├──────────────────────────────────────┤
29
- Adapter Layer
30
+ Layer 3: Adapter Layer
30
31
  │ adapters/codex/ │
31
32
  │ adapters/antigravity/ │
32
33
  │ adapters/cursor/ │
33
34
  │ adapters/claude/ │
34
35
  │ adapters/gemini/ │
35
36
  │ adapters/vscode/ │
37
+ ├──────────────────────────────────────┤
38
+ │ Layer 4: Intelligence Layer │
39
+ │ .ai/intelligence/ (memory, handoff)│
40
+ │ .ai/registries/ (workflows, │
41
+ │ capabilities, tools) │
42
+ │ .ai/proposals/ (improvements) │
43
+ │ .ai/policies/ (safety gates) │
44
+ ├──────────────────────────────────────┤
45
+ │ Layer 5: CLI Dashboard & Plugins │
46
+ │ dashboard / ui (TUI Command Center) │
47
+ │ plugin list/show/validate/install │
48
+ │ onboard / adapter sync │
36
49
  └──────────────────────────────────────┘
37
50
  ```
38
51
 
@@ -43,6 +56,10 @@
43
56
  3. **AI agents** read their adapter file + root files
44
57
  4. **Agents write** results back to `TASKS.md`, `MEMORY.md`, and session logs
45
58
  5. **Orchestrator** coordinates multi-agent workflows via session logs
59
+ 6. **Memory engine** indexes codebase state into hash-compressed summaries
60
+ 7. **Feedback loop** captures developer corrections and compiles learning rules
61
+ 8. **Proposal engine** drafts improvements, validates safety gates, and applies approved changes
62
+ 9. **Handoff compiler** generates token-compressed session context for agent transfers
46
63
 
47
64
  ## File Ownership
48
65
 
@@ -54,6 +71,11 @@
54
71
  | `RUNBOOK.md` | Human | All agents | Human |
55
72
  | `.ai/config.yaml` | Human | System | Human |
56
73
  | `.ai/session-logs/*.md` | Agents | Next agent | Current agent |
74
+ | `.ai/intelligence/memory.*` | System | All agents | CLI (`memory build`) |
75
+ | `.ai/intelligence/handoff.md` | System | Next agent | CLI (`handoff build`) |
76
+ | `.ai/intelligence/feedback-log.jsonl` | System | CLI | CLI (`feedback add`) |
77
+ | `.ai/proposals/*.md` | System | Human + CLI | CLI (`improve propose`) |
78
+ | `.ai/registries/*.yaml` | System | CLI | CLI (`init`) |
57
79
  | `adapters/*/` | Community | Specific tool | Maintainers |
58
80
 
59
81
  ## Security Considerations
@@ -62,3 +84,5 @@
62
84
  - Handoff logs may contain sensitive context — gitignored by default
63
85
  - Adapter config files should not contain API keys or tokens
64
86
  - Use `.env` files (gitignored) for secrets, referenced in `RUNBOOK.md`
87
+ - Memory indexes, feedback logs, and proposals are gitignored by default
88
+ - The proposal `apply` command enforces 12 safety gates including path boundary checks
@@ -0,0 +1,24 @@
1
+ # Model Capability Registry
2
+
3
+ The **Capability Registry** manages and scores AI models across cognitive, speed, and cost vectors, eliminating hardcoded model routing logic.
4
+
5
+ ---
6
+
7
+ ## 1. Capabilities Score Matrix
8
+
9
+ Models are scored in `.ai/registries/capabilities.yaml` across six primary vectors:
10
+ * `coding` — Syntax accuracy, language compliance, and refactoring competence.
11
+ * `reasoning` — Multi-file plan generation and logical constraint auditing.
12
+ * `repo-scan` — Needle-in-a-haystack retrieval accuracy at massive context scales.
13
+ * `agentic-duration` — Ability to execute long-running task loops without losing parameters.
14
+ * `mcp-compliance` — Native Model Context Protocol (MCP) tool bindings.
15
+ * `local-offline` — Suitability for local resources (e.g. running via Ollama/Llama.cpp).
16
+
17
+ ---
18
+
19
+ ## 2. Dynamic Routing Engine
20
+
21
+ When executing workflow steps:
22
+ 1. **Workflows Query**: The workflow profile specifies the minimum capability scores required for each step (e.g., `planning` requires `reasoning: 0.85`, while `coding` requires `coding: 0.80`).
23
+ 2. **Capabilities Filter**: The router filters active models that meet or exceed these score thresholds.
24
+ 3. **Cost-Speed Trade-off**: From the matching models, the engine selects the candidate that optimizes cost, latency, or user-selected flags (e.g. `--local` or `--low-cost`).
@@ -1,34 +1,81 @@
1
- # Comparison Guide: multimodel-dev-os vs. Alternatives
1
+ # Comparison Guide: MultiModel Dev OS vs. Alternatives
2
2
 
3
- Selecting how to manage AI instructions inside a codebase significantly impacts developer speed, token consumption, and context drift. This document contrasts `multimodel-dev-os` with standard configurations.
3
+ Selecting how to manage AI instructions inside a codebase impacts developer speed, token consumption, and context drift. This document contrasts `multimodel-dev-os` with common alternatives.
4
4
 
5
- ## The Strategy Matrix
5
+ ---
6
+
7
+ ## Quick Decision Matrix
6
8
 
7
- | Feature | AGENTS.md Only (DIY) | Tool-Specific Prompt Packs | MultiModel Dev OS (`.ai/` + CLI) |
8
- | :--- | :--- | :--- | :--- |
9
- | **Tool Portability** | Manual copying when changing tools | Zero portability (highly vendor-locked) | **Portable & Vendor-Neutral** (Single source of truth) |
10
- | **Instruction Synchronization** | Manually synchronizing `.cursorrules`, `CLAUDE.md`, etc. | No synchronization (rules drift quickly) | **Automated** (Adapters mirror root rules instantly) |
11
- | **Token Optimization** | No budgeting (full rules read every time) | Vague, static rules | **Caveman Mode** (slashes token footprints by **~79%**) |
12
- | **Structural Segregation** | Flat single-file instructions (easily cluttered) | Disorganized configs | **Concise modular directories** (Context, Skills, Prompts, Checks) |
13
- | **CI/CD Quality Gates** | None (no structural safety checks) | None | **Verify subcommand** (`npm run verify` protects standard formats) |
14
- | **Standardized Hand-offs** | Manual human explanations | Manual human explanations | **Sequential hand-off protocol** with structured session logs |
15
- | **Cost Playbook Alignment** | None | None | **12 Playbook mappings** (RAG scoping, batching, caching) |
9
+ | Feature | AGENTS.md Only (DIY) | .cursorrules / CLAUDE.md | Prompt Packs | **MultiModel Dev OS** |
10
+ | :--- | :--- | :--- | :--- | :--- |
11
+ | **Multi-tool support** | Manual duplication | Single tool only | Vendor-locked | **6+ tools from one source** |
12
+ | **Instruction sync** | Copy-paste drift | No sync possible | No sync | **Auto adapter sync** |
13
+ | **Token optimization** | Full rules every time | No budgeting | ❌ Static rules | **Caveman Mode (79%)** |
14
+ | **Structural validation** | None | None | None | **validate + doctor + verify** |
15
+ | **Templates** | Start from scratch | Start from scratch | ⚠️ Generic starters | **6 production-ready templates** |
16
+ | **Memory & learning** | None | ❌ None | None | **Hash-compressed memory + feedback loops** |
17
+ | **CI/CD integration** | None | None | None | ✅ **214+ assertion verification suite** |
18
+ | **Onboarding existing repos** | ❌ Manual setup | ❌ Manual setup | ❌ Manual setup | ✅ **`onboard analyze` workflow** |
19
+ | **Interactive TUI Dashboard** | ❌ None | ❌ None | ❌ None | ✅ **Zero-dependency TUI Menu** |
20
+ | **Declarative Plugins** | ❌ None | ❌ None | ❌ None | ✅ **Safe whitelist YAML plugins** |
21
+ | **Cost** | Free | Free | Free–Paid | ✅ **Free & open source** |
16
22
 
17
23
  ---
18
24
 
19
- ## Detailed Evaluation
25
+ ## Detailed Comparison
26
+
27
+ ### 1. The DIY Approach (Single AGENTS.md)
28
+
29
+ Many developers start by dropping a single `AGENTS.md` in their project root. This is better than nothing, but it breaks down fast:
30
+
31
+ - **Drift:** You update a build command in `AGENTS.md`, but forget to update Cursor's `.cursorrules`. Cursor keeps running the old build script.
32
+ - **Clutter:** The file bloats with styling rules, deployment procedures, and troubleshooting steps. The AI spends 10,000+ tokens reading instructions every turn.
33
+ - **No validation:** There's no way to check if your instructions are well-formed or complete.
34
+
35
+ ### 2. Tool-Specific Rules (`.cursorrules`, `CLAUDE.md`, etc.)
36
+
37
+ Each tool has its own configuration format. Using only one locks you into that vendor:
38
+
39
+ - **No portability:** If your team uses Cursor for coding and Claude Code for debugging, you must manually translate and duplicate rules for both.
40
+ - **No collaboration:** Co-workers using different IDEs or agents can't benefit from the same context.
41
+ - **No onboarding:** New team members must discover and configure each tool manually.
42
+
43
+ ### 3. Community Prompt Packs
20
44
 
21
- ### 1. The DIY Approach (AGENTS.md Only)
22
- Many developers start by dropping a single `AGENTS.md` file in their root. While better than nothing, this approach quickly breaks down:
23
- - **Drift:** You modify a build command in `AGENTS.md`, but forget to update Cursor's `.cursorrules`. Cursor continues running the old build script, causing confusing errors.
24
- - **Clutter:** A single markdown file gets bloated with styling guidelines, deployment procedures, and troubleshooting steps. Soon, the AI spends 10,000 tokens just reading instructions on every turn.
45
+ Various community projects offer pre-built instruction sets for specific tools:
46
+
47
+ - **Vendor lock:** Prompt packs are built for one tool switching means starting over.
48
+ - **Generic rules:** Community packs optimize for broad use, not your specific project architecture.
49
+ - **No intelligence:** No memory, no feedback loops, no self-improvement capabilities.
50
+
51
+ ### 4. MultiModel Dev OS
52
+
53
+ `multimodel-dev-os` creates a lightweight, vendor-neutral layer that decouples your project's rules from specific tools:
54
+
55
+ - **Write once, read everywhere:** Define build parameters once in `AGENTS.md`. Adapters expose these configurations cleanly to Cursor, Claude, Antigravity, VS Code, Codex, and more.
56
+ - **Continuous integration:** Add `multimodel-dev-os verify` to your CI pipeline or pre-commit hooks to guarantee all developers share healthy, correctly-formatted AI configurations.
57
+ - **Self-improving:** The feedback loop compiles developer corrections into reusable rules. The proposal engine suggests codebase improvements with strict safety gates.
58
+ - **Instant onboarding:** The `onboard analyze` command scans existing projects and recommends the optimal template and adapter configuration.
59
+
60
+ ### 5. Agentic CLIs & Extensions (Aider, Roo Code, Continue, Cline)
61
+
62
+ While advanced AI coding assistants like **Aider**, **Roo Code (Cline)**, and **Continue** provide powerful code generation and agentic capabilities, they serve a different layer of the stack than MultiModel Dev OS:
63
+
64
+ - **Complementary, Not Competitive:** MultiModel Dev OS is not a chatbot or code generator. It is a **configuration and governance layer**. It formats and syncs workspace context so that tools like Aider, Roo Code, and Continue can read the exact same project boundaries.
65
+ - **Rules Portability:** Roo Code or Continue read custom instructions, but they are stored in tool-specific config formats. If you switch to Aider in the CLI, you have to recreate those instructions. MultiModel Dev OS bridges this gap by auto-generating target configurations from `AGENTS.md`.
66
+ - **Quality Gates & Backups:** MultiModel Dev OS provides built-in `validate`, `doctor`, and `onboard` commands, plus structured proposal safety gates. This prevents external agents from making unchecked, destructive changes directly to your main branch.
67
+
68
+ ---
25
69
 
26
- ### 2. Tool-Specific Prompt Packs
27
- Using tools like `Cursorrules` websites or Claude Code presets locks your project configuration into one vendor's ecosystem:
28
- - **Vendor Lock:** If your team uses Cursor for coding and Claude Code for debugging, you must duplicate and manually translate the syntax for both tools.
29
- - **No Collaboration:** Co-workers using different IDEs or terminal utilities cannot benefit from the unified context.
70
+ ## When to Use What
30
71
 
31
- ### 3. MultiModel Dev OS
32
- `multimodel-dev-os` establishes a lightweight, vendor-neutral layer that decouples your project's rules from specific tools:
33
- - **Translate once, read everywhere:** You write build parameters once in the root. The CLI and adapters expose these configurations cleanly to Cursor, Claude, Antigravity, VS Code, and Codex.
34
- - **Continuous Integration:** You can add `multimodel-dev-os verify` to your CI pipeline or pre-commit hooks to guarantee that all developers share healthy, correctly-formatted AI configurations.
72
+ ```
73
+ Do you use only one AI coding tool?
74
+ ├── Yes Tool-specific rules (e.g., .cursorrules) might be enough
75
+ │ But consider MMDO if you want templates, validation, or memory
76
+
77
+ └── No → Do you switch between 2+ tools?
78
+ ├── Yes → MultiModel Dev OS is built for this
79
+ └── Maybe later → Start with MMDO anyway — it's backward-compatible
80
+ and takes 30 seconds to set up
81
+ ```
@@ -39,8 +39,8 @@ To guarantee validation compliance:
39
39
 
40
40
  ---
41
41
 
42
- ## 4. v1.1.0 Compatibility Guarantee
42
+ ## 4. Compatibility Guarantee
43
43
 
44
- The supported tool matrix and custom specifications listed here represent the officially frozen contracts of MultiModel Dev OS `v1.1.0`. Any backward-compatible extensions introduced in subsequent `1.x` releases will build on top of these mappings without breaking current project integrations.
44
+ The supported tool matrix and custom specifications listed here represent the officially frozen contracts of MultiModel Dev OS. The core Layer 1 protocol has been stable since `v1.0.0` and all subsequent `v1.x` and `v2.x` releases maintain full backward compatibility.
45
45
 
46
46
  Explore our [Stable Protocol Specification](/stable-protocol) or [Upgrade & Migration Guide](/migration-guide) for details.
@@ -0,0 +1,105 @@
1
+ # Interactive TUI Dashboard
2
+
3
+ MultiModel Dev OS provides an interactive, terminal-based command center to manage all repository operations, adapter syncs, memory builds, proposals, and diagnostics from a single interface.
4
+
5
+ ## Launching the Dashboard
6
+
7
+ Run either of the following commands to launch the TUI:
8
+
9
+ ```bash
10
+ npx multimodel-dev-os@latest dashboard
11
+ # or the short alias
12
+ npx multimodel-dev-os@latest ui
13
+ ```
14
+
15
+ ---
16
+
17
+ ## Controls
18
+
19
+ The dashboard is built using Node.js's native `readline` module. It does not load external UI frameworks or npm prompt dependencies, keeping the execution extremely fast and light.
20
+
21
+ * **Up / Down Arrows**: Navigate through the menu options.
22
+ * **Return (Enter)**: Select and run the highlighted command or enter a submenu.
23
+ * **Escape / Ctrl+C**: Exit the dashboard or return to the shell.
24
+
25
+ ---
26
+
27
+ ## Dashboard Structure
28
+
29
+ The dashboard contains a hierarchical structure mapping to all MMDO CLI actions:
30
+
31
+ ```mermaid
32
+ graph TD
33
+ Dashboard[TUI Command Center]
34
+ Dashboard --> Status[Active Workspace Status]
35
+ Dashboard --> Scan[Codebase Scan Analysis]
36
+ Dashboard --> Onboard[Onboarding Operations...]
37
+ Dashboard --> Adapter[Adapter Synchronization...]
38
+ Dashboard --> Memory[Memory & Intelligence...]
39
+ Dashboard --> Feedback[Developer Feedback Loops...]
40
+ Dashboard --> Quality[Quality Gates & Diagnostics...]
41
+ Dashboard --> Plugins[Plugins Status Overview]
42
+ ```
43
+
44
+ ### Main Sections
45
+
46
+ 1. **Active Workspace Status**: Runs the equivalent of `status` to print the current state of packages, active workspace structure, and recommendations.
47
+ 2. **Codebase Scan Analysis**: Runs the equivalent of `scan` to analyze framework signals and potential token sink risks.
48
+ 3. **Onboarding Operations**:
49
+ * Analyze Repository (`onboard analyze`)
50
+ * Recommendation Summary (`onboard recommend`)
51
+ * Generate Integration Plan (`onboard plan`)
52
+ * Apply Configs in Dry Run (`onboard apply --dry-run`)
53
+ * View Status Heuristics (`onboard status`)
54
+ 4. **Adapter Synchronization**:
55
+ * Check Sync Status (`adapter status`)
56
+ * Sync All rule files in Dry Run (`adapter sync all --dry-run`)
57
+ * Diff Cursor Rules (`adapter diff cursor`)
58
+ * Diff Claude Rules (`adapter diff claude`)
59
+ 5. **Memory & Intelligence**:
60
+ * Memory Build Index (`memory build`)
61
+ * Memory Refresh Changes (`memory refresh`)
62
+ * Memory Diff Index (`memory diff`)
63
+ * Handoff Build Session Summary (`handoff build`)
64
+ * Print Session Summary to Console (`handoff show`)
65
+ 6. **Developer Feedback Loops & Proposals**:
66
+ * List developer corrections (`feedback list`)
67
+ * Summarize feedback logs (`feedback summarize`)
68
+ * Propose improvement proposal (`improve propose`)
69
+ * Review active proposals list (`improve review`)
70
+ 7. **Quality Gates & Diagnostics**:
71
+ * Run Advisory Diagnostics (`doctor`)
72
+ * Strict Schema Compliance (`validate`)
73
+ * Run Release verification tests (`verify`)
74
+ 8. **Plugins Status Overview**: Checks the status of all installed declarative plugins (`plugin status`).
75
+
76
+ ---
77
+
78
+ ## Zero-Hanging CI Fallback (Non-Interactive Mode)
79
+
80
+ In automated environments (CI/CD pipelines, GitHub Actions) or when piped, the terminal does not have interactive stdin capabilities.
81
+
82
+ To prevent execution from hanging indefinitely, the TUI automatically detects non-TTY environments:
83
+ * **Interactive Mode**: Triggered when both `process.stdout.isTTY` and `process.stdin.isTTY` are true.
84
+ * **Headless Fallback**: Triggered when run in non-interactive shells, or if `--dry-run` is passed. The dashboard immediately prints a structured list of all menu options along with their corresponding CLI execution strings and exits cleanly.
85
+
86
+ Example headless output:
87
+
88
+ ```txt
89
+ 🧠 MultiModel Dev OS Command Center (Headless mode)
90
+ ==================================================
91
+ - Active Workspace Status: equivalent command: "npx multimodel-dev-os status"
92
+ - Codebase Scan Analysis: equivalent command: "npx multimodel-dev-os scan"
93
+ - Onboarding Operations...
94
+ └─ Onboard: Analyze Repository: equivalent command: "npx multimodel-dev-os onboard analyze"
95
+ └─ Onboard: Recommendation Summary: equivalent command: "npx multimodel-dev-os onboard recommend"
96
+ ...
97
+ ```
98
+
99
+ ---
100
+
101
+ ## Safety Controls
102
+
103
+ 1. **No Destructive Operations**: Subcommands that modify files (such as `adapter sync`, `onboard apply`, or `improve apply`) are run in **dry-run** mode by default inside the dashboard menu.
104
+ 2. **Bold Command Printing**: Before executing any command from the menu, the dashboard prints the exact command it is running (e.g. `npx multimodel-dev-os memory build`). This ensures that developers can learn the underlying CLI commands and transition to direct CLI operations when scripting.
105
+ 3. **Subprocess Isolation**: When running subprocess actions, the TUI temporarily detaches keyboard listeners and raw mode, allowing the command to render its output and handle prompts cleanly before restoring TUI control.
package/docs/demo.md CHANGED
@@ -1,79 +1,42 @@
1
- # Interactive CLI & Terminal Demo
1
+ # Guided Demo Workflows
2
2
 
3
- Experience the clean scaffolding pipeline and zero-dependency commands of `multimodel-dev-os` right from your terminal.
3
+ Experience MultiModel Dev OS in action. We provide structured, interactive demo workflows that you can copy-paste and run in under 2 minutes.
4
4
 
5
5
  ---
6
6
 
7
- ## Visual Initialization Pipeline
7
+ ## Interactive Mockup
8
8
 
9
- Here is how the automatic bootstrapping pipeline looks when initializing a project with a template:
9
+ Here is the automatic onboarding, scaffolding, and sync pipeline in action:
10
10
 
11
11
  ![Terminal Scaffold Mockup](/assets/terminal-demo.svg)
12
12
 
13
13
  ---
14
14
 
15
- ## Under the Hood: CLI Commands
15
+ ## 5 Guided Workflows
16
16
 
17
- `multimodel-dev-os` is built entirely on native Node.js libraries, keeping execution lightning-fast with **zero third-party runtime dependencies**.
17
+ Select a workflow to get started:
18
18
 
19
- ### 1. The `init` Scaffolding Engine
20
-
21
- Bootstraps the shared workspace contract files and target directory setups.
22
-
23
- ```bash
24
- # Global zero-install setup
25
- npx multimodel-dev-os@latest init
26
-
27
- # Scaffold a specific technology stack template and set up adapter status automatically
28
- npx multimodel-dev-os@latest init --template nextjs-saas --adapter cursor --adapter claude
29
-
30
- # Run a dry-run preview to verify planned file actions without modifying the disk
31
- npx multimodel-dev-os@latest init --dry-run
32
- ```
33
-
34
- #### Core Scaffolding Activities:
35
- - **Directory Guarantee:** Assures target paths (`.ai/context`, `.ai/skills`, `.ai/session-logs`) exist.
36
- - **Contract Scaffold:** Creates the root source-of-truth instructions (`AGENTS.md`, `MEMORY.md`, `TASKS.md`, `RUNBOOK.md`).
37
- - **Adapter Linking:** Translates and copies rule files (like `.cursorrules`, `CLAUDE.md`, or `.vscode/`) directly to your workspace root.
38
-
39
- ---
40
-
41
- ### 2. The `templates` Gallery Inspector
42
-
43
- Allows developers to view, inspect, and choose real-world configuration templates.
44
-
45
- ```bash
46
- # List all pre-configured stack templates
47
- npx multimodel-dev-os templates
48
-
49
- # Display detailed configuration rules and files of a specific template
50
- npx multimodel-dev-os show-template nextjs-saas
51
- ```
19
+ | Workflow Demo | Description | Duration |
20
+ |---|---|---|
21
+ | 🚀 **[Safe Repo Onboarding](/demos/existing-repo-onboarding)** | Safely analyze and bootstrap a real, existing project. | ~2 mins |
22
+ | 🔄 **[Universal Adapter Sync](/demos/adapter-sync)** | Write rules once in `AGENTS.md` and sync Cursor, Claude, and Gemini. | ~1 min |
23
+ | 🤝 **[Multi-Agent Handoff](/demos/multi-agent-handoff)** | Seamlessly pass session context between terminal and editor agents. | ~2 mins |
24
+ | 🔁 **[Safe Improvement Loop](/demos/safe-improvement-loop)** | Capture user feedback, propose upgrades, and apply with safety gates. | ~3 mins |
25
+ | 🩺 **[Release Verification](/demos/release-check)** | Run pre-flight checks and verify version alignment before npm publishing. | ~1 min |
52
26
 
53
27
  ---
54
28
 
55
- ### 3. The `validate` Quality Gate
56
-
57
- Enforce strict formatting conventions inside your repository before checking in code:
58
-
59
- ```bash
60
- # Strict directory schema and file validation checkup
61
- npx multimodel-dev-os validate
62
- ```
63
-
64
- If any core agent file (`AGENTS.md`, `MEMORY.md`) is missing or is structurally invalid, the CLI exits with non-zero exit codes to fail pull requests or pre-commit hooks, guarding workspace health.
65
-
66
- ---
29
+ ## Under the Hood: Core CLI Commands
67
30
 
68
- ### 4. The `doctor` Advisory Inspector
31
+ MultiModel Dev OS is a zero-dependency CLI. Here are the main commands that power these workflows:
69
32
 
70
- An advisory checkup to diagnose environment compatibility issues:
33
+ ### 1. Scaffolding & Setup
34
+ - `init`: Bootstraps shared workspace contract files and enables target adapters.
35
+ - `onboard analyze`: Safely scans an existing repository to suggest the best template fit.
71
36
 
72
- ```bash
73
- # Diagnostic audit of gitignore rules and IDE adapter overrides
74
- npx multimodel-dev-os doctor
75
- ```
37
+ ### 2. Synchronization & Verification
38
+ - `adapter sync`: Pushes rules in `AGENTS.md` out to `.cursorrules`, `CLAUDE.md`, `.gemini/settings`, and more.
39
+ - `validate`: Enforces structural compliance, perfect for pre-commit hooks and CI.
40
+ - `doctor`: Audits `.gitignore` hygiene and active adapter status.
76
41
 
77
- The doctor warns you if:
78
- - IDE cache directories (like `node_modules` or `.vitepress/dist`) are not listed in your `.gitignore` file.
79
- - Enabled adapter configurations inside `.ai/config.yaml` lack corresponding physical rule files on the disk.
42
+ For the full CLI command reference, see the **[CLI Documentation](/CLI)**.