@sanqianx/claude-ai-workbench 0.11.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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
+
+       https://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

@@ -0,0 +1,129 @@
+# Claude AI Workbench
+
+面向本地开发工具的 Claude Code 工作台 SDK，提供 AI Profile 管理、凭据隔离、版本化 REST/SSE API、Client SDK 和可嵌入 Web Components。
+
+0.3.0 起，仓库同时提供 **Agent Terminal**：一个通用多 Agent 对话终端（Claude Code / Codex / OpenCode / ZCode），带多项目工作区、自定义模型供应商管理、Agent 发现与能力矩阵、推理力度与上下文用量显示。
+
+## 仓库结构
+
+- `packages/`：可发布的 SDK 源码。
+- `apps/`：Agent Terminal 整页应用、AI Profile 页面和最小测试宿主。
+- `docs/sdk/`：正式接入文档、文件说明和 OpenAPI；`docs/archive/` 为历史过程文档存档。
+- `tests/`：单元、集成、契约与真实连接测试。
+- `dist/sdk/`：执行打包命令后生成的 `.tgz` 安装包。
+- `src/`、`ui/`：现有运行时与兼容层实现。
+
+详细说明见 [SDK 总览](docs/sdk/README.md) 和 [文件布局](docs/sdk/FILE_LAYOUT.md)。
+
+## SDK 包
+
+- `@claude-ai-workbench/contracts`：公共数据类型，类似 C++ 头文件。
+- `@claude-ai-workbench/client`：HTTP/SSE Client SDK。
+- `@claude-ai-workbench/core`：终端状态机与会话生命周期。
+- `@claude-ai-workbench/ui`：AI Profile Web Components。
+- `@claude-ai-workbench/server`：REST/SSE Server 和命令行程序。
+
+五个包使用相同版本号发布。
+
+## 独立安装与命令行
+
+无需克隆仓库，直接从 npm 安装即可获得 `claude-workbench` 命令（包名 `claude-ai-workbench` 也注册为同一命令的别名，两者等价）：
+
+```powershell
+npm install -g claude-ai-workbench
+claude-workbench -v              # 打印版本
+claude-workbench                 # 前台启动（Ctrl+C 停止）
+claude-workbench start -d        # 后台启动
+claude-workbench status          # 查看运行状态
+claude-workbench stop            # 停止运行中的服务
+```
+
+启动的是 **Agent Terminal**（当前深色 UI 产品）：`http://127.0.0.1:5760/agent-terminal/`（`AGENT_TERMINAL_PORT` / `AGENT_TERMINAL_HOST` 覆盖，`CLAUDE_WORKBENCH_PORT` 兼容），数据目录 `~/.agent-terminal`（`AGENT_TERMINAL_DATA_DIR` 覆盖），与旧工作台数据完全隔离。`stop` 优先按 pid 文件定位进程，pid 文件缺失时按端口探测兜底，因此对经由原始启动脚本拉起的实例同样有效。端口被占用时启动会给出明确提示与处理建议（`claude-workbench stop` 或改端口），而不是抛出原始错误堆栈。
+
+## 启动 Agent Terminal（独立产品）
+
+```powershell
+npm run start:agent-terminal
+```
+
+- 页面：`http://127.0.0.1:5760/agent-terminal/`
+- 数据目录：`~/.agent-terminal`（`AGENT_TERMINAL_DATA_DIR` 覆盖；端口 `AGENT_TERMINAL_PORT`）
+- 首次使用：设置 → 模型供应商 → 添加供应商（Base URL / API Key / 模型列表），然后添加本地项目文件夹即可开聊。
+- Agent 发现自动扫描本机：Claude Code（Agent SDK，支持 Anthropic 兼容端点如 MiniMax）、Codex（`codex exec --json`，使用自身登录）、OpenCode（`opencode run --format json`）、ZCode（已安装但暂无 headless CLI，如实标注不可用）。
+- 零点击模型检测：填好 Base URL 与 API Key 后自动探测 `/v1/models` 并合并 models.dev 能力数据（上下文窗口、模态、推理），保存时自动填充模型列表与上下文大小。
+- 会话内模型切换：切换供应商/模型不换会话，历史跨供应商延续（Claude 保留 resume，CLI 保留线程参数）。
+- 运行时体验对齐：中断不再误报退出码错误、stderr 聚合为单个折叠、上下文用量按轮取最大值而非累计求和。
+
+## 启动开发服务器
+
+```powershell
+$env:CLAUDE_AI_WORKBENCH_DATA_DIR = 'D:\data\claude-workbench'
+$env:CLAUDE_WORKBENCH_WORKSPACES = '{"my-project":"D:\repos\my-project"}'
+npm start
+```
+
+默认地址：
+
+- API：`http://127.0.0.1:5760/api/claude-workbench/v1`
+- AI Profile 示例：`http://127.0.0.1:5760/profile-settings/`
+
+- 最小测试宿主：`http://127.0.0.1:5762/test-host/`（通过 `npm run start:test-host` 启动，使用 `%USERPROFILE%\.claude-ai-workbench` 作为稳定产品数据目录，存放 `profiles.v2.json` 与凭据 `credentials.v1.json`）
+
+## 真实 Agent 连接测试（可选）
+
+```powershell
+$env:AGENT_TERMINAL_REAL = 'claude'        # 或 codex / opencode / zcode
+$env:AGENT_TERMINAL_MINIMAX_API_KEY = '<anthropic 兼容端点的 key>'
+npm run test:real
+```
+
+## 启动最小测试宿主
+
+最小测试宿主是面向真实 Server + Runtime 的验收页面，必须使用稳定产品数据目录（而非临时目录），以便配置和凭据可以反复使用：
+
+```powershell
+npm run start:test-host
+```
+
+脚本 `scripts/start-test-host.ps1` 默认端口 5762，会设置 `CLAUDE_WORKBENCH_PORT=5762`、`CLAUDE_WORKBENCH_SERVE_HOST=1`，并自动创建数据目录。也可以传入 `-Port` 或 `-DataDir` 自定义。打开 `http://127.0.0.1:5762/test-host/` 即可使用，Profile 元数据写入 `profiles.v2.json`，凭据单独写入 `credentials.v1.json`。
+
+## SDK 打包
+
+```bash
+npm run sdk:check
+npm run sdk:pack
+```
+
+输出位于 `dist/sdk/`，包含四个 npm tarball 和带 SHA-256 的 `manifest.json`。
+
+## Web 接入
+
+```js
+import "@claude-ai-workbench/ui";
+import "@claude-ai-workbench/ui/theme.css";
+import { createClaudeWorkbenchClient } from "@claude-ai-workbench/client";
+```
+
+```html
+<ai-profile-list id="profileList"></ai-profile-list>
+<ai-profile-editor id="profileEditor"></ai-profile-editor>
+```
+
+完整事件连接代码见 [接入说明](docs/sdk/INTEGRATION.md)。C++、C# 和 Java 等非 JavaScript 系统直接按照 [OpenAPI](docs/sdk/openapi.yaml) 调用 HTTP JSON API。
+
+## 安全边界
+
+- Profile 和 Credential 分文件保存。
+- 普通 Profile 响应不返回明文 API Key，只返回配置状态和掩码预览。
+- 临时测试 `/profiles/test` 不保存表单或凭据。
+- 浏览器提供 `workspaceRef`，服务端负责将它解析为白名单工作目录。
+- 默认服务只监听本机；跨机器部署必须增加 HTTPS、认证和访问控制。
+
+## 验证
+
+```bash
+npm run verify
+npm run test:real
+```
+
+普通测试使用可控 Runner 验证契约和生命周期；真实测试需要设置 `CLAUDE_AI_WORKBENCH_DATA_DIR` 与 `CLAUDE_WORKBENCH_REAL_PROFILE_ID`。