dsh-image-gen 0.3.1 → 0.4.1

package/README.en.md

@@ -1,155 +1,316 @@
 <div align="center">
 
-<img src="docs/assets/hero-poster.webp" alt="dsh-image-gen poster" width="100%" style="max-width: 860px; border-radius: 12px;" />
+<img src="docs/assets/readme/hero-en.webp" alt="dsh-image-gen feature overview" width="100%" />
 
-<br /><br />
+<br />
+
+<p><a href="README.md">简体中文</a> · <strong>English</strong></p>
 
 # 🎨 dsh-image-gen
 
-**Complete conversational image capabilities for DeepSeek Harness: text-to-image, image-to-image, multi-image references, continuous editing, local ComfyUI, and gallery management.**
+### Native AI image creation suite for DeepSeek Harness
 
-[![npm version](https://img.shields.io/npm/v/dsh-image-gen.svg?style=flat-square&color=blue)](https://www.npmjs.com/package/dsh-image-gen)
-[![DSH Plugin](https://img.shields.io/badge/Plugin%20For-DeepSeek%20Harness-6366f1?style=flat-square)](https://github.com/deepseek-ai)
-[![npm downloads](https://img.shields.io/npm/dm/dsh-image-gen.svg?style=flat-square&color=emerald)](https://www.npmjs.com/package/dsh-image-gen)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](LICENSE)
+<p><b>In-chat generation and editing · Studio batch creation · Multi-model comparison · 500+ prompt inspirations · Gallery management · Local ComfyUI</b></p>
 
-**English** | [简体中文](README.md)
+<p>
+  <a href="https://www.npmjs.com/package/dsh-image-gen"><img src="https://img.shields.io/npm/v/dsh-image-gen?style=flat-square&color=4f6ef7" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/dsh-image-gen"><img src="https://img.shields.io/npm/dm/dsh-image-gen?style=flat-square&color=10b981" alt="npm downloads" /></a>
+  <a href="https://github.com/shanliuling/dsh-image-gen/actions/workflows/ci.yml"><img src="https://github.com/shanliuling/dsh-image-gen/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+  <a href="https://github.com/shanliuling/dsh-image-gen/stargazers"><img src="https://img.shields.io/github/stars/shanliuling/dsh-image-gen?style=flat-square" alt="GitHub stars" /></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-f5c542?style=flat-square" alt="License: MIT" /></a>
+  <a href="https://linux.do/"><img src="https://img.shields.io/badge/LINUX%20DO-Community-555?style=flat-square" alt="LINUX DO" /></a>
+</p>
 
-<br />
-
-<p align="center">💬 <b>Prompt your DeepSeek Harness Agent to install:</b></p>
-
-```text
-Install the image generation plugin by running: pnpm dsh plugin --profile web add dsh-image-gen@latest
-```
-
-<p align="center"><sub>(Or run manually in terminal: <code>pnpm dsh plugin --profile web add dsh-image-gen@latest</code>)</sub></p>
+<p>
+  <a href="#quick-start">Quick Start</a> ·
+  <a href="#core-capabilities">Core Capabilities</a> ·
+  <a href="#provider-support">Provider Support</a> ·
+  <a href="#faq">FAQ</a>
+</p>
 
 <br />
 
-<p align="center">After installation, enter your API key or configure local ComfyUI in DSH Settings, then tell the Agent:</p>
+</div>
 
-```text
-Draw a cyberpunk cat on a neon street in a rainy night.
-```
+**A complete AI image creation workflow for DeepSeek Harness.**
 
-<p align="center">The Agent will automatically generate images and can also continue editing the previous image directly.</p>
+`dsh-image-gen` goes far beyond basic in-chat image generation. It brings **continuous natural-language editing**, **Studio batch creation**, **side-by-side multi-model comparison**, a **500+ prompt inspiration library**, and **local ComfyUI** workflows into DSH. It supports **Google Gemini, OpenAI Images / Compatible, ByteDance Seedream, Aliyun DashScope**, and private local workflows. It uses a BYOK model and can isolate generated assets by workspace.
 
-<br />
+```bash
+pnpm dsh plugin --profile web add dsh-image-gen@latest
+```
 
-<div align="center">
-  <img src="docs/assets/generate-example.png" alt="Initial image generation conversation" width="48%" style="vertical-align: top;" />
-  <img src="docs/assets/edit-example.png" alt="Continued image editing conversation" width="48%" style="vertical-align: top;" />
-</div>
+> **Update notice:** This release includes major changes. Existing users should update to the latest version.
 
-</div>
+<img src="docs/assets/readme/workflow-overview.webp" alt="dsh-image-gen complete AI image creation workflow" width="100%" />
 
 ---
 
-## 💡 What Problem Does It Solve?
+## One plugin, four creative workflows
 
-**`dsh-image-gen` is an open-source image generation and editing plugin built specifically for DeepSeek Harness (DSH).**
-
-DeepSeek Harness empowers agents to use tools for various tasks. This project adds native **multimodal image generation capabilities**:
-
-```mermaid
-graph LR
-    A[User Prompt] --> B[DeepSeek Harness Agent]
-    B --> C[generate_image / edit_image]
-    C --> D[Gemini / OpenAI / Seedream / DashScope / ComfyUI]
-    D --> E[Image Data]
-    E --> F[In-chat Conversation Stream]
-```
+| Entry | Best for | What you can do |
+| :--- | :--- | :--- |
+| 💬 **Chat** | Letting the Agent understand natural-language requests | Text-to-image, image-to-image, multi-image reference, continuous editing, and in-place regeneration |
+| 🎛️ **Studio** | Precise control over creation parameters | Batch generation, multiple reference images, and advanced canvas |
+| ✨ **Inspiration** | Finding compositions, styles, and prompts | Browse 500+ examples, search and filter, favorite, copy, or send a prompt to Studio |
+| 🖼️ **Gallery** | Organizing and reusing generated results | Search, filter, favorite, regenerate, download, batch-manage, and isolate by workspace |
 
 ---
 
-## 🚀 Quick Install & Usage
+## Quick Start
+
+### 1. Install the plugin
 
-### 1. Install Plugin
+Requirements: DeepSeek Harness stable version, Node.js `^22.19.0` or `>= 24.0.0`.
 
-In your DeepSeek Harness workspace root:
+Run this command from your DeepSeek Harness project root:
 
 ```bash
-# Recommended: Install or upgrade to latest release
 pnpm dsh plugin --profile web add dsh-image-gen@latest
-
-# If dsh is installed globally:
-dsh plugin --profile web add dsh-image-gen@latest
 ```
 
+> 💬 **Power-user tip:** You can also send this directly to the Agent in a DSH chat:<br />
+> `Install the image generation plugin by running this command in the terminal: pnpm dsh plugin --profile web add dsh-image-gen@latest`
+
 <details>
-<summary><b>🛠️ Alternative Installations (Git Repo / Local Dev)</b></summary>
+<summary><strong>Alternative installation methods (global / GitHub / local development)</strong></summary>
 
 ```bash
-# Method B: Install directly from GitHub
+# If dsh is installed globally:
+dsh plugin --profile web add dsh-image-gen@latest
+
+# Install the latest source directly from GitHub:
 pnpm dsh plugin --profile web add git+https://github.com/shanliuling/dsh-image-gen.git
 
-# Method C: Clone & install locally
+# Clone the repository and install it for local development:
 git clone https://github.com/shanliuling/dsh-image-gen.git
 pnpm dsh plugin --profile web add ./dsh-image-gen
 ```
 
 </details>
 
-### 2. Configure Provider & Workspace Settings
+### 2. Configure a Provider
 
-Open DSH Web (`http://localhost:3080`):
+After restarting DSH, open:
 
-1. Navigate to **Settings → Plugins → Image generation**.
-2. Select a Provider. Enter an API key for cloud providers; for local ComfyUI, enter its URL and import an API Format Workflow JSON using `{{prompt}}` for the prompt and optional `{{seed}}` for the seed. For image editing, put `{{image}}` (exactly once) in the LoadImage `image` input; the plugin uploads the source image and fills in the stored filename. ComfyUI supports importing multiple named workflows with one active at a time, and the Agent can also pick one by name via the optional `workflow` tool parameter.
-3. Optionally enable **Save to workspace** (enabled by default) and specify subfolder, then click **Save**.
+**Settings → Plugins → Plugin Configuration → Image Generation**
 
-<div align="center">
-  <img src="docs/assets/settings-preview.png?v=0.1.7" alt="Settings preview" width="720" />
-</div>
+Choose a Provider, enter your API key, and adjust the model, Endpoint / Base URL, and workspace-save options as needed. For ComfyUI, enter an address reachable by the DSH Host and import an **API Format Workflow JSON** file.
 
-### 3. Generate Images in Chat
+### 3. Start creating
 
-Simply prompt in the chat input:
+Describe the image you want directly in chat:
 
 ```text
-Generate a minimalist modern architecture living room illustration.
+Create a cinematic cyberpunk cat on a neon street at night, 16:9.
 ```
 
-The Agent will call `generate_image` and return the image directly in the conversation stream.
+You can also upload a reference image directly for style transfer or editing:
 
-### 4. Browse Native Image Gallery
+```text
+Keep the character and composition unchanged, then add black sunglasses to the cat.
+```
 
-Click the **`[Gallery]`** Tab in the top navigation bar to browse and search all generated images across conversations:
+<br />
 
 <div align="center">
-  <img src="docs/assets/gallery-preview.png" alt="Gallery preview" width="820" />
+  <img src="docs/assets/readme/provider-settings.webp" alt="DSH Plugin Settings" width="46%" />
+  <img src="docs/assets/readme/chat-example.webp" alt="Chat generation and editing example" width="46%" />
+  <br />
+  <sub>Left: Provider Settings · Right: In-chat generation, editing, and continuous refinement.</sub>
 </div>
 
+<br />
+
+For more precise parameter control, open **Gallery** from the conversation header, then switch between **Gallery / Studio / Inspiration / Favorites**.
+
 ---
 
-## ✨ Key Features
+## Core Capabilities
+
+### 💬 In-chat generation, editing, and revision switching
+
+- Use natural language for text-to-image, image-to-image, multi-image reference, and style transfer.
+- Edit the original prompt to regenerate, then switch between revisions on the same image card.
+
+<br />
+
+<div align="center">
+  <img src="docs/assets/readme/regenerating.webp" alt="Image regeneration in progress" width="46%" />
+  <img src="docs/assets/readme/revision-switcher.webp" alt="Switching between generated revisions on the same image card" width="46%" />
+  <br />
+  <sub>Regenerate in place after editing the prompt, then switch between previous results on the same image card.</sub>
+</div>
+
+<br />
+
+### 🎛️ Studio batch creation
+
+- Support multiple reference images, and generate multiple candidates at a time.
+- Control the Provider, model, aspect ratio, and quality, then save only the results you want.
+
+<br />
+
+<div align="center">
+  <img src="docs/assets/readme/studio-workbench.webp" alt="dsh-image-gen Studio workbench" width="100%" />
+  <br />
+  <sub>Import references, control parameters, generate batches, select results, and save—all within one Studio.</sub>
+</div>
+
+<br />
+
+### ⚖️ Side-by-side multi-model comparison
+
+Run the same prompt and reference images across multiple models, then compare and save the results on one canvas.
+
+<br />
+
+<div align="center">
+  <img src="docs/assets/readme/multi-model-compare.webp" alt="Comparing the same prompt across multiple image models" width="100%" />
+  <br />
+  <sub>Compare results from different models on one canvas, then save the images you prefer in a batch.</sub>
+</div>
+
+<br />
+
+### ✨ 500+ prompt inspiration examples
+
+- Browse and filter **500+ prompt examples**, then favorite, copy, or send them directly to Studio.
+- Images are cached locally, so browsing and learning consume no tokens or generation quota.
+
+<br />
+
+<div align="center">
+  <img src="docs/assets/readme/inspiration-library.webp" alt="Prompt inspiration library" width="100%" />
+  <br />
+  <sub>Find inspiration first, then send a prompt to Studio. Browsing and copying from the local cache consume no generation quota.</sub>
+</div>
+
+<br />
+
+### 🖼️ Gallery, favorites, and batch management
+
+- Manage images saved from chat and Studio in one place, isolated by workspace.
+- Search, filter, favorite, download, continue editing, regenerate, and batch-manage results.
+
+<br />
+
+<div align="center">
+  <img src="docs/assets/readme/gallery-management.webp" alt="Gallery filtering, favorites, and batch management" width="100%" />
+  <br />
+  <sub>Filter, favorite, and batch-manage gallery items while keeping data isolated by workspace.</sub>
+</div>
+
+<br />
+
+### 🧩 Multiple local ComfyUI workflows
+
+Bring private image generation on your local GPU directly into Agent conversations.
+
+- Import and manage multiple named workflows with prompt presets and common placeholders.
+- Let the Agent select a workflow by name for text-to-image or image-to-image generation in chat.
+
+> ComfyUI is not yet integrated into Studio or multi-model comparison.
+
+<br />
+
+<div align="center">
+  <img src="docs/assets/readme/comfyui-workflows.webp" alt="Multiple named ComfyUI workflow settings" width="58%" />
+  <br />
+  <sub>Maintain independent workflows for different tasks and let the Agent select them precisely by name.</sub>
+</div>
 
-- 💬 **In-Chat Image Generation**: Tell your Agent what you want to draw without switching tabs or tools.
-- 🖼️ **Native Image Gallery**: Dedicated "Gallery" tab automatically collecting all generated images with keyword search, provider filtering, single-item deletion (with confirmation and persistent tombstones), and quick copy/download.
-- 🔍 **Interactive Image Tools**: High-res fullscreen preview, one-click copy to clipboard, local download, and open in new tab.
-- 🎨 **Multi-Provider Support**: Supports Google Gemini, OpenAI Images, OpenAI Compatible API, ByteDance Seedream / Volcengine Ark, Aliyun DashScope (Wanx / Qwen-Image), and local ComfyUI workflows.
-- 🔑 **BYOK (Bring Your Own Key)**: Uses your own API keys managed securely by DSH credentials service with write-only protection.
-- 🖼️ **Durable Session Persistence**: Images integrate with DSH Attachment and conversation lifecycle, preserved across reloads.
-- 💾 **Workspace File Output**: By default each generated image is also written as a file into the current session workspace; the tool result carries the absolute file path. Can be disabled or re-pointed in settings.
-- ⚙️ **Native Web Settings**: Configure providers, keys, models, and endpoints directly in DSH settings.
+<br />
 
 ---
 
-## 📦 Supported Providers
+## Provider Support
+
+| Provider | Chat generation | Chat editing | Studio | Multi-model comparison |
+| :--- | :---: | :---: | :---: | :---: |
+| **Google Gemini** | ✅ | ✅ Multiple | ✅ | ✅ |
+| **OpenAI Images / Compatible** | ✅ | ✅ Multiple | ✅ | ✅ |
+| **ByteDance Seedream / Volcengine Ark** | ✅ | ✅ Multiple | ✅ | ✅ |
+| **Aliyun DashScope / Qwen Image** | ✅ | ✅ Multiple | ✅ | ✅ |
+| **Local ComfyUI** | ✅ | ✅ Single | — | — |
+
+> Studio and multi-model comparison currently support cloud Providers only. Multi-model comparison uses the model configured for each Provider in Settings.
 
-| Provider | Default Model | Default Endpoint / Base URL |
+<details>
+<summary><strong>Current default models and endpoints (all configurable)</strong></summary>
+
+| Provider | Default model | Default Endpoint / Base URL |
 | :--- | :--- | :--- |
-| **Google Gemini** | `gemini-3.1-flash-image` | `https://generativelanguage.googleapis.com/v1beta/interactions` |
-| **OpenAI Images** | `gpt-image-2` | `https://api.openai.com/v1` |
-| **OpenAI Compatible** | Custom | Custom Base URL |
-| **ByteDance Seedream / Volcengine Ark** | `doubao-seedream-5-0-260128` | `https://ark.cn-beijing.volces.com/api/v3` |
-| **Aliyun DashScope / Wanx** | `wanx2.1-t2i-turbo` | `https://dashscope.aliyuncs.com/api/v1` |
-| **Local ComfyUI (text-to-image & image-to-image)** | Imported API Format Workflow | `http://127.0.0.1:8188` |
+| Google Gemini | `gemini-3.1-flash-image` | `https://generativelanguage.googleapis.com/v1beta/interactions` |
+| OpenAI Images | `gpt-image-2` | `https://api.openai.com/v1` |
+| OpenAI Compatible | Custom | Custom Base URL |
+| ByteDance Seedream | `doubao-seedream-5-0-260128` | `https://ark.cn-beijing.volces.com/api/v3` |
+| Aliyun DashScope | `qwen-image-3.0` | `https://dashscope.aliyuncs.com/api/v1` |
+| Local ComfyUI | Imported API Workflow | `http://127.0.0.1:8188` |
+
+</details>
+
+---
+
+## Data and Privacy
+
+- **BYOK:** API keys are stored through the DSH Credentials service and are never displayed in plaintext on the settings page.
+- **Cloud requests:** The prompt and reference images used for a request are sent to the selected Provider. Follow that Provider's terms of service.
+- **Local ComfyUI:** Requests are sent to the configured ComfyUI address.
+- **Workspace files:** When workspace saving is enabled, chat results are written to disk; Studio saves only the candidates you select.
+- **Gallery and favorites:** Gallery metadata and favorite state are stored in the current browser's local storage.
+- **Inspiration cache:** Example metadata ships with the plugin. Images load on demand and are cached locally, and the cache can be cleared at any time.
+
+## FAQ
+
+<details>
+<summary><strong>What should I do if “Image Generation” is missing after installation?</strong></summary>
+
+Fully restart the current DSH Profile, then inspect the plugin configuration:
+
+```bash
+dsh --profile web --dump-config
+```
+
+If `dsh-image-gen` is absent from the output, run the installation command again. When filing an issue, include the DSH version, plugin version, and relevant error logs, but never include your API key.
+
+</details>
+
+<details>
+<summary><strong>Where are generated images saved?</strong></summary>
+
+When “Save to workspace” is enabled, chat results are saved to the `dsh-image-gen/` subdirectory of the current workspace by default. You can change this directory in Settings. Studio candidates remain on the temporary canvas until you select which results should enter the gallery and be saved.
+
+</details>
+
+<details>
+<summary><strong>Why is ComfyUI not available in Studio?</strong></summary>
+
+Studio and multi-model comparison currently support four cloud Provider families only. ComfyUI supports text-to-image, single-image editing, and multiple named workflows through Agent chat.
+
+</details>
+
+<details>
+<summary><strong>Does deleting an item from the gallery remove its chat message?</strong></summary>
+
+No. Deleting a gallery record does not modify the original chat message. You may separately choose to remove the corresponding local image file from the workspace. File deletion is normally irreversible, so confirm carefully.
+
+</details>
+
+<details>
+<summary><strong>How do I upgrade?</strong></summary>
+
+```bash
+pnpm dsh plugin --profile web add dsh-image-gen@latest
+```
+
+Restart the corresponding DSH Profile after upgrading.
+
+</details>
 
 ---
 
-## 🛠️ Local Development
+## Local Development
 
 ```bash
 git clone https://github.com/shanliuling/dsh-image-gen.git
@@ -157,16 +318,21 @@ cd dsh-image-gen
 
 pnpm install
 pnpm run typecheck
-pnpm run test
+pnpm test
 pnpm run build
-
 pnpm run pack:check
 ```
 
----
+Feedback is welcome through [Issues](https://github.com/shanliuling/dsh-image-gen/issues). Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a Pull Request.
 
-## 📄 License
+## License
 
-Open-sourced under the [MIT License](LICENSE).
+This project is open source under the [MIT License](LICENSE).
 
-If this plugin helps you, feel free to give it a ⭐️ **Star**!
+<div align="center">
+
+If `dsh-image-gen` improves your workflow, consider giving the project a ⭐ **Star** to support continued maintenance.
+
+**[View Releases](https://github.com/shanliuling/dsh-image-gen/releases) · [Open an Issue](https://github.com/shanliuling/dsh-image-gen/issues) · [Contribute](CONTRIBUTING.md)**
+
+</div>