flavor-code 1.3.12 → 1.3.15

package/README.md

@@ -1,425 +1,426 @@
-<p align="center"><b><a href="./README.md">English</a></b> | <a href="./README.zh-CN.md">简体中文</a></p>
-
-<div align="center">
-  <img src="./assets/icon-transparent-512.png" alt="Flavor Code Logo" width="168" />
-  <h1>Flavor Code</h1>
-  <p><strong>Local-first, auditable, resumable AI coding assistant</strong></p>
-  <p>Read code, edit files, run commands, and complete complex tasks in the terminal, Electron desktop, and VS Code.</p>
-
-  <p>
-    <a href="https://www.npmjs.com/package/flavor-code"><img alt="npm version" src="https://img.shields.io/npm/v/flavor-code?color=cb3837&logo=npm" /></a>
-    <a href="https://github.com/YachuanWzh/flavor-code/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/YachuanWzh/flavor-code/actions/workflows/ci.yml/badge.svg?branch=main" /></a>
-    <img alt="Node.js 20+" src="https://img.shields.io/badge/Node.js-20%2B-339933?logo=nodedotjs&logoColor=white" />
-    <a href="./LICENSE"><img alt="MIT License" src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
-  </p>
-
-  <p>
-    <a href="#quick-start">Quick Start</a> ·
-    <a href="#features">Features</a> ·
-    <a href="#entry-points">Entry Points</a> ·
-    <a href="#permissions--sandbox">Security</a> ·
-    <a href="#development">Development</a> ·
-    <a href="./CHANGELOG.md">Changelog</a>
-  </p>
-</div>
-
----
-
-Flavor Code connects to OpenAI, Anthropic, or compatible services and works with file, search, Shell, MCP, and custom tools inside a controlled workspace. Complex tasks can be broken into plans and parallel sub-tasks; sessions, diffs, tool calls, checkpoints, and audit records are all stored locally so you can resume, review, and continue at any time.
-
-## Features
-
-| | Capability | What you get |
-| --- | --- | --- |
-| 🖥️ | **One runtime, three entry points** | CLI, Electron, and VS Code share model configuration, sessions, and tooling |
-| 🧭 | **Controlled progress on complex tasks** | Task plans, sub-agents, steering, follow-ups, `/loop`, `/goal`, and conflict-safe parallel execution (tasks owning overlapping files run serially) |
-| 🏝️ | **Flavor Island local control** | Host apps steer a running session over a token-authenticated local IPC channel (Windows named pipes / Unix sockets): abort, steering, follow-ups, and window focus; model duration, token usage, task summaries, and deliverables are reported via hook events |
-| ⏪ | **Traceable, resumable results** | Full timeline, checkpoints, rewind, traces, diffs, and failure audits |
-| 🧱 | **Crash-consistent execution** | Fsync-backed event journal, durable steering queue, savepoints, and no automatic replay of non-idempotent tools |
-| 🧠 | **Local long-term context** | Memory, Skills, plugins, and project guides stored on your machine |
-| 🔎 | **Code graph navigation** | A local AST code-graph index (`.flavor/astgraph/`) powers `ast_search`/`ast_callers`/`ast_impact` queries for precise symbol lookup and reachability tracing |
-| 🌿 | **Git-native workflows** | `/commit` drafts a Conventional-Commits message for staged changes and commits after confirmation; `/review` audits uncommitted changes; the read-only `GitHistory` tool explains when and why code changed |
-| 🎨 | **E2E requirement-to-delivery** | From a rough requirement or a design export to a delivered product: PRD, interactive prototype, visual implementation, API integration, autonomous acceptance, and scored delivery (Electron only) |
-| 🔁 | **Bounded self-improvement** | Repeated tool failures are captured, deduped, and proposed as suggestions; fixes ship as sandbox-verified plugins or as learned guardrail rules injected into future prompts, with run trends and rule management (`/evolve`) |
-| 🛡️ | **Clear permission boundaries** | Independent control over read, write, Shell, network, and destructive actions; Docker supported |
-
-## Quick Start
-
-> [!IMPORTANT]
-> The CLI requires Node.js 20 or later. Windows desktop builds can also be downloaded directly from [Releases](https://github.com/YachuanWzh/flavor-code/releases).
-
-**1. Install**
-
-```bash
-npm install -g flavor-code
-```
-
-**2. Start in your project**
-
-```bash
-cd your-project
-flavor
-```
-
-**3. Initialize project context**
-
-Run `/init` the first time you enter a project. Flavor analyzes the language, package manager, source directories, and verification commands, then generates a `FLAVOR.md` project guide.
-
-You can also run one-off tasks directly:
-
-```bash
-flavor --print "Analyze this project and list the top three issues worth fixing"
-flavor --resume
-flavor --resume -p "Continue the remaining work"
-```
-
-Non-interactive mode refuses actions that require human approval and never hangs waiting for input.
-
-## Configuring Models
-
-The fastest way is to set environment variables:
-
-```bash
-# macOS / Linux
-export OPENAI_API_KEY="sk-..."
-
-# Windows PowerShell
-$env:OPENAI_API_KEY = "sk-..."
-```
-
-You can also put the key in a `.env` file at the project root.
-
-<details>
-<summary><strong>Configure multiple providers with <code>.flavor/flavor.json</code></strong></summary>
-
-Example project configuration:
-
-```json
-{
-  "providers": {
-    "openai": {
-      "type": "openai",
-      "apiKey": "${OPENAI_API_KEY}",
-      "defaultModel": "gpt-5",
-      "cheapModel": "gpt-5-mini"
-    }
-  },
-  "agents": {
-    "main": { "model": "openai:gpt-5" },
-    "subagent": { "model": "openai:gpt-5-mini" }
-  },
-  "permissionMode": "default",
-  "maxSubagents": 3,
-  "language": "zh-CN"
-}
-```
-
-Configuration is merged in the following order, with later sources taking precedence:
-
-1. Global `~/.flavor-code/flavor.json`
-2. Project `.flavor/flavor.json`
-3. `.env`
-4. Process environment variables
-
-Commonly supported provider types:
-
-- `openai`: OpenAI's official API
-- `anthropic`: Anthropic's official API
-- `openai-compatible`: Services compatible with the OpenAI protocol
-
-</details>
-
-Runtime behavior and configuration conventions for OAuth PKCE are described in the [PKCE spec](./docs/specs/pkce-runtime-config.md). The [config schema](./src/config/schema.ts) is the source of truth for all fields.
-
-## Entry Points
-
-| Entry point | Best for | How to start |
-| --- | --- | --- |
-| **CLI** | Daily development, remote environments, scripting, and CI | `flavor` |
-| **Electron** | Visual sessions, diffs, permissions, and resource management | `npm run desktop:start` |
-| **VS Code / Qoder** | Editor context, diagnostic fixes, and a task control plane | `npm run ide:install` |
-
-### CLI
-
-Run `flavor` and type natural language. Typing `/` shows built-in commands, plugin commands, and Skills.
-
-Common commands:
-
-| Command | Purpose |
-| --- | --- |
-| `/init` | Generate or update `FLAVOR.md` |
-| `/model` | View or switch main/sub-agent models |
-| `/permissions` | Switch permission modes |
-| `/tasks` | View task plans and sub-agent status |
-| `/compact` | Manually compact long session context |
-| `/checkpoint`, `/tree` | Save state, view the session tree |
-| `/rewind`, `/unrevert`, `/fork` | Resume or fork sessions |
-| `/memory`, `/remember`, `/forget`, `/forget-cold` | Manage long-term memory; `/forget-cold` purges cold entries and their files |
-| `/mcp` | View and manage MCP servers |
-| `/loop <goal>` | Run an autonomous loop with verification |
-| `/goal <objective>` | Run the plan, execute, adversarial-review workflow |
-| `/commit [hint]` | Draft a Conventional-Commits message for staged changes and commit after confirmation |
-| `/review [focus]` | Review uncommitted changes for bugs and risks before committing |
-| `/evolve <signals\|suggest\|improve ...>` | Self-improvement loop: review repeated tool failures, scaffold fix plugins, manage run trends and learned guardrail rules, verify and hot-reload |
-| `/pals`, `/chat`, `/co-work` | Discover and collaborate with other local CLI instances |
-| `/audit` | View tool failure audits |
-
-You can submit steering or queue follow-ups while a run is in progress; once the current model response finishes, the task picks up new instructions at safe boundaries.
-
-`/commit` and `/review` use the cheap sub-agent model and degrade gracefully when it is unavailable. Session checkpoints are tagged with the current git state (`branch@sha`), so `/tree` shows what the workspace looked like at each node.
-
-#### CLI pals and cross-project work
-
-Interactive CLI instances on the same Windows or macOS user account can collaborate over local-only IPC (Windows named pipes or Unix sockets; no TCP fallback). Give each window a memorable alias:
-
-```bash
-# terminal A, in project A
-flavor --pal-name A
-
-# terminal B, in project B
-flavor --pal-name B
-```
-
-Useful commands:
-
-```text
-/pals                              # aliases and per-process UUIDs
-/pals --verbose                    # also show project paths and timestamps
-/pals rename api                   # rename this active instance
-/chat B Update the API and tests   # deliver to B and start its agent safely
-/co-work B Upgrade B, then adapt A # negotiate one plan before parallel work
-/co-work status [co-work-uuid]
-/co-work cancel <co-work-uuid> [reason]
-```
-
-`/chat` is bidirectional and task-oriented. If B is idle, the attributed message starts a normal model turn; if B is already running, it becomes steering, or a follow-up when another local submission is pending. Remote text is converted to a safe non-slash prompt, so `/exit`-like text is not dispatched as a local command. B can answer with `/chat A ...`.
-
-`/co-work` first places both agents in planning and waits for both to accept the same hashed plan and declare READY. Early READY intents are retained, and only the broker's exactly-once START event opens parallel execution. Each agent works only in its own project, receives only its assigned tasks, and reports bounded completion evidence. The broker-selected integration owner verifies all assertions and emits END or FAIL through `CoWorkIntegrate`. Communication uses authenticated, bounded local IPC with no TCP listener; peer input cannot approve tools or access the other workspace. UUID/alias routing and the protocol already support a third active client; durable artifact exchange, broker-restart journaling/recovery, and large-group coordination are later hardening work. See the [CLI pals specification](./docs/specs/2026-08-14-cli-pals-cowork.md).
-
-### Electron Desktop
-
-```bash
-npm run desktop:dev      # dev mode
-npm run desktop:start    # build and start
-npm run desktop:pack     # Windows portable directory
-npm run desktop:dist     # Windows NSIS installer
-```
-
-The desktop app keeps multiple projects open and can run up to four independent tasks concurrently inside one project; switching projects or tasks does not stop background work. Completion, failure, attention, and interruption events enter a persistent activity inbox and trigger native notifications, while unread completions retain a blue dot. Projects can be pinned, renamed, closed, revealed, or copied; tasks can be searched, renamed, pinned, and archived.
-
-Use `Ctrl+P` to switch projects, `Ctrl+K` for the command palette, and `Ctrl+N` for a new task; the title bar also supports back/forward navigation. Interrupted work gets a recovery banner after an abnormal exit. The **Git Changes** view provides per-file diffs, stage/unstage/discard, commits, and `/review` handoff. Streaming Markdown, permission confirmations, and Skills, MCP, memory, and model management remain available.
-
-The **E2E** module in the sidebar drives a rough requirement or an existing design export through the full delivery pipeline: it generates a PRD and an interactive prototype for review, then moves into D2C visual implementation (Vue 3 / React) under `src/d2c-output/<task>/`. A Vite dev server starts automatically for pixel-level comparison, producing a visual-fidelity score and a structured diff report (region offsets, color deviations, font differences); the results workbench offers overlay, curtain, flicker, and heatmap modes, an SVG annotation layer, and a severity-sorted issue list. After visual review, a Swagger/OpenAPI contract is generated or imported to auto-create Axios wrappers and an Express mock server, followed by autonomous interactive acceptance and scored delivery.
-
-### VS Code / Qoder
-
-```bash
-npm run vscode:install   # install into VS Code
-npm run qoder:install    # install into Qoder
-npm run ide:install      # auto-select the installed IDE
-```
-
-The extension includes the `@flavor` Chat Participant, Mission Control, Changes & Health, Time Machine, diagnostic fixes, CodeLens, checkpoints, and rewind. If `flavor` is not on your `PATH`, set `flavorCode.executable`.
-
-## MCP, Skills & Plugins
-
-Flavor can connect to stdio or Streamable HTTP MCP servers. Example project configuration:
-
-<details>
-<summary><strong>MCP configuration and CLI examples</strong></summary>
-
-```json
-{
-  "mcpServers": {
-    "docs": {
-      "url": "https://example.com/mcp",
-      "headers": {
-        "Authorization": "Bearer ${MCP_TOKEN}"
-      }
-    }
-  }
-}
-```
-
-MCP configuration can also be managed from the CLI:
-
-```bash
-flavor mcp list
-flavor mcp add docs --url https://example.com/mcp
-flavor mcp disable docs
-```
-
-</details>
-
-A Skill is a `SKILL.md` with YAML frontmatter, placed in `.flavor/skills/<name>/` or `~/.flavor-code/skills/<name>/`. Flavor loads skills progressively based on the task, and you can invoke one explicitly with `/<skill-name>`. Skill bodies support `$ARGUMENTS`, `$ARGUMENTS[N]`, and `$N` substitutions. A running composite Skill can load a dependency through the read-only `Skill` tool; plugin-qualified names such as `superharness:test-driven-development` resolve to discovered skills.
-
-Plugins live in `.flavor/plugins/` and can register commands, tools, hooks, Skill roots, and model adapters. `additionalContext` returned by `SessionStart` and `UserPromptSubmit` hooks is added to the current task context, enabling reliable project-level engineering policy injection. Plugin loads record a content fingerprint plus declared capabilities. Worker/vm isolation is available through the embedding API's `pluginSandbox: true` option; the compatibility default remains in-process because bundled and existing plugins use Node.js APIs that the isolated runtime does not yet mediate.
-
-When the `flavor-island` plugin is loaded, Flavor also starts a Flavor Island local control channel: a loopback-only IPC service (Windows named pipe, or Unix socket on macOS/Linux) secured by a random token. A host app (such as the Flavor Island desktop) can use it to abort, steer, or send follow-ups to a running session, and desktop hosts can also bring their window into focus. The channel's endpoint, token, and capability list are exposed to the host plugin via hook event context (`islandControlEndpoint`/`islandControlToken`/`islandControlCapabilities`); model-call duration and token usage, plus the final task summary and deliverables, are reported through hook events so the host can show live status and a result overview.
-
-> [!WARNING]
-> The default in-process plugin runtime grants full Node.js access. Only install and enable plugins you trust. Sandboxing reduces ambient access but does not make untrusted instructions safe, and plugins that import Node.js built-ins will not load with `pluginSandbox: true` yet.
-
-## Sessions, Memory & Execution Records
-
-Project runtime data lives under `.flavor/`:
-
-```text
-.flavor/
-├── flavor.json       # Project config
-├── sessions/         # Session timelines
-│   └── *.events.jsonl # Crash-consistent execution journals
-├── session-assets/   # Image attachments
-├── session-trees/    # Session branches
-├── checkpoints/      # Workspace snapshots
-├── memory/           # Long-term memory
-├── traces/           # Optional execution traces
-├── audit.jsonl       # Tool failure audits
-├── evolve/           # Self-improvement signals and run reflections
-├── skills/           # Project skills
-└── plugins/          # Project plugins
-```
-
-Long-term memory distinguishes user preferences, behavioral feedback, project conventions, and external references. Automatic extraction only keeps high-confidence candidates and provides confirm, ignore, and delete actions; secrets, tokens, raw tool output, and model guesses are rejected.
-
-Image prompts support PNG, JPEG, and WebP, with a 5 MiB per-image maximum and up to 5 images per prompt. The desktop app supports picking or drag-and-drop; CLI clipboard images currently work on Windows and macOS.
-
-## Permissions & Sandbox
-
-| Mode | Behavior |
-| --- | --- |
-| `default` | Reads are auto-approved; writes, Shell, network, and destructive actions are confirmed on demand |
-| `acceptEdits` | Workspace writes and routine verification are auto-approved |
-| `plan` | Read-only planning; no modifications or execution |
-| `bypassPermissions` | The main agent executes as much as possible after hard safety checks |
-| `auto` | A classifier decides, falling back to human approval when uncertain |
-| `bubble` | Uncertain operations bubble up to the main session for approval |
-
-Layered permission policies can be defined in the managed, user, project, local-project, and session tiers. Matching rules use token arrays and the strictest result always wins (`deny > ask > allow`); built-in hard denials cannot be weakened.
-
-> [!CAUTION]
-> Local Shell still runs as your current user. Consider enabling Docker when working with untrusted projects.
-
-<details>
-<summary><strong>Docker execution environment example</strong></summary>
-
-```json
-{
-  "execution": {
-    "mode": "docker",
-    "image": "node:24-bookworm-slim",
-    "network": false,
-    "memory": "2g",
-    "cpus": 2
-  }
-}
-```
-
-If Docker is unavailable, tasks fail rather than silently falling back to the host. Sensitive fields in config files and OAuth tokens are encrypted at rest with AES-256-GCM using a local configuration key.
-
-</details>
-
-## SDK, RPC & Evaluation
-
-<details>
-<summary><strong>Node.js SDK example</strong></summary>
-
-```ts
-import { createFlavorRuntime } from "flavor-code/sdk";
-
-const runtime = await createFlavorRuntime({
-  workspace: process.cwd(),
-  approvalPolicy: "deny",
-  output: console.log,
-});
-
-await runtime.session.start();
-await runtime.session.submit("fix the failing tests");
-await runtime.dispose();
-```
-
-</details>
-
-Other IDEs or languages can integrate over JSONL RPC:
-
-```bash
-flavor --mode rpc --workspace . --trace .flavor/traces/run.jsonl
-```
-
-Run evaluations:
-
-```bash
-flavor eval eval.json --output report.json
-```
-
-Design constraints for RPC, traces, replay, eval, session trees, and Docker are in the [control-plane spec](./docs/specs/2026-07-29-control-plane-sandbox-vscode.md).
-
-## Development
-
-```bash
-npm ci
-npm test
-npm run typecheck
-npm run vscode:typecheck
-npm run build
-npm run smoke:install
-```
-
-- TypeScript strict, targeting ES2022, Node.js 20+
-- Vitest for unit and integration tests
-- tsup builds the CLI, SDK, Electron main process, and VS Code extension
-- Vite builds the Electron renderer
-- CI covers Windows/macOS with Node 20/24
-
-Release builds do not generate or package source maps by default. For a local debugging build, enable them explicitly:
-
-```bash
-# macOS / Linux
-FLAVOR_SOURCEMAP=1 npm run build
-
-# Windows PowerShell
-$env:FLAVOR_SOURCEMAP = "1"
-npm run build
-```
-
-## Documentation
-
-- [Technical Design Report](./技术方案报告.md): overall architecture, agent loop, context, permissions, plugins, and security model
-- [Runtime reliability spec](./docs/specs/2026-07-26-runtime-reliability.md)
-- [1.3 reliability, prompt-cache & verification contract](./docs/specs/2026-08-24-v1.3-reliability-contract.md)
-- [Control plane, sandbox & VS Code spec](./docs/specs/2026-07-29-control-plane-sandbox-vscode.md)
-- [Multimodal image attachments spec](./docs/specs/2026-07-30-multimodal-image-attachments.md)
-- [D2C design-to-code spec](./docs/specs/2026-08-09-d2c-design-to-code.md)
-- [D2C review & integration spec](./docs/specs/2026-08-10-d2c-review-and-integration.md)
-- [E2E requirement-to-delivery spec](./docs/specs/2026-08-12-e2e-requirement-to-delivery.md)
-- [1.2.9 runtime productivity spec](./docs/specs/2026-08-13-runtime-productivity-waves.md)
-- [VS Code next steps](./docs/specs/2026-08-01-flavor-code-vscode-next.md)
-
-## Security Notes
-
-- Review model-generated code and commands, especially dependency installs, scripts, and deletions.
-- Do not treat `.flavor/sessions/`, traces, or long-term memory as secret stores.
-- Use least-privilege API keys and never commit `.env`.
-- Skill content can influence model behavior; sandboxed plugins still require review, while explicitly enabled legacy in-process plugins have full Node.js permissions.
-- Work under version control and create checkpoints before high-risk tasks.
-
-## Contributing
-
-Issues and Pull Requests are welcome. Please at least run the following before submitting:
-
-```bash
-npm test
-npm run typecheck
-npm run vscode:typecheck
-npm run build
-```
-
-For architecture changes, read the [Technical Design Report](./技术方案报告.md) and the relevant [design specs](./docs/specs/) first.
-
-## License
-
-[MIT](./LICENSE)
-
-<p align="center">
-  Made with 🌶️ by Flavor Code contributors.
-</p>
+<p align="center"><b><a href="./README.md">English</a></b> | <a href="./README.zh-CN.md">简体中文</a></p>
+
+<div align="center">
+  <img src="./assets/icon-transparent-512.png" alt="Flavor Code Logo" width="168" />
+  <h1>Flavor Code</h1>
+  <p><strong>Local-first, auditable, resumable AI coding assistant</strong></p>
+  <p>Read code, edit files, run commands, and complete complex tasks in the terminal, Electron desktop, and VS Code.</p>
+
+  <p>
+    <a href="https://www.npmjs.com/package/flavor-code"><img alt="npm version" src="https://img.shields.io/npm/v/flavor-code?color=cb3837&logo=npm" /></a>
+    <a href="https://github.com/YachuanWzh/flavor-code/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/YachuanWzh/flavor-code/actions/workflows/ci.yml/badge.svg?branch=main" /></a>
+    <img alt="Node.js 20+" src="https://img.shields.io/badge/Node.js-20%2B-339933?logo=nodedotjs&logoColor=white" />
+    <a href="./LICENSE"><img alt="MIT License" src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
+  </p>
+
+  <p>
+    <a href="#quick-start">Quick Start</a> ·
+    <a href="#features">Features</a> ·
+    <a href="#entry-points">Entry Points</a> ·
+    <a href="#permissions--sandbox">Security</a> ·
+    <a href="#development">Development</a> ·
+    <a href="./CHANGELOG.md">Changelog</a>
+  </p>
+</div>
+
+---
+
+Flavor Code connects to OpenAI, Anthropic, or compatible services and works with file, search, Shell, MCP, and custom tools inside a controlled workspace. Complex tasks can be broken into plans and parallel sub-tasks; sessions, diffs, tool calls, checkpoints, and audit records are all stored locally so you can resume, review, and continue at any time.
+
+## Features
+
+| | Capability | What you get |
+| --- | --- | --- |
+| 🖥️ | **One runtime, three entry points** | CLI, Electron, and VS Code share model configuration, sessions, and tooling |
+| 🧭 | **Controlled progress on complex tasks** | Task plans, sub-agents, steering, follow-ups, `/loop`, `/goal`, and conflict-safe parallel execution (tasks owning overlapping files run serially) |
+| 🏝️ | **Flavor Island local control** | Host apps steer a running session over a token-authenticated local IPC channel (Windows named pipes / Unix sockets): abort, steering, follow-ups, and window focus; model duration, token usage, task summaries, and deliverables are reported via hook events |
+| ⏪ | **Traceable, resumable results** | Full timeline, checkpoints, rewind, traces, diffs, and failure audits |
+| 🧱 | **Crash-consistent execution** | Fsync-backed event journal, durable steering queue, savepoints, and no automatic replay of non-idempotent tools |
+| 🧠 | **Local long-term context** | Memory, Skills, plugins, and project guides stored on your machine |
+| 🔎 | **Code graph navigation** | A local AST code-graph index (`.flavor/astgraph/`) powers `ast_search`/`ast_callers`/`ast_impact` queries for precise symbol lookup and reachability tracing; `/explain` turns that graph plus git history into newcomer-oriented walkthroughs |
+| 🌿 | **Git-native workflows** | `/commit` drafts a Conventional-Commits message for staged changes and commits after confirmation; `/review` audits uncommitted changes; the read-only `GitHistory` tool explains when and why code changed |
+| 🎨 | **E2E requirement-to-delivery** | From a rough requirement or a design export to a delivered product: PRD, interactive prototype, visual implementation, API integration, autonomous acceptance, and scored delivery (Electron only) |
+| 🔁 | **Bounded self-improvement** | Repeated tool failures are captured, deduped, and proposed as suggestions; fixes ship as sandbox-verified plugins or as learned guardrail rules injected into future prompts, with run trends and rule management (`/evolve`) |
+| 🛡️ | **Clear permission boundaries** | Independent control over read, write, Shell, network, and destructive actions; Docker supported |
+
+## Quick Start
+
+> [!IMPORTANT]
+> The CLI requires Node.js 20 or later. Windows desktop builds can also be downloaded directly from [Releases](https://github.com/YachuanWzh/flavor-code/releases).
+
+**1. Install**
+
+```bash
+npm install -g flavor-code
+```
+
+**2. Start in your project**
+
+```bash
+cd your-project
+flavor
+```
+
+**3. Initialize project context**
+
+Run `/init` the first time you enter a project. Flavor analyzes the language, package manager, source directories, and verification commands, then generates a `FLAVOR.md` project guide.
+
+You can also run one-off tasks directly:
+
+```bash
+flavor --print "Analyze this project and list the top three issues worth fixing"
+flavor --resume
+flavor --resume -p "Continue the remaining work"
+```
+
+Non-interactive mode refuses actions that require human approval and never hangs waiting for input.
+
+## Configuring Models
+
+The fastest way is to set environment variables:
+
+```bash
+# macOS / Linux
+export OPENAI_API_KEY="sk-..."
+
+# Windows PowerShell
+$env:OPENAI_API_KEY = "sk-..."
+```
+
+You can also put the key in a `.env` file at the project root.
+
+<details>
+<summary><strong>Configure multiple providers with <code>.flavor/flavor.json</code></strong></summary>
+
+Example project configuration:
+
+```json
+{
+  "providers": {
+    "openai": {
+      "type": "openai",
+      "apiKey": "${OPENAI_API_KEY}",
+      "defaultModel": "gpt-5",
+      "cheapModel": "gpt-5-mini"
+    }
+  },
+  "agents": {
+    "main": { "model": "openai:gpt-5" },
+    "subagent": { "model": "openai:gpt-5-mini" }
+  },
+  "permissionMode": "default",
+  "maxSubagents": 3,
+  "language": "zh-CN"
+}
+```
+
+Configuration is merged in the following order, with later sources taking precedence:
+
+1. Global `~/.flavor-code/flavor.json`
+2. Project `.flavor/flavor.json`
+3. `.env`
+4. Process environment variables
+
+Commonly supported provider types:
+
+- `openai`: OpenAI's official API
+- `anthropic`: Anthropic's official API
+- `openai-compatible`: Services compatible with the OpenAI protocol
+
+</details>
+
+Runtime behavior and configuration conventions for OAuth PKCE are described in the [PKCE spec](./docs/specs/pkce-runtime-config.md). The [config schema](./src/config/schema.ts) is the source of truth for all fields.
+
+## Entry Points
+
+| Entry point | Best for | How to start |
+| --- | --- | --- |
+| **CLI** | Daily development, remote environments, scripting, and CI | `flavor` |
+| **Electron** | Visual sessions, diffs, permissions, and resource management | `npm run desktop:start` |
+| **VS Code / Qoder** | Editor context, diagnostic fixes, and a task control plane | `npm run ide:install` |
+
+### CLI
+
+Run `flavor` and type natural language. Typing `/` shows built-in commands, plugin commands, and Skills.
+
+Common commands:
+
+| Command | Purpose |
+| --- | --- |
+| `/init` | Generate or update `FLAVOR.md` |
+| `/model` | View or switch main/sub-agent models |
+| `/permissions` | Switch permission modes |
+| `/tasks` | View task plans and sub-agent status |
+| `/compact` | Manually compact long session context |
+| `/checkpoint`, `/tree` | Save state, view the session tree |
+| `/rewind`, `/unrevert`, `/fork` | Resume or fork sessions |
+| `/memory`, `/remember`, `/forget`, `/forget-cold` | Manage long-term memory; `/forget-cold` purges cold entries and their files |
+| `/mcp` | View and manage MCP servers |
+| `/loop <goal>` | Run an autonomous loop with verification |
+| `/goal <objective>` | Run the plan, execute, adversarial-review workflow |
+| `/commit [hint]` | Draft a Conventional-Commits message for staged changes and commit after confirmation |
+| `/review [focus]` | Review uncommitted changes for bugs and risks before committing |
+| `/explain <symbol \| file.ts#symbol> [focus]` | Explain a symbol for newcomers using the code graph, real source and git history (interactive picker on ambiguity) |
+| `/evolve <signals\|suggest\|improve ...>` | Self-improvement loop: review repeated tool failures, scaffold fix plugins, manage run trends and learned guardrail rules, verify and hot-reload |
+| `/pals`, `/chat`, `/co-work` | Discover and collaborate with other local CLI instances |
+| `/audit` | View tool failure audits |
+
+You can submit steering or queue follow-ups while a run is in progress; once the current model response finishes, the task picks up new instructions at safe boundaries.
+
+`/commit` and `/review` use the cheap sub-agent model and degrade gracefully when it is unavailable. Session checkpoints are tagged with the current git state (`branch@sha`), so `/tree` shows what the workspace looked like at each node. `/explain <symbol>` runs on the same cheap model: it assembles call relations from the code graph, the symbol's real source slice, and recent commits touching the file, then generates a five-part newcomer walkthrough (what it does / key implementation points / call flow / why it is written this way / gotchas); an interactive picker disambiguates multiple matches, and a missing graph degrades to a `/ast init` hint instead of an error.
+
+#### CLI pals and cross-project work
+
+Interactive CLI instances on the same Windows or macOS user account can collaborate over local-only IPC (Windows named pipes or Unix sockets; no TCP fallback). Give each window a memorable alias:
+
+```bash
+# terminal A, in project A
+flavor --pal-name A
+
+# terminal B, in project B
+flavor --pal-name B
+```
+
+Useful commands:
+
+```text
+/pals                              # aliases and per-process UUIDs
+/pals --verbose                    # also show project paths and timestamps
+/pals rename api                   # rename this active instance
+/chat B Update the API and tests   # deliver to B and start its agent safely
+/co-work B Upgrade B, then adapt A # negotiate one plan before parallel work
+/co-work status [co-work-uuid]
+/co-work cancel <co-work-uuid> [reason]
+```
+
+`/chat` is bidirectional and task-oriented. If B is idle, the attributed message starts a normal model turn; if B is already running, it becomes steering, or a follow-up when another local submission is pending. Remote text is converted to a safe non-slash prompt, so `/exit`-like text is not dispatched as a local command. B can answer with `/chat A ...`.
+
+`/co-work` first places both agents in planning and waits for both to accept the same hashed plan and declare READY. Early READY intents are retained, and only the broker's exactly-once START event opens parallel execution. Each agent works only in its own project, receives only its assigned tasks, and reports bounded completion evidence. The broker-selected integration owner verifies all assertions and emits END or FAIL through `CoWorkIntegrate`. Communication uses authenticated, bounded local IPC with no TCP listener; peer input cannot approve tools or access the other workspace. UUID/alias routing and the protocol already support a third active client; durable artifact exchange, broker-restart journaling/recovery, and large-group coordination are later hardening work. See the [CLI pals specification](./docs/specs/2026-08-14-cli-pals-cowork.md).
+
+### Electron Desktop
+
+```bash
+npm run desktop:dev      # dev mode
+npm run desktop:start    # build and start
+npm run desktop:pack     # Windows portable directory
+npm run desktop:dist     # Windows NSIS installer
+```
+
+The desktop app keeps multiple projects open and can run up to four independent tasks concurrently inside one project; switching projects or tasks does not stop background work. Completion, failure, attention, and interruption events enter a persistent activity inbox and trigger native notifications, while unread completions retain a blue dot. Projects can be pinned, renamed, closed, revealed, or copied; tasks can be searched, renamed, pinned, and archived.
+
+Use `Ctrl+P` to switch projects, `Ctrl+K` for the command palette, and `Ctrl+N` for a new task; the title bar also supports back/forward navigation. Interrupted work gets a recovery banner after an abnormal exit. The **Git Changes** view provides per-file diffs, stage/unstage/discard, commits, and `/review` handoff. Streaming Markdown, permission confirmations, and Skills, MCP, memory, and model management remain available.
+
+The **E2E** module in the sidebar drives a rough requirement or an existing design export through the full delivery pipeline: it generates a PRD and an interactive prototype for review, then moves into D2C visual implementation (Vue 3 / React) under `src/d2c-output/<task>/`. A Vite dev server starts automatically for pixel-level comparison, producing a visual-fidelity score and a structured diff report (region offsets, color deviations, font differences); the results workbench offers overlay, curtain, flicker, and heatmap modes, an SVG annotation layer, and a severity-sorted issue list. After visual review, a Swagger/OpenAPI contract is generated or imported to auto-create Axios wrappers and an Express mock server, followed by autonomous interactive acceptance and scored delivery.
+
+### VS Code / Qoder
+
+```bash
+npm run vscode:install   # install into VS Code
+npm run qoder:install    # install into Qoder
+npm run ide:install      # auto-select the installed IDE
+```
+
+The extension includes the `@flavor` Chat Participant, Mission Control, Changes & Health, Time Machine, diagnostic fixes, CodeLens, checkpoints, and rewind. If `flavor` is not on your `PATH`, set `flavorCode.executable`.
+
+## MCP, Skills & Plugins
+
+Flavor can connect to stdio or Streamable HTTP MCP servers. Example project configuration:
+
+<details>
+<summary><strong>MCP configuration and CLI examples</strong></summary>
+
+```json
+{
+  "mcpServers": {
+    "docs": {
+      "url": "https://example.com/mcp",
+      "headers": {
+        "Authorization": "Bearer ${MCP_TOKEN}"
+      }
+    }
+  }
+}
+```
+
+MCP configuration can also be managed from the CLI:
+
+```bash
+flavor mcp list
+flavor mcp add docs --url https://example.com/mcp
+flavor mcp disable docs
+```
+
+</details>
+
+A Skill is a `SKILL.md` with YAML frontmatter, placed in `.flavor/skills/<name>/` or `~/.flavor-code/skills/<name>/`. Flavor loads skills progressively based on the task, and you can invoke one explicitly with `/<skill-name>`. Skill bodies support `$ARGUMENTS`, `$ARGUMENTS[N]`, and `$N` substitutions. A running composite Skill can load a dependency through the read-only `Skill` tool; plugin-qualified names such as `superharness:test-driven-development` resolve to discovered skills.
+
+Plugins live in `.flavor/plugins/` and can register commands, tools, hooks, Skill roots, and model adapters. Official plugins can be installed with the plugin manager: `npx --yes @flavor-code/plugin-manager`. `additionalContext` returned by `SessionStart` and `UserPromptSubmit` hooks is added to the current task context, enabling reliable project-level engineering policy injection. Plugin loads record a content fingerprint plus declared capabilities. Worker/vm isolation is available through the embedding API's `pluginSandbox: true` option; the compatibility default remains in-process because bundled and existing plugins use Node.js APIs that the isolated runtime does not yet mediate.
+
+When the `flavor-island` plugin is loaded, Flavor also starts a Flavor Island local control channel: a loopback-only IPC service (Windows named pipe, or Unix socket on macOS/Linux) secured by a random token. A host app (such as the Flavor Island desktop) can use it to abort, steer, or send follow-ups to a running session, and desktop hosts can also bring their window into focus. The channel's endpoint, token, and capability list are exposed to the host plugin via hook event context (`islandControlEndpoint`/`islandControlToken`/`islandControlCapabilities`); model-call duration and token usage, plus the final task summary and deliverables, are reported through hook events so the host can show live status and a result overview.
+
+> [!WARNING]
+> The default in-process plugin runtime grants full Node.js access. Only install and enable plugins you trust. Sandboxing reduces ambient access but does not make untrusted instructions safe, and plugins that import Node.js built-ins will not load with `pluginSandbox: true` yet.
+
+## Sessions, Memory & Execution Records
+
+Project runtime data lives under `.flavor/`:
+
+```text
+.flavor/
+├── flavor.json       # Project config
+├── sessions/         # Session timelines
+│   └── *.events.jsonl # Crash-consistent execution journals
+├── session-assets/   # Image attachments
+├── session-trees/    # Session branches
+├── checkpoints/      # Workspace snapshots
+├── memory/           # Long-term memory
+├── traces/           # Optional execution traces
+├── audit.jsonl       # Tool failure audits
+├── evolve/           # Self-improvement signals and run reflections
+├── skills/           # Project skills
+└── plugins/          # Project plugins
+```
+
+Long-term memory distinguishes user preferences, behavioral feedback, project conventions, and external references. Automatic extraction only keeps high-confidence candidates and provides confirm, ignore, and delete actions; secrets, tokens, raw tool output, and model guesses are rejected.
+
+Image prompts support PNG, JPEG, and WebP, with a 5 MiB per-image maximum and up to 5 images per prompt. The desktop app supports picking or drag-and-drop; CLI clipboard images currently work on Windows and macOS.
+
+## Permissions & Sandbox
+
+| Mode | Behavior |
+| --- | --- |
+| `default` | Reads are auto-approved; writes, Shell, network, and destructive actions are confirmed on demand |
+| `acceptEdits` | Workspace writes and routine verification are auto-approved |
+| `plan` | Read-only planning; no modifications or execution |
+| `bypassPermissions` | The main agent executes as much as possible after hard safety checks |
+| `auto` | A classifier decides, falling back to human approval when uncertain |
+| `bubble` | Uncertain operations bubble up to the main session for approval |
+
+Layered permission policies can be defined in the managed, user, project, local-project, and session tiers. Matching rules use token arrays and the strictest result always wins (`deny > ask > allow`); built-in hard denials cannot be weakened.
+
+> [!CAUTION]
+> Local Shell still runs as your current user. Consider enabling Docker when working with untrusted projects.
+
+<details>
+<summary><strong>Docker execution environment example</strong></summary>
+
+```json
+{
+  "execution": {
+    "mode": "docker",
+    "image": "node:24-bookworm-slim",
+    "network": false,
+    "memory": "2g",
+    "cpus": 2
+  }
+}
+```
+
+If Docker is unavailable, tasks fail rather than silently falling back to the host. Sensitive fields in config files and OAuth tokens are encrypted at rest with AES-256-GCM using a local configuration key.
+
+</details>
+
+## SDK, RPC & Evaluation
+
+<details>
+<summary><strong>Node.js SDK example</strong></summary>
+
+```ts
+import { createFlavorRuntime } from "flavor-code/sdk";
+
+const runtime = await createFlavorRuntime({
+  workspace: process.cwd(),
+  approvalPolicy: "deny",
+  output: console.log,
+});
+
+await runtime.session.start();
+await runtime.session.submit("fix the failing tests");
+await runtime.dispose();
+```
+
+</details>
+
+Other IDEs or languages can integrate over JSONL RPC:
+
+```bash
+flavor --mode rpc --workspace . --trace .flavor/traces/run.jsonl
+```
+
+Run evaluations:
+
+```bash
+flavor eval eval.json --output report.json
+```
+
+Design constraints for RPC, traces, replay, eval, session trees, and Docker are in the [control-plane spec](./docs/specs/2026-07-29-control-plane-sandbox-vscode.md).
+
+## Development
+
+```bash
+npm ci
+npm test
+npm run typecheck
+npm run vscode:typecheck
+npm run build
+npm run smoke:install
+```
+
+- TypeScript strict, targeting ES2022, Node.js 20+
+- Vitest for unit and integration tests
+- tsup builds the CLI, SDK, Electron main process, and VS Code extension
+- Vite builds the Electron renderer
+- CI covers Windows/macOS with Node 20/24
+
+Release builds do not generate or package source maps by default. For a local debugging build, enable them explicitly:
+
+```bash
+# macOS / Linux
+FLAVOR_SOURCEMAP=1 npm run build
+
+# Windows PowerShell
+$env:FLAVOR_SOURCEMAP = "1"
+npm run build
+```
+
+## Documentation
+
+- [Technical Design Report](./技术方案报告.md): overall architecture, agent loop, context, permissions, plugins, and security model
+- [Runtime reliability spec](./docs/specs/2026-07-26-runtime-reliability.md)
+- [1.3 reliability, prompt-cache & verification contract](./docs/specs/2026-08-24-v1.3-reliability-contract.md)
+- [Control plane, sandbox & VS Code spec](./docs/specs/2026-07-29-control-plane-sandbox-vscode.md)
+- [Multimodal image attachments spec](./docs/specs/2026-07-30-multimodal-image-attachments.md)
+- [D2C design-to-code spec](./docs/specs/2026-08-09-d2c-design-to-code.md)
+- [D2C review & integration spec](./docs/specs/2026-08-10-d2c-review-and-integration.md)
+- [E2E requirement-to-delivery spec](./docs/specs/2026-08-12-e2e-requirement-to-delivery.md)
+- [1.2.9 runtime productivity spec](./docs/specs/2026-08-13-runtime-productivity-waves.md)
+- [VS Code next steps](./docs/specs/2026-08-01-flavor-code-vscode-next.md)
+
+## Security Notes
+
+- Review model-generated code and commands, especially dependency installs, scripts, and deletions.
+- Do not treat `.flavor/sessions/`, traces, or long-term memory as secret stores.
+- Use least-privilege API keys and never commit `.env`.
+- Skill content can influence model behavior; sandboxed plugins still require review, while explicitly enabled legacy in-process plugins have full Node.js permissions.
+- Work under version control and create checkpoints before high-risk tasks.
+
+## Contributing
+
+Issues and Pull Requests are welcome. Please at least run the following before submitting:
+
+```bash
+npm test
+npm run typecheck
+npm run vscode:typecheck
+npm run build
+```
+
+For architecture changes, read the [Technical Design Report](./技术方案报告.md) and the relevant [design specs](./docs/specs/) first.
+
+## License
+
+[MIT](./LICENSE)
+
+<p align="center">
+  Made with 🌶️ by Flavor Code contributors.
+</p>