agent-cli-lib 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. agent_cli_lib-0.1.0/LICENSE +201 -0
  2. agent_cli_lib-0.1.0/PKG-INFO +133 -0
  3. agent_cli_lib-0.1.0/README.md +107 -0
  4. agent_cli_lib-0.1.0/pyproject.toml +70 -0
  5. agent_cli_lib-0.1.0/src/agent_cli_lib/__init__.py +48 -0
  6. agent_cli_lib-0.1.0/src/agent_cli_lib/api/__init__.py +25 -0
  7. agent_cli_lib-0.1.0/src/agent_cli_lib/api/decorators.py +37 -0
  8. agent_cli_lib-0.1.0/src/agent_cli_lib/api/prompt.py +10 -0
  9. agent_cli_lib-0.1.0/src/agent_cli_lib/api/runner.py +85 -0
  10. agent_cli_lib-0.1.0/src/agent_cli_lib/api/session.py +10 -0
  11. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/__init__.py +1 -0
  12. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/base.py +84 -0
  13. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/hermes/__init__.py +5 -0
  14. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/hermes/backend.py +85 -0
  15. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/opencode/__init__.py +10 -0
  16. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/opencode/backend.py +296 -0
  17. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/opencode/specs.py +39 -0
  18. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/pi/__init__.py +5 -0
  19. agent_cli_lib-0.1.0/src/agent_cli_lib/backends/pi/backend.py +116 -0
  20. agent_cli_lib-0.1.0/src/agent_cli_lib/core/__init__.py +1 -0
  21. agent_cli_lib-0.1.0/src/agent_cli_lib/core/acp/__init__.py +13 -0
  22. agent_cli_lib-0.1.0/src/agent_cli_lib/core/acp/client.py +248 -0
  23. agent_cli_lib-0.1.0/src/agent_cli_lib/core/acp/driver.py +344 -0
  24. agent_cli_lib-0.1.0/src/agent_cli_lib/core/acp/wire.py +73 -0
  25. agent_cli_lib-0.1.0/src/agent_cli_lib/core/driver_base.py +35 -0
  26. agent_cli_lib-0.1.0/src/agent_cli_lib/core/proctree.py +40 -0
  27. agent_cli_lib-0.1.0/src/agent_cli_lib/core/prompt.py +32 -0
  28. agent_cli_lib-0.1.0/src/agent_cli_lib/core/runner.py +305 -0
  29. agent_cli_lib-0.1.0/src/agent_cli_lib/core/session.py +57 -0
  30. agent_cli_lib-0.1.0/src/agent_cli_lib/errors.py +105 -0
  31. agent_cli_lib-0.1.0/src/agent_cli_lib/py.typed +0 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,133 @@
1
+ Metadata-Version: 2.4
2
+ Name: agent-cli-lib
3
+ Version: 0.1.0
4
+ Summary: Unified Python interface for agent CLI bases (opencode, pi, hermes)
5
+ License: MIT
6
+ License-File: LICENSE
7
+ Keywords: agent,cli,opencode,llm
8
+ Author: SongJuYi 1327898686@qq.com
9
+ Requires-Python: >=3.10,<3.15
10
+ Classifier: Development Status :: 2 - Pre-Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Programming Language :: Python :: 3.14
19
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
20
+ Requires-Dist: agent-client-protocol (>=0.9.0,<0.10)
21
+ Requires-Dist: typing-extensions (>=4.9)
22
+ Project-URL: Homepage, https://gitee.com/mdsSJY/agent-cli-lib-py
23
+ Project-URL: Repository, https://gitee.com/mdsSJY/agent-cli-lib-py
24
+ Description-Content-Type: text/markdown
25
+
26
+ # agent-cli-lib
27
+
28
+ 对 opencode、pi、hermes 等 agent CLI 基座统一封装的 Python 库。对支持
29
+ [ACP](https://agentclientprotocol.com)(Agent Client Protocol)的 CLI,以 **ACP 客户端**方式驱动
30
+ (协议化通道:流式、权限回调、优雅取消);ACP 覆盖不到的能力(会话导出归档等)与
31
+ 无 ACP 的 CLI,走子进程封装,对外一套接口。
32
+
33
+ ```python
34
+ from agent_cli_lib import AgentRunner
35
+
36
+ runner = AgentRunner(backend="opencode", workdir="/my/project")
37
+ result = runner.run("修复登录 bug")
38
+ print(result.session_id, result.output)
39
+ runner.resume(result.session_id) # 按 id 恢复会话
40
+ ```
41
+
42
+ `agent_cli_lib.api` 是公开签名门面层:完整签名 + Examples 使用提示,并内置废弃/移除注解。
43
+
44
+ ```python
45
+ from agent_cli_lib import run # 模块级快捷入口(来自 api 签名层)
46
+ from agent_cli_lib.api import deprecated, removed # 废弃/移除注解(deprecated 为 PEP 702)
47
+
48
+ result = run("修复登录 bug", backend="pi")
49
+ ```
50
+
51
+ 📖 接口速查文档:[docs/api.md](docs/api.md)
52
+
53
+ ## 支持的 Agent CLI 版本
54
+
55
+ 本库按实测版本适配(各 CLI 输出格式与导出行为随版本变化),版本基线统一维护在:
56
+ [docs/dev/provider-setup.md](docs/dev/provider-setup.md#版本基线)
57
+ (配套验证镜像 `docker/Dockerfile`(opencode v1)与 `docker/Dockerfile.v2`(opencode v2),
58
+ 均内置 pi/hermes/hermes `[acp]`)。
59
+
60
+ ## 功能
61
+
62
+ 1. 参数切换后端(opencode / pi / hermes)
63
+ 2. 错误异常自处理(类型化异常体系)
64
+ 3. prompt 支持文件路径与字符串
65
+ 4. session 会话文件导出
66
+ 5. 任务完成后返回 session id;支持用 session id 或 session 文件路径恢复会话
67
+ 6. 并发场景下可终止运行
68
+ 7. 启动 agent 时指定工作路径
69
+ 8. API 签名门面层(`agent_cli_lib.api`):公开签名 + 使用提示,内置 `deprecated` / `removed` 注解
70
+
71
+ ## 路线图
72
+
73
+ - **ACP 传输**:opencode v1/v2 已实测 run/resume/cancel 可用(v2 含权限往返;v1 权限往返
74
+ 协议同构、实现期补测),作为 ACP 客户端驱动;export 等协议空白项自动降级 CLI 子进程。
75
+ 架构与实测矩阵:[docs/dev/todo/acp-architecture-upgrade.md](docs/dev/todo/acp-architecture-upgrade.md)
76
+
77
+ ## 部署建议(高并发)
78
+
79
+ SDK 的并发机制已实测验证(多线程混合任务、取消、无进程残留)。agent CLI 的资源
80
+ 消耗属 CLI 侧行为(每个 ACP 在飞任务约 150MB,随并发线性增长),不归 SDK 管——
81
+ 高并发部署推荐把 agent 任务放进**沙箱(容器)**里运行,资源配额由沙箱统一管理,
82
+ SDK 与调用方无感。
83
+
84
+ ## 安装
85
+
86
+ 运行时依赖 [`agent-client-protocol`](https://github.com/agentclientprotocol/python-sdk)(官方 ACP SDK,
87
+ pip 安装本库时自动带入,含传递依赖 pydantic)。
88
+
89
+ ### 第一阶段:通过 Gitee Git 引用
90
+
91
+ ```bash
92
+ # pip
93
+ pip install git+https://gitee.com/<user>/agent-cli-lib-py.git
94
+
95
+ # uv
96
+ uv add agent-cli-lib@git+https://gitee.com/<user>/agent-cli-lib-py.git
97
+
98
+ # poetry
99
+ poetry add agent-cli-lib@git+https://gitee.com/<user>/agent-cli-lib-py.git
100
+ ```
101
+
102
+ ### 第二阶段:PyPI(稳定后)
103
+
104
+ ```bash
105
+ pip install agent-cli-lib
106
+ ```
107
+
108
+ ## 开发
109
+
110
+ 开发环境使用 conda(环境名 `agent-cli`),包管理使用 poetry,harness 使用 just。
111
+
112
+ ```bash
113
+ conda create -n agent-cli python=3.12 -y
114
+ conda run -n agent-cli pip install poetry
115
+ just install # 安装依赖
116
+ just check # lint + typecheck + test
117
+ ```
118
+
119
+ 常用命令(`just --list` 查看全部):
120
+
121
+ | 命令 | 说明 |
122
+ | --- | --- |
123
+ | `just install` | 安装/同步依赖 |
124
+ | `just fmt` | 格式化代码 |
125
+ | `just lint` | 静态检查 |
126
+ | `just typecheck` | ty 类型检查 |
127
+ | `just test` | 运行测试 |
128
+ | `just check` | 全量质量门禁 |
129
+ | `just build` | 构建 wheel/sdist |
130
+ | `just publish` | 发布到 PyPI |
131
+
132
+ 📖 后端能力 × 各 CLI 官方指令对照:[docs/dev/backend-commands.md](docs/dev/backend-commands.md)
133
+
@@ -0,0 +1,107 @@
1
+ # agent-cli-lib
2
+
3
+ 对 opencode、pi、hermes 等 agent CLI 基座统一封装的 Python 库。对支持
4
+ [ACP](https://agentclientprotocol.com)(Agent Client Protocol)的 CLI,以 **ACP 客户端**方式驱动
5
+ (协议化通道:流式、权限回调、优雅取消);ACP 覆盖不到的能力(会话导出归档等)与
6
+ 无 ACP 的 CLI,走子进程封装,对外一套接口。
7
+
8
+ ```python
9
+ from agent_cli_lib import AgentRunner
10
+
11
+ runner = AgentRunner(backend="opencode", workdir="/my/project")
12
+ result = runner.run("修复登录 bug")
13
+ print(result.session_id, result.output)
14
+ runner.resume(result.session_id) # 按 id 恢复会话
15
+ ```
16
+
17
+ `agent_cli_lib.api` 是公开签名门面层:完整签名 + Examples 使用提示,并内置废弃/移除注解。
18
+
19
+ ```python
20
+ from agent_cli_lib import run # 模块级快捷入口(来自 api 签名层)
21
+ from agent_cli_lib.api import deprecated, removed # 废弃/移除注解(deprecated 为 PEP 702)
22
+
23
+ result = run("修复登录 bug", backend="pi")
24
+ ```
25
+
26
+ 📖 接口速查文档:[docs/api.md](docs/api.md)
27
+
28
+ ## 支持的 Agent CLI 版本
29
+
30
+ 本库按实测版本适配(各 CLI 输出格式与导出行为随版本变化),版本基线统一维护在:
31
+ [docs/dev/provider-setup.md](docs/dev/provider-setup.md#版本基线)
32
+ (配套验证镜像 `docker/Dockerfile`(opencode v1)与 `docker/Dockerfile.v2`(opencode v2),
33
+ 均内置 pi/hermes/hermes `[acp]`)。
34
+
35
+ ## 功能
36
+
37
+ 1. 参数切换后端(opencode / pi / hermes)
38
+ 2. 错误异常自处理(类型化异常体系)
39
+ 3. prompt 支持文件路径与字符串
40
+ 4. session 会话文件导出
41
+ 5. 任务完成后返回 session id;支持用 session id 或 session 文件路径恢复会话
42
+ 6. 并发场景下可终止运行
43
+ 7. 启动 agent 时指定工作路径
44
+ 8. API 签名门面层(`agent_cli_lib.api`):公开签名 + 使用提示,内置 `deprecated` / `removed` 注解
45
+
46
+ ## 路线图
47
+
48
+ - **ACP 传输**:opencode v1/v2 已实测 run/resume/cancel 可用(v2 含权限往返;v1 权限往返
49
+ 协议同构、实现期补测),作为 ACP 客户端驱动;export 等协议空白项自动降级 CLI 子进程。
50
+ 架构与实测矩阵:[docs/dev/todo/acp-architecture-upgrade.md](docs/dev/todo/acp-architecture-upgrade.md)
51
+
52
+ ## 部署建议(高并发)
53
+
54
+ SDK 的并发机制已实测验证(多线程混合任务、取消、无进程残留)。agent CLI 的资源
55
+ 消耗属 CLI 侧行为(每个 ACP 在飞任务约 150MB,随并发线性增长),不归 SDK 管——
56
+ 高并发部署推荐把 agent 任务放进**沙箱(容器)**里运行,资源配额由沙箱统一管理,
57
+ SDK 与调用方无感。
58
+
59
+ ## 安装
60
+
61
+ 运行时依赖 [`agent-client-protocol`](https://github.com/agentclientprotocol/python-sdk)(官方 ACP SDK,
62
+ pip 安装本库时自动带入,含传递依赖 pydantic)。
63
+
64
+ ### 第一阶段:通过 Gitee Git 引用
65
+
66
+ ```bash
67
+ # pip
68
+ pip install git+https://gitee.com/<user>/agent-cli-lib-py.git
69
+
70
+ # uv
71
+ uv add agent-cli-lib@git+https://gitee.com/<user>/agent-cli-lib-py.git
72
+
73
+ # poetry
74
+ poetry add agent-cli-lib@git+https://gitee.com/<user>/agent-cli-lib-py.git
75
+ ```
76
+
77
+ ### 第二阶段:PyPI(稳定后)
78
+
79
+ ```bash
80
+ pip install agent-cli-lib
81
+ ```
82
+
83
+ ## 开发
84
+
85
+ 开发环境使用 conda(环境名 `agent-cli`),包管理使用 poetry,harness 使用 just。
86
+
87
+ ```bash
88
+ conda create -n agent-cli python=3.12 -y
89
+ conda run -n agent-cli pip install poetry
90
+ just install # 安装依赖
91
+ just check # lint + typecheck + test
92
+ ```
93
+
94
+ 常用命令(`just --list` 查看全部):
95
+
96
+ | 命令 | 说明 |
97
+ | --- | --- |
98
+ | `just install` | 安装/同步依赖 |
99
+ | `just fmt` | 格式化代码 |
100
+ | `just lint` | 静态检查 |
101
+ | `just typecheck` | ty 类型检查 |
102
+ | `just test` | 运行测试 |
103
+ | `just check` | 全量质量门禁 |
104
+ | `just build` | 构建 wheel/sdist |
105
+ | `just publish` | 发布到 PyPI |
106
+
107
+ 📖 后端能力 × 各 CLI 官方指令对照:[docs/dev/backend-commands.md](docs/dev/backend-commands.md)
@@ -0,0 +1,70 @@
1
+ [tool.poetry]
2
+ name = "agent-cli-lib"
3
+ version = "0.1.0"
4
+ description = "Unified Python interface for agent CLI bases (opencode, pi, hermes)"
5
+ authors = ["SongJuYi 1327898686@qq.com"]
6
+ license = "MIT"
7
+ readme = "README.md"
8
+ homepage = "https://gitee.com/mdsSJY/agent-cli-lib-py"
9
+ repository = "https://gitee.com/mdsSJY/agent-cli-lib-py"
10
+ keywords = ["agent", "cli", "opencode", "llm"]
11
+ classifiers = [
12
+ "Development Status :: 2 - Pre-Alpha",
13
+ "Intended Audience :: Developers",
14
+ "Programming Language :: Python :: 3",
15
+ "Programming Language :: Python :: 3.10",
16
+ "Programming Language :: Python :: 3.11",
17
+ "Programming Language :: Python :: 3.12",
18
+ "Topic :: Software Development :: Libraries :: Python Modules",
19
+ ]
20
+ packages = [{ include = "agent_cli_lib", from = "src" }]
21
+
22
+ [tool.poetry.dependencies]
23
+ python = ">=3.10,<3.15" # 上界对齐 ACP SDK(agent-client-protocol 0.9.x 要求 <3.15)
24
+ typing-extensions = ">=4.9" # deprecated 注解(PEP 702,3.13 起进标准库)
25
+ agent-client-protocol = ">=0.9.0,<0.10"
26
+
27
+ [tool.poetry.group.dev.dependencies]
28
+ pytest = "^8.3"
29
+ pytest-cov = "^6.0"
30
+ ruff = "^0.12"
31
+ ty = ">=0.0.92,<0.1"
32
+
33
+ [build-system]
34
+ requires = ["poetry-core>=1.9.0"]
35
+ build-backend = "poetry.core.masonry.api"
36
+
37
+ [tool.ruff]
38
+ line-length = 100
39
+ target-version = "py310"
40
+ src = ["src", "tests"]
41
+
42
+ [tool.ruff.lint]
43
+ select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]
44
+ # RUF001/002/003: 允许中文文档字符串中的全角标点
45
+ ignore = ["RUF001", "RUF002", "RUF003"]
46
+
47
+ [tool.ruff.lint.per-file-ignores]
48
+ "tests/**" = ["S101"]
49
+
50
+ [tool.ty.src]
51
+ include = ["src", "tests"]
52
+
53
+ [tool.ty.environment]
54
+ python-version = "3.10"
55
+
56
+ [tool.pytest.ini_options]
57
+ testpaths = ["tests"]
58
+ addopts = "-ra --strict-markers"
59
+ markers = [
60
+ "slow: long-running tests",
61
+ "integration: tests that require real agent CLI binaries",
62
+ ]
63
+
64
+ [tool.coverage.run]
65
+ source = ["agent_cli_lib"]
66
+ branch = true
67
+
68
+ [tool.coverage.report]
69
+ show_missing = true
70
+ skip_covered = true
@@ -0,0 +1,48 @@
1
+ """agent-cli-lib: agent CLI 基座 (opencode / pi / hermes) 的统一封装."""
2
+
3
+ from agent_cli_lib.api import (
4
+ AgentResult,
5
+ AgentRunner,
6
+ SessionInfo,
7
+ export_session,
8
+ load_session,
9
+ resolve_prompt,
10
+ resume,
11
+ run,
12
+ )
13
+ from agent_cli_lib.core.runner import get_backend
14
+ from agent_cli_lib.errors import (
15
+ AcpProtocolError,
16
+ AgentCliError,
17
+ BackendLaunchError,
18
+ BackendNotFoundError,
19
+ BackendRunError,
20
+ PromptError,
21
+ RemovedAPIError,
22
+ RunCancelledError,
23
+ SessionError,
24
+ )
25
+
26
+ __version__ = "0.1.0"
27
+
28
+ __all__ = [
29
+ "AcpProtocolError",
30
+ "AgentCliError",
31
+ "AgentResult",
32
+ "AgentRunner",
33
+ "BackendLaunchError",
34
+ "BackendNotFoundError",
35
+ "BackendRunError",
36
+ "PromptError",
37
+ "RemovedAPIError",
38
+ "RunCancelledError",
39
+ "SessionError",
40
+ "SessionInfo",
41
+ "__version__",
42
+ "export_session",
43
+ "get_backend",
44
+ "load_session",
45
+ "resolve_prompt",
46
+ "resume",
47
+ "run",
48
+ ]
@@ -0,0 +1,25 @@
1
+ """API 签名层(公开门面):全部公开方法的签名、docstring 使用提示、废弃/移除注解。
2
+
3
+ 约定:本层只聚合不实现——每个签名一行委托 core/backends,细节按职能归位到成员模块。
4
+ 标记用法:from agent_cli_lib.api import deprecated, removed
5
+ """
6
+
7
+ from __future__ import annotations
8
+
9
+ from agent_cli_lib.api.decorators import deprecated, removed
10
+ from agent_cli_lib.api.prompt import resolve_prompt
11
+ from agent_cli_lib.api.runner import AgentResult, AgentRunner, export_session, resume, run
12
+ from agent_cli_lib.api.session import SessionInfo, load_session
13
+
14
+ __all__ = [
15
+ "AgentResult",
16
+ "AgentRunner",
17
+ "SessionInfo",
18
+ "deprecated",
19
+ "export_session",
20
+ "load_session",
21
+ "removed",
22
+ "resolve_prompt",
23
+ "resume",
24
+ "run",
25
+ ]
@@ -0,0 +1,37 @@
1
+ """API 注解工具:废弃/移除标记(签名层的核心能力)。
2
+
3
+ - deprecated:typing_extensions 的 PEP 702 实现(Python 3.13 起进标准库 warnings.deprecated)。
4
+ 一个装饰器三合一:静态诊断(ty/pyright/pylance 报 Deprecated、IDE 划删除线)、
5
+ 运行时发 DeprecationWarning、消息本身承载迁移/用法提示。
6
+ - removed:签名保留但调用即抛 RemovedAPIError,hint 指向替代用法(彻底丢弃档)。
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ import functools
12
+ from collections.abc import Callable
13
+ from typing import NoReturn, TypeVar, cast
14
+
15
+ from typing_extensions import deprecated
16
+
17
+ from agent_cli_lib.errors import RemovedAPIError
18
+
19
+ __all__ = ["deprecated", "removed"]
20
+
21
+ F = TypeVar("F", bound=Callable[..., object])
22
+
23
+
24
+ def removed(hint: str) -> Callable[[F], F]:
25
+ """标记 API 已彻底移除:签名保留(静态可见),调用即抛 RemovedAPIError。
26
+
27
+ hint 写替代用法,例如:@removed("改用 run(prompt, model=...),见 docs/api.md")
28
+ """
29
+
30
+ def decorator(func: F) -> F:
31
+ @functools.wraps(func)
32
+ def wrapper(*args: object, **kwargs: object) -> NoReturn:
33
+ raise RemovedAPIError(getattr(func, "__qualname__", str(func)), hint)
34
+
35
+ return cast("F", wrapper)
36
+
37
+ return decorator
@@ -0,0 +1,10 @@
1
+ """prompt 门面(签名层):resolve_prompt 的公开出口。
2
+
3
+ 实现在 core.prompt(文件/字符串判别、大小上限等细节收纳在那里),本层只聚合。
4
+ """
5
+
6
+ from __future__ import annotations
7
+
8
+ from agent_cli_lib.core.prompt import resolve_prompt
9
+
10
+ __all__ = ["resolve_prompt"]