@unitsvc/cc-helper 1.0.14 → 1.0.16

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 (5) hide show
  1. package/LICENSE +661 -661
  2. package/README-zh.md +231 -155
  3. package/README.md +243 -155
  4. package/dist/cli.js +0 -0
  5. package/package.json +45 -47
package/README-zh.md CHANGED
@@ -1,155 +1,231 @@
1
- # cc-helper
2
-
3
- [![npm version](https://img.shields.io/npm/v/@unitsvc/cc-helper.svg)](https://www.npmjs.com/package/@unitsvc/cc-helper)
4
- [![License](https://img.shields.io/badge/License-AGPL%203.0-blue.svg)](https://github.com/next-bin/cc-helper/blob/master/LICENSE)
5
- [![Node](https://img.shields.io/badge/Node-%3E%3D14.0.0-green.svg)](https://nodejs.org)
6
-
7
- [**English**](./README.md) | **简体中文**
8
-
9
- > ⚡ 一键启用 Claude Code CLI 的 `/loop` 功能
10
-
11
- ## 环境要求
12
-
13
- - Node.js >= 14.0.0
14
- - Claude Code v2.1.71+
15
-
16
- ```bash
17
- npm install -g @anthropic-ai/claude-code@v2.1.71
18
- ```
19
-
20
- ## 使用方法
21
-
22
- ```bash
23
- # 启用 /loop 功能
24
- npx @unitsvc/cc-helper enable
25
-
26
- # 查看状态
27
- npx @unitsvc/cc-helper status
28
-
29
- # 禁用 /loop 功能（恢复原状）
30
- npx @unitsvc/cc-helper disable
31
- ```
32
-
33
- ### 代理支持
34
-
35
- 如果下载失败，使用 `--proxy` 参数：
36
-
37
- ```bash
38
- # 使用默认代理 (https://edgeone.gh-proxy.org)
39
- npx @unitsvc/cc-helper --proxy enable
40
-
41
- # 使用自定义代理
42
- npx @unitsvc/cc-helper --proxy https://your-proxy.com enable
43
- ```
44
-
45
- ### 命令说明
46
-
47
- | 命令 | 说明 |
48
- | --------- | ----------------- |
49
- | `enable` | 启用 `/loop` 功能 |
50
- | `disable` | 恢复原始状态 |
51
- | `status` | 查看当前状态 |
52
-
53
- ## 赞助
54
-
55
- <table>
56
- <tr>
57
- <td width="60" valign="middle">
58
- <img src="https://img.shields.io/badge/🚀-GLM-blue?style=for-the-badge" alt="GLM"/>
59
- </td>
60
- <td valign="middle">
61
- <b>GLM Coding Plan</b><br/>
62
- <sub>Full support for <b>Claude Code</b>, <b>Cline</b>, and <b>20+ top coding tools</b> — starting at just <b>$10/month</b></sub><br/>
63
- <a href="https://z.ai/subscribe?ic=1YVKN4IRCQ"><b>👉 Subscribe now — limited-time deal!</b></a>
64
- </td>
65
- </tr>
66
- </table>
67
-
68
- ---
69
-
70
- ## 什么是 `/loop`？
71
-
72
- `/loop` 是 Claude Code CLI 的内置命令，用于创建定时重复提示。适用于：
73
-
74
- - 轮询部署或构建状态
75
- - 监控 PR 状态
76
- - 设置提醒
77
- - 定时执行工作流
78
-
79
- ### 使用语法
80
-
81
- ```
82
- /loop [间隔时间] <提示内容>
83
- ```
84
-
85
- **示例：**
86
-
87
- ```
88
- /loop 5m check if the deployment finished
89
- /loop 30m /review-pr 1234
90
- /loop remind me to push the release at 3pm
91
- ```
92
-
93
- ### 间隔时间格式
94
-
95
- | 形式 | 示例 | 解析间隔 |
96
- | ---------- | --------------------------- | -------------- |
97
- | 前置时间 | `/loop 30m check` | 每 30 分钟 |
98
- | 后置 every | `/loop check every 2 hours` | 每 2 小时 |
99
- | 无间隔 | `/loop check` | 默认每 10 分钟 |
100
-
101
- 支持单位：`s`（秒）、`m`（分）、`h`（时）、`d`（天）
102
-
103
- ### 核心特性
104
-
105
- - **会话级别**：任务仅在当前 Claude Code 会话中存在，退出即消失
106
- - **自动过期**：重复任务 3 天后自动过期
107
- - **抖动保护**：添加小偏移量防止 API 惊群效应
108
- - **低优先级**：定时提示在你与 Claude 交互间隙触发
109
-
110
- ### 管理任务
111
-
112
- ```
113
- what scheduled tasks do I have? # 列出所有任务
114
- cancel the deploy check job # 按描述或 ID 取消
115
- ```
116
-
117
- ## 功能特点
118
-
119
- - 一键启用 `/loop` 功能
120
- - 轻松恢复原始状态
121
- - 自动备份原文件
122
- - 零运行时依赖
123
- - 跨平台支持
124
-
125
- ### 示例
126
-
127
- 启用后，在 Claude Code 中使用 `/loop` 命令：
128
-
129
- ![/loop 命令提示](./docs/images/loop-1.png)
130
-
131
- 执行 loop 命令示例：
132
-
133
- ![/loop 执行示例](./docs/images/loop-2.png)
134
-
135
- ## 支持平台
136
-
137
- - macOS (amd64, arm64)
138
- - Linux (amd64, arm64)
139
- - Windows (amd64, arm64)
140
-
141
- ## 许可证
142
-
143
- AGPL-3.0 - 详见 [LICENSE](./LICENSE)
144
-
145
- ## 安全
146
-
147
- ### 报告漏洞
148
-
149
- 如果您发现 cc-helper 的安全漏洞，请负责任地报告：
150
-
151
- 1. **不要**公开提 issue
152
- 2. 发送邮件给维护者说明详情
153
- 3. 给予合理时间修复后再公开
154
-
155
- 我们非常重视安全问题，会尽快响应。
1
+ # cc-helper
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@unitsvc/cc-helper.svg)](https://www.npmjs.com/package/@unitsvc/cc-helper)
4
+ [![License](https://img.shields.io/badge/License-AGPL%203.0-blue.svg)](https://github.com/next-bin/cc-helper/blob/master/LICENSE)
5
+ [![Node](https://img.shields.io/badge/Node-%3E%3D14.0.0-green.svg)](https://nodejs.org)
6
+
7
+ [**English**](./README.md) | **简体中文**
8
+
9
+ > ⚡ 一键启用 Claude Code CLI 的隐藏功能：`/loop`、`/btw` 和 `MCPSearch`
10
+
11
+ ## 环境要求
12
+
13
+ - Node.js >= 14.0.0
14
+ - Claude Code v2.1.71+
15
+
16
+ ```bash
17
+ npm install -g @anthropic-ai/claude-code@v2.1.71
18
+ ```
19
+
20
+ ## 使用方法
21
+
22
+ ```bash
23
+ # 启用默认功能（/loop, /btw）
24
+ npx @unitsvc/cc-helper enable
25
+
26
+ # 启用特定功能
27
+ npx @unitsvc/cc-helper enable loop
28
+ npx @unitsvc/cc-helper enable btw
29
+ npx @unitsvc/cc-helper enable toolsearch
30
+
31
+ # 查看状态
32
+ npx @unitsvc/cc-helper status
33
+
34
+ # 禁用功能（恢复原状）
35
+ npx @unitsvc/cc-helper disable
36
+ ```
37
+
38
+ ### 命令说明
39
+
40
+ | 命令 | 说明 |
41
+ |---------|-------------|
42
+ | `enable` | 启用 `/loop` 和 `/btw` 功能（默认，不包含 toolsearch） |
43
+ | `enable loop` | 仅启用 `/loop` 功能 |
44
+ | `enable btw` | 仅启用 `/btw` 功能 |
45
+ | `enable toolsearch` | 启用 toolsearch 功能（需要显式激活） |
46
+ | `disable` | 恢复原始状态 |
47
+ | `status` | 查看当前状态及版本要求 |
48
+
49
+ ## 赞助
50
+
51
+ <table>
52
+ <tr>
53
+ <td width="60" valign="middle">
54
+ <img src="https://img.shields.io/badge/🚀-GLM-blue?style=for-the-badge" alt="GLM"/>
55
+ </td>
56
+ <td valign="middle">
57
+ <b>GLM Coding Plan</b><br/>
58
+ <sub>Full support for <b>Claude Code</b>, <b>Cline</b>, and <b>20+ top coding tools</b> — starting at just <b>$10/month</b></sub><br/>
59
+ <a href="https://z.ai/subscribe?ic=1YVKN4IRCQ"><b>👉 Subscribe now — limited-time deal!</b></a>
60
+ </td>
61
+ </tr>
62
+ </table>
63
+
64
+ ---
65
+
66
+ ## 什么是 `/loop`？
67
+
68
+ `/loop` 是 Claude Code CLI 的内置命令，用于创建定时重复提示。适用于：
69
+
70
+ - 轮询部署或构建状态
71
+ - 监控 PR 状态
72
+ - 设置提醒
73
+ - 定时执行工作流
74
+
75
+ ### 使用语法
76
+
77
+ ```
78
+ /loop [间隔时间] <提示内容>
79
+ ```
80
+
81
+ **示例：**
82
+
83
+ ```
84
+ /loop 5m check if the deployment finished
85
+ /loop 30m /review-pr 1234
86
+ /loop remind me to push the release at 3pm
87
+ ```
88
+
89
+ ### 间隔时间格式
90
+
91
+ | 形式 | 示例 | 解析间隔 |
92
+ | ---------- | --------------------------- | -------------- |
93
+ | 前置时间 | `/loop 30m check` | 每 30 分钟 |
94
+ | 后置 every | `/loop check every 2 hours` | 每 2 小时 |
95
+ | 无间隔 | `/loop check` | 默认每 10 分钟 |
96
+
97
+ 支持单位：`s`（秒）、`m`（分）、`h`（时）、`d`（天）
98
+
99
+ ### 核心特性
100
+
101
+ - **会话级别**：任务仅在当前 Claude Code 会话中存在，退出即消失
102
+ - **自动过期**：重复任务 3 天后自动过期
103
+ - **抖动保护**：添加小偏移量防止 API 惊群效应
104
+ - **低优先级**：定时提示在你与 Claude 交互间隙触发
105
+
106
+ ### 管理任务
107
+
108
+ ```
109
+ what scheduled tasks do I have? # 列出所有任务
110
+ cancel the deploy check job # 按描述或 ID 取消
111
+ ```
112
+
113
+ ## 什么是 `/btw`？
114
+
115
+ `/btw`（by the way）是一个隐藏命令，用于在不打断主对话流程的情况下提问旁支问题。适合快速澄清疑问。
116
+
117
+ ### 使用方法
118
+
119
+ ```
120
+ /btw <问题>
121
+ ```
122
+
123
+ **示例：**
124
+
125
+ ```
126
+ /btw 这个函数是做什么的？
127
+ /btw 解释一下这里的错误处理
128
+ /btw 为什么这里要用 async/await？
129
+ ```
130
+
131
+ ## 什么是工具搜索？
132
+
133
+ 工具搜索（Tool Search）是一项允许 Claude 在运行时动态搜索和加载工具的功能，而不是一次性发送所有工具定义。这可以节省 token 并提高性能。
134
+
135
+ ### 为什么为第三方 API 启用？
136
+
137
+ 默认情况下，Claude Code 在使用第三方 API 代理（如 Kimi、自定义端点）时会禁用工具搜索。此功能修改该行为，为这些代理启用工具搜索。
138
+
139
+ ### 优势
140
+
141
+ - **Token 效率**：减少大型 MCP 工具目录的上下文窗口占用
142
+ - **性能提升**：延迟加载工具，响应更快
143
+ - **代理兼容**：支持 Kimi 和其他第三方 Claude API 提供商
144
+
145
+ ### 要求
146
+
147
+ - 您的代理必须支持 API 响应中的 `tool_reference` 块
148
+ - 仅支持 Claude Sonnet 4+ 和 Opus 4+ 模型（不支持 Haiku）
149
+
150
+ ### 配置说明
151
+
152
+ 使用官方 Anthropic API 时，工具搜索默认启用。但当 `ANTHROPIC_BASE_URL` 指向非第一方主机时，工具搜索默认禁用（大多数代理不转发 `tool_reference` 块）。
153
+
154
+ 通过 `ENABLE_TOOL_SEARCH` 环境变量控制工具搜索行为：
155
+
156
+ | 值 | 行为 |
157
+ | ---------- | ------------------------------------------------------ |
158
+ | （未设置） | 默认启用。当 `ANTHROPIC_BASE_URL` 为非第一方主机时禁用 |
159
+ | `true` | 始终启用，包括非第一方 `ANTHROPIC_BASE_URL` |
160
+ | `auto` | 当 MCP 工具超过上下文 10% 时激活 |
161
+ | `auto:<N>` | 自定义阈值激活（如 `auto:5` 表示 5%） |
162
+ | `false` | 禁用，所有 MCP 工具预先加载 |
163
+
164
+ **示例：**
165
+
166
+ ```bash
167
+ # 使用 5% 自定义阈值
168
+ ENABLE_TOOL_SEARCH=auto:5 claude
169
+
170
+ # 完全禁用工具搜索
171
+ ENABLE_TOOL_SEARCH=false claude
172
+
173
+ # 始终启用（适用于支持 tool_reference 的代理）
174
+ ENABLE_TOOL_SEARCH=true claude
175
+ ```
176
+
177
+ 或在 `settings.json` 的 env 字段中设置。
178
+
179
+ #### 禁用 MCPSearch 工具
180
+
181
+ 您还可以使用 `disallowedTools` 设置专门禁用 `MCPSearch` 工具：
182
+
183
+ ```json
184
+ {
185
+ "permissions": {
186
+ "deny": ["MCPSearch"]
187
+ }
188
+ }
189
+ ```
190
+
191
+ ## 功能特点
192
+
193
+ - 一键启用 `/loop`、`/btw` 功能（toolsearch 需要显式激活）
194
+ - 可单独启用特定功能
195
+ - 轻松恢复原始状态
196
+ - 自动备份原文件
197
+ - 零运行时依赖
198
+ - 跨平台支持
199
+ - 支持版本：2.1.71、2.1.72、2.1.73、2.1.74
200
+
201
+ ### 示例
202
+
203
+ 启用后，在 Claude Code 中使用 `/loop` 命令：
204
+
205
+ ![/loop 命令提示](./docs/images/loop-1.png)
206
+
207
+ 执行 loop 命令示例：
208
+
209
+ ![/loop 执行示例](./docs/images/loop-2.png)
210
+
211
+ ## 支持平台
212
+
213
+ - macOS (amd64, arm64)
214
+ - Linux (amd64, arm64)
215
+ - Windows (amd64, arm64)
216
+
217
+ ## 许可证
218
+
219
+ AGPL-3.0 - 详见 [LICENSE](./LICENSE)
220
+
221
+ ## 安全
222
+
223
+ ### 报告漏洞
224
+
225
+ 如果您发现 cc-helper 的安全漏洞，请负责任地报告：
226
+
227
+ 1. **不要**公开提 issue
228
+ 2. 发送邮件给维护者说明详情
229
+ 3. 给予合理时间修复后再公开
230
+
231
+ 我们非常重视安全问题，会尽快响应。