agent-cli-lib 0.1.0__py3-none-any.whl

agent_cli_lib-0.1.0.dist-info/METADATA

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: agent-cli-lib
+Version: 0.1.0
+Summary: Unified Python interface for agent CLI bases (opencode, pi, hermes)
+License: MIT
+License-File: LICENSE
+Keywords: agent,cli,opencode,llm
+Author: SongJuYi 1327898686@qq.com
+Requires-Python: >=3.10,<3.15
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: agent-client-protocol (>=0.9.0,<0.10)
+Requires-Dist: typing-extensions (>=4.9)
+Project-URL: Homepage, https://gitee.com/mdsSJY/agent-cli-lib-py
+Project-URL: Repository, https://gitee.com/mdsSJY/agent-cli-lib-py
+Description-Content-Type: text/markdown
+
+# agent-cli-lib
+
+对 opencode、pi、hermes 等 agent CLI 基座统一封装的 Python 库。对支持
+[ACP](https://agentclientprotocol.com)（Agent Client Protocol）的 CLI，以 **ACP 客户端**方式驱动
+（协议化通道：流式、权限回调、优雅取消）；ACP 覆盖不到的能力（会话导出归档等）与
+无 ACP 的 CLI，走子进程封装，对外一套接口。
+
+```python
+from agent_cli_lib import AgentRunner
+
+runner = AgentRunner(backend="opencode", workdir="/my/project")
+result = runner.run("修复登录 bug")
+print(result.session_id, result.output)
+runner.resume(result.session_id)   # 按 id 恢复会话
+```
+
+`agent_cli_lib.api` 是公开签名门面层：完整签名 + Examples 使用提示，并内置废弃/移除注解。
+
+```python
+from agent_cli_lib import run                       # 模块级快捷入口（来自 api 签名层）
+from agent_cli_lib.api import deprecated, removed   # 废弃/移除注解（deprecated 为 PEP 702）
+
+result = run("修复登录 bug", backend="pi")
+```
+
+📖 接口速查文档：[docs/api.md](docs/api.md)
+
+## 支持的 Agent CLI 版本
+
+本库按实测版本适配（各 CLI 输出格式与导出行为随版本变化），版本基线统一维护在：
+[docs/dev/provider-setup.md](docs/dev/provider-setup.md#版本基线)
+（配套验证镜像 `docker/Dockerfile`（opencode v1）与 `docker/Dockerfile.v2`（opencode v2），
+均内置 pi/hermes/hermes `[acp]`）。
+
+## 功能
+
+1. 参数切换后端（opencode / pi / hermes）
+2. 错误异常自处理（类型化异常体系）
+3. prompt 支持文件路径与字符串
+4. session 会话文件导出
+5. 任务完成后返回 session id；支持用 session id 或 session 文件路径恢复会话
+6. 并发场景下可终止运行
+7. 启动 agent 时指定工作路径
+8. API 签名门面层（`agent_cli_lib.api`）：公开签名 + 使用提示，内置 `deprecated` / `removed` 注解
+
+## 路线图
+
+- **ACP 传输**：opencode v1/v2 已实测 run/resume/cancel 可用（v2 含权限往返；v1 权限往返
+  协议同构、实现期补测），作为 ACP 客户端驱动；export 等协议空白项自动降级 CLI 子进程。
+  架构与实测矩阵：[docs/dev/todo/acp-architecture-upgrade.md](docs/dev/todo/acp-architecture-upgrade.md)
+
+## 部署建议（高并发）
+
+SDK 的并发机制已实测验证（多线程混合任务、取消、无进程残留）。agent CLI 的资源
+消耗属 CLI 侧行为（每个 ACP 在飞任务约 150MB，随并发线性增长），不归 SDK 管——
+高并发部署推荐把 agent 任务放进**沙箱（容器）**里运行，资源配额由沙箱统一管理，
+SDK 与调用方无感。
+
+## 安装
+
+运行时依赖 [`agent-client-protocol`](https://github.com/agentclientprotocol/python-sdk)（官方 ACP SDK，
+pip 安装本库时自动带入，含传递依赖 pydantic）。
+
+### 第一阶段：通过 Gitee Git 引用
+
+```bash
+# pip
+pip install git+https://gitee.com/<user>/agent-cli-lib-py.git
+
+# uv
+uv add agent-cli-lib@git+https://gitee.com/<user>/agent-cli-lib-py.git
+
+# poetry
+poetry add agent-cli-lib@git+https://gitee.com/<user>/agent-cli-lib-py.git
+```
+
+### 第二阶段：PyPI（稳定后）
+
+```bash
+pip install agent-cli-lib
+```
+
+## 开发
+
+开发环境使用 conda（环境名 `agent-cli`），包管理使用 poetry，harness 使用 just。
+
+```bash
+conda create -n agent-cli python=3.12 -y
+conda run -n agent-cli pip install poetry
+just install   # 安装依赖
+just check     # lint + typecheck + test
+```
+
+常用命令（`just --list` 查看全部）：
+
+| 命令 | 说明 |
+| --- | --- |
+| `just install` | 安装/同步依赖 |
+| `just fmt` | 格式化代码 |
+| `just lint` | 静态检查 |
+| `just typecheck` | ty 类型检查 |
+| `just test` | 运行测试 |
+| `just check` | 全量质量门禁 |
+| `just build` | 构建 wheel/sdist |
+| `just publish` | 发布到 PyPI |
+
+📖 后端能力 × 各 CLI 官方指令对照：[docs/dev/backend-commands.md](docs/dev/backend-commands.md)
+

agent_cli_lib-0.1.0.dist-info/RECORD

@@ -0,0 +1,31 @@
+agent_cli_lib/__init__.py,sha256=Bow-77PftR8VYJluL49o0Mru4YvVDZ1aggsf7kgZPXU,954
+agent_cli_lib/api/__init__.py,sha256=ou87EQF2wafGSZ-vrIw3PrCMWJ-7Pzv6UHZ4eL9u3w4,804
+agent_cli_lib/api/decorators.py,sha256=R-hxzzjZ18jAEEAyfODPP8UUkV8z0U9Mso2UZfCWls4,1306
+agent_cli_lib/api/prompt.py,sha256=He7v-B7fBvAUfW-nsn2OMQE8r5Rw0VvjjN4kVRkltfc,303
+agent_cli_lib/api/runner.py,sha256=fIcKK3kbSFHdnfPJW9Z10c94keQqRub_j8eBk9XpFQM,3083
+agent_cli_lib/api/session.py,sha256=NepJ3U9LFXOMMj8w8-b8lQXWfWMwYWT5ZJuDd-VKxJY,321
+agent_cli_lib/backends/__init__.py,sha256=ifAHL1T3a_NUtg_16Ro8F-GuMHKtqsOb1tuK9DFZFWs,58
+agent_cli_lib/backends/base.py,sha256=37be-jYQ0Yx7fNyjZ0GrdPgHtG_tUw2WSXN-uwqo-kE,3154
+agent_cli_lib/backends/hermes/__init__.py,sha256=RCb97lhFwLTV-Jm43crsaMFgyquY80aM-y3H2ksGu3k,151
+agent_cli_lib/backends/hermes/backend.py,sha256=bIKf6She1b42NiRen4qajknjKhnX1ZRspUvv4Z0exfc,3194
+agent_cli_lib/backends/opencode/__init__.py,sha256=bnr94c9-ILhpPJlW9ywwQnf94jclmh_heh9Ou5jGhdA,337
+agent_cli_lib/backends/opencode/backend.py,sha256=6bdiLxXhlVYgmC7doLWWWxDXME1p3EvSUMOWcauGA0g,12012
+agent_cli_lib/backends/opencode/specs.py,sha256=2U9ZALuuc7fI7B-wXDHm5O-6v3TAxSI_VExquMRMzts,1295
+agent_cli_lib/backends/pi/__init__.py,sha256=ARVlTRWwfptcn7MOpwNgPxkOW3XCxH5OrnY238hYu6o,135
+agent_cli_lib/backends/pi/backend.py,sha256=K13UZDCp_MGrsu9peD3PJqKr0hs1ckFEEfu8TR-mmxc,4726
+agent_cli_lib/core/__init__.py,sha256=yeBk9pGb_O9_11Cez_Oj4qiY72HIbonfZ1ezEuTq6Ys,71
+agent_cli_lib/core/acp/__init__.py,sha256=yUsJYAceTkb4NVtKOAgTvdeP1lCTEUAN9TnJGa9Xtnk,416
+agent_cli_lib/core/acp/client.py,sha256=ax97xLNAr_mYqaXlkrrsi-KfxYbsvc4PAtX9luEEcjk,10126
+agent_cli_lib/core/acp/driver.py,sha256=BAf_H1FbwMa62fvhGa1Q5n6GSImYkrhtHHxbX-7dTXM,15457
+agent_cli_lib/core/acp/wire.py,sha256=wejm5Aqra-uBuKStzt53oRlEFAPt_h45SgU5nCSkK-k,2961
+agent_cli_lib/core/driver_base.py,sha256=FClIWXHxow6wbwdcYtNOb6Et331jkuJP5sEc6s11i00,1161
+agent_cli_lib/core/proctree.py,sha256=1rKq7pCnGIb6bbD4TU_hmmW-fR5mihJ3tJ_U3m-D480,1325
+agent_cli_lib/core/prompt.py,sha256=cnJhjkb1TMn5y5WKrU4ofdGCMhBPukGgS7wKtdpWH4E,1061
+agent_cli_lib/core/runner.py,sha256=BV-hub-JX_c4qgIL4nAGYXw1dwvrjsdBVzVolSbkhA0,12452
+agent_cli_lib/core/session.py,sha256=YJZi700XoznpTZSsBYO5ZeHbysSyt5yVUOi1MaqnIaY,1997
+agent_cli_lib/errors.py,sha256=9V66f5uM_V026CXpG4B392AOI78SUZ7566SlWyPoTIw,3402
+agent_cli_lib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+agent_cli_lib-0.1.0.dist-info/METADATA,sha256=AMMNoE6DlkJLXf2aSB66XtiPqMGccpcxzDOn3JpM2AA,5049
+agent_cli_lib-0.1.0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
+agent_cli_lib-0.1.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+agent_cli_lib-0.1.0.dist-info/RECORD,,

agent_cli_lib-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.4.0
+Root-Is-Purelib: true
+Tag: py3-none-any

agent_cli_lib-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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.