Opt editor install

opt-editor Install

This is NOT the opt-editor you know. Read node_modules/@reopt-ai/opt-editor/dist/docs/ before writing code.

When to apply

Consumer project depends on @reopt-ai/opt-editor. Triggers: "install", "init", "setup", "upgrade", "update" — with or without an opt- / editor prefix.

Invocation

/opt-editor-install              # Auto-branch (missing → init, installed → upgrade)
/opt-editor-install --with-ai    # Init + AI streaming integration
/opt-editor-install 1.0.0        # Upgrade to a specific version
/opt-editor-install --dry-run    # Analyze only

Step 1 — Pin agent rules into AGENTS.md / CLAUDE.md

Source: the module's own agent-rules file once it ships one (@reopt-ai/opt-editor does not, as of 1.1.2). Fallback: agent-rules.md bundled with this skill. Wrap content between:

<!-- BEGIN:reopt/opt-editor-agent-rules -->
…content from source…
<!-- END:reopt/opt-editor-agent-rules -->

Idempotent: replace only between markers.

Step 2 — Consumer-side setup (this skill owns; docs cannot)

1. Public npm registry — no token or scoped .npmrc entry is required. Inspect the project .npmrc and npm config get @reopt-ai:registry; if the scope still resolves to GitHub Packages, remove only the legacy project entry @reopt-ai:registry=https://npm.pkg.github.com. Preserve unrelated registry/auth settings, and ask before changing user/global npm config.

2. Prereqs — Node 18+, React 19+, bun or npm. AI integration uses optional peers ai >= 7 and zod >= 3; do not install them for a non-AI editor.

3. App wiring — properties of the consumer app:

   • Editor CSS import at the app root.
   • Catalog file (catalog.ts or similar) — block-definition registry.
   • AI endpoint (when --with-ai): a Vercel AI SDK–compatible route.

4. Doctor — npx @reopt-ai/opt-cli doctor runs the audit (unified design CLI; there is no opt-editor-cli).

Step 3 — Route to module docs

Task signal	Read
Start here — doc index	dist/docs/index.md
Getting started / install / upgrade	dist/docs/01-getting-started.md
API (components, hooks, store, serialization, types)	dist/docs/02-api/
AI streaming integration	dist/docs/02-api/04-ai-stream.md, dist/docs/03-recipes/03-ai-streaming.md
High-level AI ops / agent-mode tools (EditorOperation, OperationCompiler)	dist/docs/03-recipes/08-editor-operations.md
Diff-mode suggestion review (mode="diff")	dist/docs/03-recipes/09-diff-review-integration.md
Recipes (basic, custom blocks, markdown, image, …)	dist/docs/03-recipes/
Troubleshooting	dist/docs/05-troubleshooting.md

Pipeline (auto-branch)

#	Step	Init	Upgrade
1	Detect current state	✓	✓
2	Public-registry preflight + legacy override cleanup	✓	✓
3	Install / update package	✓	✓
4	CSS import check	✓	✓
5	Catalog generation	✓	–
6	Editor component generation	✓	–
7	Breaking-change edits	–	✓
8	Deprecated fixes (opt-in)	–	✓
9	Doctor (environment audit) + summary	✓	✓

Detailed procedure lives in module docs — start at dist/docs/index.md, then dist/docs/01-getting-started.md. Read before acting.

Safety

• Never upgrade without an impact scan (run --dry-run first).
• Confirm before overwriting existing files.
• Apply breaking-change edits in logical groups — never bulk-apply.
• Do not finish until tsc --noEmit passes.
• Always provide a rollback path.

Verify

1. npx @reopt-ai/opt-cli doctor passes.
2. npx tsc --noEmit passes.
3. Editor mounts and StaticRenderer renders a stored EditorSpec (its content) without console warnings.