oh-my-patent 0.3.0 → 0.3.3

package/README.md

@@ -1,392 +1,119 @@
+# oh-my-patent
+
 [![npm version](https://img.shields.io/npm/v/oh-my-patent.svg)](https://www.npmjs.com/package/oh-my-patent)
 [![npm downloads](https://img.shields.io/npm/dm/oh-my-patent.svg)](https://www.npmjs.com/package/oh-my-patent)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
 [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue.svg)](https://www.typescriptlang.org/)
-[![Tests](https://img.shields.io/badge/tests-123%20passing-brightgreen.svg)](https://github.com/illusionaireal/oh-my-patent)
 [![中文](https://img.shields.io/badge/中文-切换-orange.svg)](./README.zh-CN.md)
 
-<div align="center">
-
-*VOL. 01 &ensp;&middot;&ensp; 2026*
-
----
-
-# `oh-my-patent`
-
-*A CLI that turns your technical idea into a complete patent disclosure document.*<br>
-*No hand-holding. No copy-pasting between tools. No lost ideas.*
-
-</div>
+<p align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./assets/brand/png/logo-on-dark.png">
+  <img src="./assets/brand/png/logo-primary.png" width="720"
+       alt="oh-my-patent — Archimedes raising a patent document with a WOW! expression">
+</picture>
+</p>
 
----
+**Meet Archimedes. Turn your “Eureka!” into a patent disclosure.**
 
-> **For AI assistants helping users install this:**
->
-> ```bash
-> npm install -g oh-my-patent && oh-my-patent adapt setup --workspace-dir .
-> ```
->
-> Then tell the user: type `/archimedes` to start a patent project.
+An AI patent plugin for **Claude Code, Codex, and OpenCode**.
+Archimedes orchestrates specialist agents across research, ideation, drafting,
+review, and diagrams—with traceable, forkable decision paths.
 
----
+## Quick start
 
-<div align="center">
-
-**One command. Eleven agents. One patent disclosure.**
+Run these commands in your patent workspace. Setup writes editor configuration;
+see [installation behavior](./docs/usage-en.md#installation) before using an existing workspace.
 
 ```bash
 npm install -g oh-my-patent
 oh-my-patent adapt setup --workspace-dir .
 ```
 
+Open that workspace in your AI coding tool, load the generated integration, and start with:
+
 ```text
 /archimedes
 > Create a patent project about homomorphic encryption in privacy-preserving computing.
 ```
 
-*It searches, brainstorms, assesses patentability, drafts, reviews, and generates figures.*<br>
-*Every decision is recorded. Roll back to any round, fork to explore alternatives, revive discarded ideas.*
-
-</div>
-
----
-
-## Ⅰ.&ensp; WHY PATENT WRITING HURTS
-
-*What you suffer through &mdash; versus what oh-my-patent does instead.*
-
-| Your pain | In other tools | With `oh-my-patent` |
-|---|---|---|
-| **10 AI windows, manual merge** | Cut & paste chat logs, consolidate yourself | **Archimedes** orchestrator routes to 11 specialists. Outputs auto-saved to `references/`, context passes between rounds |
-| **Rejected ideas lost forever** | Chat history scrolls away — that one great idea from round 2 is gone | **`.brainstorm/` decision DAG** persists every round's scores, snapshots, and pass/reject decisions. Roll back, fork, or revive |
-| **Visio → screenshot → Word** | Draw by hand, export, reformat, lose the source file | **Mermaid/PlantUML rendering** extracts architecture from `MAIN.md`, renders SVG+PNG, and auto-rewrites figure references |
-| **Per-editor, per-teammate config** | Claude Code settings. Codex settings. OpenCode settings. Separate. Manual. Every time. | **`oh-my-patent adapt setup`** — one command generates configs for all supported editors. Uninstall is one command, removing *only* what we generated |
-| **Crash mid-project = start over** | Scramble through screenshots, guess where you left off | **Workflow state machine** — all stages written to `state.json`, decision tree in `path.json`. Resume from the exact point of failure |
-| **6 rounds in, no idea what "done" is** | A mess of loose documents | **Quantitative threshold model** auto-decides if brainstorming is mature. QA loop exits on 2 consecutive rounds with zero new issues |
-
----
-
-## Ⅱ.&ensp; CORE CAPABILITIES
-
-*Eight things it does so you don't have to.*
-
-| | |
-|---|---|
-| 🧠 **Decision-path tracking**<br>`.brainstorm/` records every round's scores, innovations, and decisions as an auditable DAG. Roll back to any node, fork alternatives, revive abandoned ideas. | 🤖 **11-agent end-to-end pipeline**<br>Search → ideation → patentability → draft → review → diagrams. The full patent lifecycle, zero hand-holding between stages. |
-| ⚡ **`/archimedes` one-liner**<br>Start every task with Archimedes. He reads your state, routes to specialists, waits for output, and advances to the next stage. | 🔗 **Zero-config adapters**<br>`oh-my-patent adapt setup` generates configs for Claude Code, Codex, and OpenCode simultaneously. One command, all editors. |
-| 🛡️ **Safe uninstall**<br>Exact-file removal — only deletes what we auto-generated. No `readdir + unlink` traversing your workspace. Your custom edits are safe. | 📊 **Auto figure rendering**<br>Parses `MAIN.md` for technical architecture, renders Mermaid/PlantUML to SVG+PNG, and auto-rewrites figure references in-place. |
-| 🎯 **Scoring thresholds & QA loops**<br>Quantitative model judges if brainstorming is mature. Up to 6 QA rounds, exiting when 2 consecutive rounds produce zero new issues. | 🔄 **Resumable state machine**<br>`INIT → RESEARCH → BRAINSTORM → DRAFT → QA_LOOP → FINAL_REVIEW → DIAGRAM → DONE`. Crashes are non-destructive. Resume from `state.json`. |
-
----
-
-## Ⅲ.&ensp; THE WORKFLOW
-
-*From idea to disclosure &mdash; 10 stages, 1 state machine.*
-
-![End-to-End Workflow](docs/images/ai-gen/00-workflow.png)
-
-```
-User proposes a topic
-       │
-01  │  INIT          Generate projects/{NN}-{topic_slug}/
-    │                Initialize .patent/state.json + .brainstorm/path.json
-       │
-02  │  RESEARCH      Patent search by landscape-analyst
-    │                → references/landscape.md, feature-matrix.md, problem-map.md
-       │
-03  │  BRAINSTORM_R1 Head-to-head debate
-    │                innovation-architect generates candidates (TRIZ)
-    │                adversarial-examiner attacks them (examiner perspective)
-    │                brainstorm-moderator arbitrates & scores
-       │
-04  │  BRAINSTORM_R2 Parallel multi-dimensional evaluation
-    │                security-engineer + compliance-analyst + patentability-evaluator
-    │                Weighted score: S = 0.3·S_sec + 0.3·S_comp + 0.4·S_pat
-    │                Threshold: S ≥ 8.5 and every dimension ≥ 6.0
-       │  ←── threshold fail loops back to BRAINSTORM_R1
-05  │  DRAFT         Generate initial disclosure
-    │                → MAIN.md (by disclosure-writer)
-       │
-06  │  DIAGRAM_DRAFT Render draft figures
-    │                diagram-generator: Mermaid/PlantUML → SVG+PNG
-       │
-07  │  QA_LOOP       Bounded argue-loop
-    │                Reviewer raises issues → technical-responder writes patches
-    │                Exit: 2 consecutive rounds with zero new issues
-       │  ←── issues found loops back to DRAFT
-08  │  FINAL_REVIEW  Final pass
-       │  ←── can loop back to QA_LOOP if needed
-09  │  DIAGRAM_FINAL Re-render figures after final revisions
-    │                Auto-updates figure references in MAIN.md
-       │
-10  │  DONE          Quality gate check → finished
-```
-
-> **Crash recovery**: reads `state.json` → resumes from the exact stage.<br>
-> **Regret a round?** `path branch --from-node round-{N}` → explore an alternative.<br>
-> **Long-forgotten idea was actually good?** `path restore` → bring it back.
-
----
-
-## Ⅳ.&ensp; THE AGENTS
-
-*11 specialists, 5 collaboration patterns.*
-
-### The agents at a glance
-
-| Agent | Role | Invoked in |
-|---|---|---|
-| `archimedes` | Primary orchestrator, state-machine dispatcher | Every stage |
-| `landscape-analyst` | Prior-art search, technology landscape | RESEARCH |
-| `innovation-architect` | TRIZ-based candidate generation | BRAINSTORM_R1 |
-| `adversarial-examiner` | Examiner-perspective invalidation attacks | R1, QA_LOOP |
-| `patentability-evaluator` | Novelty / creativity / utility scoring | BRAINSTORM_R2 |
-| `security-engineer` | Vulnerability & side-channel analysis | R2, QA_LOOP |
-| `compliance-analyst` | Regulatory & privacy compliance | R2 |
-| `brainstorm-moderator` | Aggregation, scoring, threshold decisions | R1, R2 |
-| `path-recorder` | Persist rounds, branches, snapshots | Every round end |
-| `disclosure-writer` | Generate `MAIN.md` disclosure | DRAFT |
-| `disclosure-reviewer` | Writing & legal compliance review | QA_LOOP, FINAL_REVIEW |
-| `technical-responder` | Issue-by-issue rebuttal + MAIN.md patches | QA_LOOP |
-| `diagram-generator` | Mermaid/PlantUML → SVG+PNG, MAIN.md rewrites | DIAGRAM_DRAFT, DIAGRAM_FINAL |
-
-### How they collaborate
-
-The agents are wired into five distinct patterns, not a flat queue.
-
-#### Pattern 1 — Orchestration Routing
-
-`archimedes` reads `state.json`, dispatches to the right specialist based on `current_stage`, persists the result, advances the stage. The state machine is the source of truth &mdash; Archimedes is just the dispatcher.
-
-- **Threshold gate**: `passToDraft ≥ 8.5`, `novelty ≥ 6.0`, `creativity ≥ 6.0`. Fail → loop back to `BRAINSTORM_R1`. Force-iterate after `maxRounds: 3` with `minImprovement: 0.3`.
-- **Persistence**: every transition is atomic (temp file + rename). `state.json` for workflow, `path.json` for decisions, `references/` for agent outputs.
-
-#### Pattern 2 — Adversarial Brainstorming (R1)
-
-![Adversarial brainstorming](docs/images/ai-gen/图2.png)
-
-`innovation-architect` generates candidates (TRIZ). `adversarial-examiner` attacks from an examiner's perspective. `brainstorm-moderator` arbitrates and scores. `path-recorder` snapshots the round. Output: innovation IDs + scores + `ACCEPT` / `ITERATE` / `REJECT`.
-
-#### Pattern 3 — Parallel Multi-Dimensional Evaluation (R2)
-
-![Parallel evaluation](docs/images/ai-gen/图3.png)
-
-Fan-out / fan-in. Archimedes dispatches survivors to three evaluators in parallel:
-
-| Evaluator | Dimension | Score |
-|---|---|---|
-| `security-engineer` | Vulnerabilities, side-channel risks | `S_sec` |
-| `compliance-analyst` | Regulatory, privacy | `S_comp` |
-| `patentability-evaluator` | Novelty, creativity, utility | `S_pat` |
-
-`brainstorm-moderator` aggregates: `S = 0.3·S_sec + 0.3·S_comp + 0.4·S_pat`. Passes only if `S ≥ 8.5` and every dimension clears its red-line (`≥ 6.0`).
-
-#### Pattern 4 — QA Argue Loop
-
-![QA argue loop](docs/images/ai-gen/图4.png)
-
-Bounded loop with quantitative exit. Three reviewers raise issues; `technical-responder` writes revisions with explicit MAIN.md patch locations. Exit requires **2 consecutive rounds with 0 new issues**.
+Use `--tool claude-code`, `--tool codex`, or `--tool opencode` to configure one
+platform. Without `--tool`, setup targets all three. See the
+[platform notes](./docs/usage-en.md#platform-notes) if the entry point is unavailable.
 
-#### Pattern 5 — Decision Path DAG
+<details>
+<summary>For AI assistants helping users install this</summary>
 
-![Decision path DAG](docs/images/ai-gen/图5.png)
-
-Every round is a node in a DAG under `.brainstorm/`. Two operations on top of the linear path:
-
-- **`path branch --from-node <id>`** &mdash; fork from any historical node
-- **`path restore --node <id> --innovation <id>`** &mdash; revive an abandoned innovation
-
----
-
-## Ⅴ.&ensp; INSTALL & UNINSTALL
-
-### Install
+Choose the user's patent workspace, review the installation behavior above, and run:
 
 ```bash
-# Step 1 — install the CLI globally
 npm install -g oh-my-patent
-
-# Step 2 — generate editor configs
-cd your-patent-projects
 oh-my-patent adapt setup --workspace-dir .
+oh-my-patent check --workspace-dir .
 ```
 
-This generates configs for **Claude Code** (`.claude/` + `CLAUDE.md`), **Codex** (`.codex/` + `AGENTS.md` + `codex.json`), and **OpenCode** (`.opencode/agent/`, `.opencode/command/`, and `.opencode/skills/`). After this, use `/archimedes` in your editor.
-
-```bash
-# Options: generate for one editor only
-oh-my-patent adapt setup --tool claude-code --workspace-dir .
-oh-my-patent adapt setup --tool codex --workspace-dir .
-oh-my-patent adapt setup --tool opencode --workspace-dir .
-
-# Aliases
-oh-my-patent adapt install       # same as setup
-oh-my-patent adapt generate      # write to plugins/<tool>/ only, don't touch workspace
-```
-
-### Uninstall
-
-```bash
-# Remove editor configs, keep the CLI
-cd your-patent-projects
-oh-my-patent adapt uninstall --workspace-dir .
-```
+Then help the user load the integration and start a project with `/archimedes`.
 
-**Safety guarantees:**
-- Exact-file removal only &mdash; precise paths, never traverses directories
-- Your custom edits to configs are safe &mdash; we only delete what we generated
-- Empty directory cleanup after removing all generated files
+</details>
 
-```bash
-# Complete removal (editor configs + CLI)
-oh-my-patent adapt uninstall --workspace-dir .
-npm uninstall -g oh-my-patent
-```
+## What you can do
 
-> *Post-uninstall: your patent project data (`projects/`, `.brainstorm/`, `references/`, `figures/`, `MAIN.md`) is **not** deleted automatically. Run `git status` before manually removing anything.*
+| Capability | What it gives you |
+|---|---|
+| Coordinate specialist agents | Research, ideation, patentability assessment, drafting, review, and technical responses under one orchestrator |
+| Keep decisions traceable | Saved rounds, scores, innovation snapshots, and reasons in `.brainstorm/`; branch from a recorded node or restore an idea |
+| Resume recorded work | Workflow state in `.patent/state.json` and agent outputs in `references/` provide context for continuing a project |
+| Generate patent figures | Mermaid or PlantUML sources rendered to SVG and PNG, with figure references inserted into `MAIN.md` |
+| Inspect progress | CLI queries, Markdown reports, a terminal UI, and environment checks |
 
----
+The project brings the disclosure, its supporting material, and its decision history
+together in one project directory. Rendering engines and retrieval services have
+their own setup requirements; see the [usage guide](./docs/usage-en.md).
 
-## Ⅵ.&ensp; FULL USAGE
+## From idea to disclosure
 
-```
-oh-my-patent <domain> <subcommand> [options]
-```
+![Archimedes workflow overview: prepare and research, develop and assess ideas, draft disclosure and figures, review and revise, finalize disclosure and figures; with research and drafting feedback loops](./docs/images/workflow-overview-brand-v1.png)
 
-### Brainstorm path (`path`)
+*Overview of the ten stages, grouped by purpose. Arrows back to research and
+drafting show where further work may be needed.*
 
-| Subcommand | What it does |
+| Step | Workflow stages |
 |---|---|
-| `path init <project>` | Initialize `.brainstorm/` and `state.json` |
-| `path record <project> --round <N> --data <json\|@file>` | Record round N with scores, decisions, snapshots |
-| `path overview <project>` | Summary: from start to finish, current position, done? |
-| `path node <project> <round-N>` | Details of a specific round |
-| `path innovation(s) <project> [ID]` | Full history of one innovation |
-| `path branch <project> --from-node <id> --reason <text>` | Fork from any historical node |
-| `path branches <project>` | List all branches |
-| `path restore <project> --node <id> --innovation <id>` | Revive an abandoned innovation |
-| `path threshold <project> --round <N>` | Evaluate if scores pass threshold |
-| `path visualize <project> [--mode ...] --target <id>` | Terminal box-drawing visualization |
-| `path markdown <project> [--mode ...] --target <id>` | Export a Markdown report |
-
-### Patent diagrams (`diagram`)
+| Prepare and research | `INIT` → `RESEARCH` |
+| Develop and assess ideas | `BRAINSTORM_R1` → `BRAINSTORM_R2` |
+| Write and illustrate | `DRAFT` → `DIAGRAM_DRAFT` |
+| Review and revise | `QA_LOOP` → `FINAL_REVIEW` |
+| Refresh figures and finish | `DIAGRAM_FINAL` → `DONE` |
 
-| Subcommand | What it does |
-|---|---|
-| `diagram render <project> --specs <json\|@file> --phase draft\|final` | Batch render SVG+PNG, auto-update MAIN.md references |
-| `diagram status <project>` | List rendered figures (number, phase, paths) |
-| `diagram rerender <project> --figure <ID> --source <mmd\|@file> --engine mermaid\|plantuml` | Update a single figure |
+Review can return to earlier stages. The [workflow reference](./docs/workflow-diagram-en.md)
+shows the supported transitions and explains scoring decisions separately from stage changes.
 
-### Adapters (`adapt`)
+## How the team works
 
-| Subcommand | What it does |
+| Pattern | Purpose |
 |---|---|
-| `adapt setup [--tool ...] [--workspace-dir .]` | Install editor configs (recommended entry) |
-| `adapt install` | Same as `setup` |
-| `adapt uninstall [--tool ...] [--workspace-dir .]` | Exact-file removal only |
-| `adapt generate` | Write to `plugins/<tool>/` only |
+| Orchestration | Archimedes coordinates specialists and carries project context between stages |
+| Adversarial brainstorming | Candidate ideas receive examiner-style challenges before selection |
+| Parallel evaluation | Security, compliance, and patentability specialists assess different dimensions |
+| Review and response | Reviewers raise issues; the technical responder proposes document changes |
+| Decision recording | The path recorder preserves rounds for comparison, branching, and recovery |
 
-### Interactive TUI (`tui`)
-
-```bash
-oh-my-patent tui [project-path]
-```
+The [agent reference](./docs/agents-en.md) lists the 14 registered agents, 6 skills,
+9 commands, and their roles. Actual dispatch uses the capabilities of the selected host.
 
-Ink+React terminal UI. Navigate the decision path, view scores, switch branches, revive innovations &mdash; all locally, no internet needed.
+## Documentation
 
----
-
-## Ⅶ.&ensp; ARCHITECTURE
-
-Four layers, one data flow.
-
-| Layer | What it governs | Key files |
-|---|---|---|
-| **Orchestration** | Agent / skill / command definitions | `plugin.jsonc`, `plugins/` |
-| **Engine** | Path tracking, state machine, diagrams, thresholds | `src/core/` |
-| **Command** | Unified CLI wrapping engine capabilities | `src/cli.ts`, `src/commands/` |
-| **Adapter** | Converts orchestration → Claude Code / Codex / OpenCode configs | `src/adapters/claude/`, `src/adapters/codex/`, `src/adapters/opencode/` |
-
-```
-  plugin.jsonc (orchestration definition)
-           │
-    [Adapters] generate
-           │
-  .claude/ (Claude Code)      .codex/ (Codex)       .opencode/ (OpenCode)
-  CLAUDE.md                   AGENTS.md, codex.json  agents, commands, skills
-           │
-  AI in your editor invokes 11 specialist agents
-           │
-  Output → .brainstorm/ decision-path records
-  Output → state.json workflow state machine
-  Output → references/ with standardized filenames
-  Output → MAIN.md + figures/
-           │
-  CLI commands = automated operations on .brainstorm/ + .patent/ + references/
-  TUI = visualized browsing of .brainstorm/
-```
-
----
-
-## Ⅷ.&ensp; DIRECTORY
-
-```
-oh-my-patent/                    # Core repo: configs and engine
-├── src/
-│   ├── cli.ts                   # CLI entry
-│   ├── core/
-│   │   ├── brainstorm-path.ts   # Decision-path data model + thresholds
-│   │   ├── path-persistence.ts  # Atomic writes + rollback
-│   │   ├── path-graph.ts        # Graph structure + fork algorithms
-│   │   ├── diagram-renderer.ts  # Mermaid/PlantUML → SVG/PNG
-│   │   └── threshold-config.ts  # Quantitative threshold model
-│   ├── commands/                # path init/record/overview/branch/restore...
-│   ├── adapters/
-│   │   ├── claude/              # → .claude/ + CLAUDE.md
-│   │   ├── codex/               # → .codex/ + AGENTS.md + codex.json
-│   │   └── opencode/            # → .opencode/ agents, commands, and skills
-│   └── tui/                     # Ink+React interactive UI
-├── plugin.jsonc
-└── dist/                        # Compiled output
-
-projects/{NN}-{topic_slug}/      # One Git repo per patent
-├── .brainstorm/
-│   ├── path.json                # Metadata + edges + current node + final decision
-│   ├── nodes/
-│   │   └── round-{n}.json       # Scores, innovations, decisions, timestamps
-│   ├── snapshots/               # Innovation history snapshots
-│   └── branches/                # Forked explorations
-├── .patent/
-│   └── state.json               # Workflow state: at DRAFT? QA round 3?
-├── references/
-│   ├── landscape.md             # Search results
-│   ├── brainstorm_round1_*.md   # Agent outputs follow strict naming
-│   └── argue_round2_*.md
-├── figures/
-│   ├── 001-system-overview.svg
-│   ├── 001-system-overview.png
-│   └── figures-manifest.json
-├── MAIN.md                      # Final disclosure (auto-updated by diagram inserter)
-└── conversation.md              # Chronological conversation log
-```
-
-### Scripts
-
-```bash
-npm run build  # Compile TypeScript → dist/
-npm test       # Run vitest test suite (123 passing)
-npm run lint   # tsc --noEmit type checking
-```
-
----
-
-<div align="center">
-
----
-
- *MIT Licensed &ensp;&middot;&ensp; Crafted by [illusionaireal](https://github.com/illusionaireal)*<br>
-*With thanks to the [LINUX DO Community](https://linux.do/)*
-
-&mdash; 1 &mdash;
-
-</div>
+| Read next | Contents |
+|---|---|
+| [Usage and CLI](./docs/usage-en.md) | Installation, platform differences, all CLI domains, and uninstall behavior |
+| [Workflow](./docs/workflow-diagram-en.md) | Ten stages, review loops, and threshold behavior |
+| [Agents and collaboration](./docs/agents-en.md) | Registered IDs, skills, commands, and collaboration patterns |
+| [Architecture and development](./docs/architecture-en.md) | Four layers, repository layout, project files, and development commands |
+| [Documentation index](./docs/README-en.md) | Bilingual guides and design references |
+| [Brand guide](./assets/brand/README.md) | Archimedes artwork and usage rules |
+
+Contributions are welcome. Read [CONTRIBUTING.md](./CONTRIBUTING.md) or
+[report an issue](https://github.com/illusionaireal/oh-my-patent/issues).
+Licensed under [MIT](./LICENSE).
+
+*With thanks to the* [*LINUX DO Community*](https://linux.do/)