@muyichengshayu/promptx 0.1.6 → 0.1.8

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.1.8
+
+- 新增 OpenCode 执行引擎接入，补齐 runner、契约测试、Doctor 检查与文档说明，并支持在项目配置里直接选择 OpenCode。
+- 项目管理里的执行引擎列表改为服务端下发，避免前后端版本不一致时前端看不到新引擎选项。
+- 优化项目编辑规则：项目未执行前允许切换执行引擎，执行后自动锁定，保持与工作目录一致的配置心智。
+- 强化运行停止逻辑：用户点击停止后会立即进入强制停止流程，并补齐更可靠的跨平台子进程终止处理与“正在停止...”反馈。
+
+## 0.1.7
+
+- 新增多引擎运行器抽象，除了 Codex 之外，现已支持接入 Claude Code，并统一项目层的执行引擎配置与展示。
+- 统一 agent run 事件协议与查询语义，补齐共享事件常量、Runner 契约测试和执行过程查询模式，降低后续扩展新引擎的接入成本。
+- 重构工作台中栏执行面板，拆分运行历史、会话动作、折叠状态与自动滚动逻辑，提升可维护性。
+- 优化执行过程体验：最新一条 turn 默认返回并展开完整提示词 / 执行过程 / 回复，历史 turn 按需展开加载，滚动行为更接近 IM。
+- 新增页面级 E2E，覆盖最新 turn 默认展开、历史执行过程展开加载、以及执行面板滚动跟随规则。
+
 ## 0.1.6
 
 - 新增多租户 Relay 子域名接入能力，一个 Relay 进程即可同时服务多个同事的远程访问。

package/LICENSE

@@ -0,0 +1,215 @@
+Copyright 2026 PromptX Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -2,22 +2,41 @@
 
 PromptX 是一个面向本机 AI 协作的轻量工作台。
 
-它适合先整理需求、截图、文本、PDF、禅道 Bug 等上下文，再持续发送给本机 Codex，在同一页里查看执行过程和多轮结果。
+它适合先整理需求、截图、文本、PDF、禅道 Bug 等上下文，再持续发送给本机 AI Agent，在同一页里查看执行过程和多轮结果。
 
 ## 核心能力
 
 - 左侧管理任务，中间查看项目执行过程，右侧整理输入内容
 - 支持文本、图片、`md`、`txt`、`pdf`
-- 支持为任务绑定本机项目，并持续复用同一个 Codex 线程
+- 支持为任务绑定本机项目，并持续复用同一个执行引擎线程
+- 支持多执行引擎，当前已接入 `Codex`、`Claude Code`、`OpenCode`
 - 支持查看执行过程、代码变更和最终回复
 - 支持公开页与 Raw 导出
 - 内置禅道 Chrome 扩展，可一键把 Bug 内容带入工作台
 
+## 项目截图
+
+### 工作台
+
+![PromptX 工作台](docs/assets/workbench-overview.jpg)
+
+### 设置
+
+![PromptX 设置](docs/assets/settings-panel.jpg)
+
+### 手机端
+
+![PromptX 手机端](docs/assets/mobile-remote.jpg)
+
 ## 运行前提
 
 - 已安装 Node，支持 `20`、`22`、`24`，推荐 `22`
-- 本机可以正常运行 `codex --version`
-- Codex 已开启高权限，并使用满血模式
+- 本机至少安装一个可用执行引擎
+- 当前支持：
+  - `codex --version`
+  - `claude --version`
+  - `opencode --version`
+- 如使用 Codex，建议开启高权限并使用满血模式
 
 ## 安装
 
@@ -53,9 +72,21 @@ promptx doctor
 1. 打开工作台，新建或选择一个任务
 2. 在右侧整理文本、图片、文件等上下文
 3. 在中间选择一个 PromptX 项目
-4. 点击发送，把当前内容交给 Codex
+4. 为项目选择执行引擎，并点击发送
 5. 在中间继续查看执行过程，并按需多轮发送
 
+## 当前支持的执行引擎
+
+- `Codex`
+- `Claude Code`
+- `OpenCode`
+
+PromptX 内部已经开始使用统一的 agent run 事件协议，后续继续扩展其他执行引擎时，前端展示层和执行过程面板可以尽量复用。
+
+如需查看这套协议约定，可参考：
+
+- `docs/agent-run-protocol.md`
+
 ## 远程访问 Relay（预览）
 
 如果你希望在手机上远程访问自己电脑上的 PromptX，或想在云端部署多租户 Relay，请直接查看：
@@ -89,10 +120,10 @@ promptx doctor
 
 ## 注意事项
 
-- 当前只支持 Codex，不支持其他模型后端
 - 当前以本机单用户使用为主，不包含账号体系和团队权限
 - 默认仅监听本机地址；如需跨设备访问，建议通过 Tailscale
-- 如果 Codex 运行在受限权限下，文件读写和自动修改能力会明显受限
+- 如果执行引擎运行在受限权限下，文件读写和自动修改能力会明显受限
+- 不同执行引擎的工具能力、输出事件丰富度和稳定性可能会有差异
 
 ## 本地数据目录
 
@@ -104,3 +135,7 @@ uploads/
 tmp/
 run/
 ```
+
+## 开源协议
+
+本项目采用 `Apache-2.0` 开源协议，详见根目录 `LICENSE`。