Update README and ci config

ForteScarlet · ForteScarlet · commit 3d8a9560216b · 2025-12-06T16:07:39.000+08:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -198,19 +198,11 @@ jobs:
 
           ### Installation
 
-          **Plugins Branch Commit:** ${{ needs.commit-to-plugins-branch.outputs.plugins_commit_sha }}
+          **${{ github.ref_name }} Marketplace Commit:** ${{ needs.commit-to-plugins-branch.outputs.plugins_commit_sha }}
+          
+          **Download the ${{ github.ref_name }} of the product**: [Download](https://github.com/ForteScarlet/codex-kkp/archive/${{ needs.commit-to-plugins-branch.outputs.plugins_commit_sha }}.zip)
+          or download [codex-agent-collaboration-marketplace.zip](https://github.com/ForteScarlet/codex-kkp/releases/download/${{ github.ref_name }}/codex-agent-collaboration-marketplace.zip) from release's assets.
 
-          Install the plugin from the plugins branch for platform-specific packages.
-
-          ### Usage
-
-          Extract the platform-specific package and follow the instructions in `SKILL.md`.
-
-          For standalone executables, make them executable on Unix systems:
-          ```bash
-          chmod +x codex-kkp-cli-<platform>.kexe
-          ./codex-kkp-cli-<platform>.kexe
-          ```
           EOF
 
           cat release_notes.md
@@ -224,6 +216,7 @@ jobs:
           draft: false
           prerelease: false
           fail_on_unmatched_files: true
+          generate_release_notes: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
diff --git a/README.md b/README.md
@@ -2,8 +2,6 @@
 
 > KKP: **K**otlin Claude Code s**K**ill **P**lugin.
 
-[TOC]
-
 ## Overview
 
 Codex KKP is a Claude Code Plugin that enables seamless integration with Codex AI Agent for code
@@ -32,7 +30,7 @@ a subagent and a skill for code analysis, implementation, and collaboration task
 **1.1 Download source**
 
 [Download](https://github.com/ForteScarlet/codex-kkp/archive/refs/heads/plugins/release.zip)
-the source code for Branch `plugins/release` and extract it,
+the source code for Branch `plugins/release` and extract it.
 
 **1.2 Clone source**
 
@@ -72,7 +70,31 @@ and select a version (such as the [latest](https://github.com/ForteScarlet/codex
 
 Select the content you need from assets, download it, and configure it:
 
-#### 1. Download skills zip file
+#### 1. Download marketplace zip file
+
+The compressed file `codex-agent-collaboration-marketplace.zip` in Assets is a complete marketplace package that includes plugins and skills.
+
+After downloading and extracting, run Claude Code:
+
+```bash
+claude
+```
+
+Use the `/plugin` command:
+
+```bash
+/plugin
+```
+
+Choose `Add marketplace`:
+
+```bash
+> Add marketplace
+```
+
+Then enter the local path of your extracted marketplace directory (the directory containing the `.claude-plugin` directory).
+
+#### 2. Download skills zip file
 
 The compressed file `codex-agent-collaboration.zip` in Assets contains a unified multi-platform skill bundle.
 You can download and unzip it, then place the extracted directory in your skills directory
@@ -88,13 +110,13 @@ This single ZIP file includes executables for all supported platforms:
 
 Claude Code will automatically select the appropriate executable for your system.
 
-#### 2. Download executable binary file
+#### 3. Download executable binary file
 
 Standalone binary files (e.g., `codex-kkp-cli-macosx64`, `codex-kkp-cli-mingwx64`)
 in Assets are raw executable binaries for each platform.
 You can download only the executable file for your platform and design the skills yourself.
 
-Note: All executables use uniform naming without file extensions (including Windows builds).
+Note: All executables use uniform naming without file extensions (including Windows (`mingwx64`) builds).
 
 ### Tool installation and management
 
diff --git a/README_CN.md b/README_CN.md
@@ -0,0 +1,168 @@
+# Codex KKP
+
+> KKP: **K**otlin Claude Code s**K**ill **P**lugin。
+
+## 概述
+
+Codex KKP 是一个 Claude Code 插件，可与 Codex AI Agent 无缝集成，用于代码分析、实现和协作任务。
+提供 Codex AI Agent 的子代理(subagents)和技能(skills)。
+
+## 特性
+
+- **多平台支持**：原生二进制文件支持 macOS、Linux 和 Windows
+- **精简结果**：默认情况下，仅返回已完成的结果以减少 token 消耗
+- **沙箱模式**：可配置的安全级别（read-only, workspace-write, danger-full-access）
+- **会话管理**：恢复之前的会话并保持上下文
+- **子代理**：并行运行子代理以提高性能
+- **零糖零卡**：非常健康
+
+## 使用方法
+
+安装和配置完成后，您可以在 Claude Code 中使用 Codex KKP 插件。
+
+## 安装
+
+### 从仓库下载
+
+**1. 从仓库下载/克隆源代码**
+
+**1.1 下载源代码**
+
+[下载](https://github.com/ForteScarlet/codex-kkp/archive/refs/heads/plugins/release.zip)
+`plugins/release` 分支的源代码并解压。
+
+**1.2 克隆源代码**
+
+**或者**克隆仓库并
+[检出 `plugins/release` 分支](https://github.com/ForteScarlet/codex-kkp/tree/plugins/release)。
+
+```bash
+git clone -b plugins/release https://github.com/ForteScarlet/codex-kkp.git
+```
+
+**2. 添加到 Claude Code 的 marketplace**
+
+运行 claude：
+
+```bash
+claude
+```
+
+使用 `/plugin`：
+
+```bash
+/plugin
+```
+
+选择 `Add marketplace`：
+
+```bash
+> Add marketplace
+```
+
+然后输入您下载/克隆仓库的本地路径。
+
+### 从 releases 下载
+
+前往 [releases](https://github.com/ForteScarlet/codex-kkp/releases)
+并选择一个版本（例如[最新版本](https://github.com/ForteScarlet/codex-kkp/releases/latest)）。
+
+从 assets 中选择您需要的内容，下载并配置：
+
+#### 1. 下载 marketplace zip 文件
+
+Assets 中的压缩文件 `codex-agent-collaboration-marketplace.zip` 是包含 plugins 和 skills 在内的完整的 marketplace 包。
+
+下载并解压后，运行 Claude Code：
+
+```bash
+claude
+```
+
+使用 `/plugin` 命令：
+
+```bash
+/plugin
+```
+
+选择 `Add marketplace`：
+
+```bash
+> Add marketplace
+```
+
+然后输入您解压后的 marketplace 目录的本地路径（即包含 `.claude-plugin` 目录的目录）。
+
+#### 2. 下载 skills zip 文件
+
+Assets 中的压缩文件 `codex-agent-collaboration.zip` 是仅包含统一的多平台执行文件的 skill 包（不包括 plugins 等）。
+您可以下载并解压，然后将解压后的目录放置在您的 skills 目录中
+（例如 `<PROJECT_DIR>/.claude/skills/codex-agent-collaboration/`）。
+
+这个单一的 ZIP 文件包含所有支持平台的可执行文件：
+
+- macOS x86_64 (Intel) - `executables/codex-kkp-cli-macosx64`
+- macOS ARM64 (Apple Silicon) - `executables/codex-kkp-cli-macosarm64`
+- Linux x86_64 - `executables/codex-kkp-cli-linuxx64`
+- Linux ARM64 - `executables/codex-kkp-cli-linuxarm64`
+- Windows x86_64 - `executables/codex-kkp-cli-mingwx64`
+
+Claude Code 将自动为您的系统选择适当的可执行文件。
+
+#### 3. 下载可执行二进制文件
+
+Assets 中的独立二进制文件（例如 `codex-kkp-cli-macosx64`、`codex-kkp-cli-mingwx64`）
+是每个平台的原始可执行二进制文件。
+您可以仅下载适用于您平台的可执行文件并自行设计技能。
+
+注意：所有可执行文件使用统一的命名方式，因此不带文件扩展名（包括 Windows (`mingwx64`) 平台）。
+
+### 工具安装和管理
+
+一些开源项目可能允许通过仓库地址和分支独立管理 marketplace
+和技能（例如 [cc-switch](https://github.com/farion1231/cc-switch)，不过它仅限技能）。
+您也可以使用这些工具直接基于仓库和分支配置技能。
+
+## 配置
+
+完成插件安装后，
+您可以提前配置一些设置。
+
+编辑项目中的 `.claude/settings.local.json` 文件，
+并将以下配置添加到 `permissions.allow` 属性中：
+
+**仅安装技能**
+
+```json
+{
+  "permissions": {
+    "allow": [
+      "Skill(codex-agent-collaboration-plugin:codex-agent-collaboration)",
+      "Bash(~/.claude/skills/codex-agent-collaboration/executables/codex-kkp-cli-macosx64:*)"
+    ]
+  }
+}
+```
+
+**通过 marketplace 安装完整插件**
+
+```json
+{
+  "permissions": {
+    "allow": [
+      "Skill(codex-agent-collaboration-plugin:codex-agent-collaboration)",
+      "Bash(~/.claude/marketplace/codex-kkp-skills-marketplace/codex-agent-collaboration-plugin/skills/codex-agent-collaboration/executables/codex-kkp-cli-macosx64:*)"
+    ]
+  }
+}
+```
+
+> 如果本地加载，则 `~/.claude/marketplace/` 应替换为您本地下载的
+`codex-kkp-skills-marketplace` 所在的目录。
+
+在 `Bash` 中，路径指的是已安装插件包内对应您系统平台的可执行文件。
+您可能需要根据实际情况进行适当调整。
+
+## 许可证
+
+本项目采用 MIT 许可证 - 详情请参阅 [LICENSE](LICENSE) 文件。
diff --git a/codex-kkp-cli/build.gradle.kts b/codex-kkp-cli/build.gradle.kts
@@ -170,7 +170,7 @@ tasks.register<Zip>("packageMarketplace") {
     }
 
     // Enable inclusion of hidden files and directories
-    setIncludeEmptyDirs(true)
+    includeEmptyDirs = true
 
     archiveBaseName.set("codex-agent-collaboration-marketplace")
     archiveVersion.set("")

Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ tasks.register<Zip>("packageMarketplace") {`
`170`	`170`	`}`
`171`	`171`
`172`	`172`	`// Enable inclusion of hidden files and directories`
`173`		`- setIncludeEmptyDirs(true)`
	`173`	`+ includeEmptyDirs = true`
`174`	`174`
`175`	`175`	`archiveBaseName.set("codex-agent-collaboration-marketplace")`
`176`	`176`	`archiveVersion.set("")`