zcf 1.2.0 → 2.0.1
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.
- package/README.md +87 -20
- package/dist/cli.mjs +436 -10
- package/dist/index.d.mts +211 -10
- package/dist/index.d.ts +211 -10
- package/dist/index.mjs +2 -1
- package/dist/shared/zcf.DAPPHkhV.mjs +1661 -0
- package/package.json +2 -2
- package/templates/CLAUDE.md +4 -0
- package/templates/en/mcp.md +6 -0
- package/templates/en/personality.md +1 -0
- package/templates/en/{CLAUDE.md → rules.md} +1 -10
- package/templates/zh-CN/mcp.md +6 -0
- package/templates/zh-CN/personality.md +1 -0
- package/templates/zh-CN/{CLAUDE.md → rules.md} +6 -15
- package/dist/shared/zcf.D3MMT8L8.mjs +0 -988
package/README.md
CHANGED
|
@@ -2,30 +2,50 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://opensource.org/licenses/MIT)
|
|
4
4
|
[](https://claude.ai/code)
|
|
5
|
+
[](https://www.npmjs.com/package/zcf)
|
|
5
6
|
|
|
6
7
|
**中文** | [English](README_EN.md)
|
|
7
8
|
|
|
8
|
-
> 零配置,一键搞定 Claude Code 环境设置 -
|
|
9
|
+
> 零配置,一键搞定 Claude Code 环境设置 - 支持中英文双语配置、智能代理系统和个性化AI助手
|
|
9
10
|
|
|
10
11
|

|
|
11
12
|
|
|
12
13
|
## 🚀 快速开始
|
|
13
14
|
|
|
14
|
-
###
|
|
15
|
+
### 🎯 推荐:使用交互式菜单(v2.0新增)
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx zcf # 打开交互式菜单,根据你的需求选择操作
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
菜单选项包括:
|
|
22
|
+
- `1` 完整初始化(等同于 `zcf i`)
|
|
23
|
+
- `2` 导入工作流(等同于 `zcf u`)
|
|
24
|
+
- `3-6` 配置管理(API、MCP、模型、AI个性等)
|
|
25
|
+
- 更多功能选项...
|
|
26
|
+
|
|
27
|
+
### 或者,直接使用命令:
|
|
15
28
|
|
|
16
29
|
#### 🆕 首次使用 Claude Code
|
|
17
30
|
|
|
18
31
|
```bash
|
|
19
|
-
npx zcf
|
|
32
|
+
npx zcf i # 直接执行完整初始化:安装 Claude Code + 导入工作流 + 配置 API + 设置 MCP 服务
|
|
33
|
+
# 或
|
|
34
|
+
npx zcf → 选择 1 # 通过菜单执行完整初始化
|
|
20
35
|
```
|
|
21
36
|
|
|
22
37
|
#### 🔄 已有 Claude Code 环境
|
|
23
38
|
|
|
24
39
|
```bash
|
|
25
|
-
npx zcf u #
|
|
40
|
+
npx zcf u # 仅更新工作流:快速添加 AI 工作流和命令系统
|
|
41
|
+
# 或
|
|
42
|
+
npx zcf → 选择 2 # 通过菜单执行工作流更新
|
|
26
43
|
```
|
|
27
44
|
|
|
28
|
-
>
|
|
45
|
+
> **提示**:
|
|
46
|
+
> - v2.0 起,`zcf` 默认打开交互式菜单,提供可视化操作界面
|
|
47
|
+
> - 你可以通过菜单选择操作,也可以直接使用命令快捷执行
|
|
48
|
+
> - `zcf i` = 完整初始化,`zcf u` = 仅更新工作流
|
|
29
49
|
|
|
30
50
|
### 初始化流程
|
|
31
51
|
|
|
@@ -58,13 +78,15 @@ npx zcf u # 仅导入工作流:快速添加 AI 工作流和命令系统
|
|
|
58
78
|
- 脚本交互语言:控制安装过程的提示语言
|
|
59
79
|
- 配置文件语言:决定安装哪套配置文件(zh-CN/en)
|
|
60
80
|
- AI 输出语言:选择 AI 回复使用的语言(支持简体中文、English 及自定义语言)
|
|
81
|
+
- AI 个性化:支持多种预设人格(专业助手、猫娘助手、友好助手、导师模式)或自定义
|
|
61
82
|
|
|
62
83
|
### 🔧 智能安装
|
|
63
84
|
|
|
64
85
|
- 自动检测 Claude Code 安装状态
|
|
65
86
|
- 使用 npm 进行自动安装(确保兼容性)
|
|
66
87
|
- 跨平台支持(Windows/macOS/Linux)
|
|
67
|
-
- 自动配置 MCP
|
|
88
|
+
- 自动配置 MCP 服务
|
|
89
|
+
- 智能配置合并和部分修改支持(v2.0新增)
|
|
68
90
|
|
|
69
91
|
### 📦 完整配置
|
|
70
92
|
|
|
@@ -80,25 +102,51 @@ npx zcf u # 仅导入工作流:快速添加 AI 工作流和命令系统
|
|
|
80
102
|
- **API Key**:适用于从 Anthropic Console 获取的 API 密钥
|
|
81
103
|
- 自定义 API URL 支持
|
|
82
104
|
- 支持稍后在 claude 命令中配置
|
|
105
|
+
- 部分修改功能:仅更新需要的配置项(v2.0新增)
|
|
83
106
|
|
|
84
107
|
### 💾 配置管理
|
|
85
108
|
|
|
86
109
|
- 智能备份现有配置(所有备份保存在 ~/.claude/backup/)
|
|
87
|
-
-
|
|
110
|
+
- 配置合并选项(v2.0增强:支持深度合并)
|
|
88
111
|
- 安全的覆盖机制
|
|
89
112
|
- MCP 配置修改前自动备份
|
|
113
|
+
- 默认模型配置(v2.0新增)
|
|
114
|
+
- AI 记忆管理(v2.0新增)
|
|
115
|
+
- ZCF 缓存清理(v2.0新增)
|
|
90
116
|
|
|
91
117
|
## 📖 使用说明
|
|
92
118
|
|
|
93
|
-
###
|
|
119
|
+
### 交互式菜单(v2.0)
|
|
94
120
|
|
|
95
121
|
```bash
|
|
96
122
|
$ npx zcf
|
|
97
123
|
|
|
98
|
-
|
|
124
|
+
ZCF - Zero-Config Claude-Code Flow v2.0.0
|
|
125
|
+
|
|
126
|
+
? Select ZCF display language / 选择ZCF显示语言:
|
|
99
127
|
❯ 简体中文
|
|
100
128
|
English
|
|
101
129
|
|
|
130
|
+
请选择功能:
|
|
131
|
+
-------- Claude Code --------
|
|
132
|
+
1. 完整初始化配置 - 安装并配置所有内容
|
|
133
|
+
2. 导入工作流 - 更新 AI 工作流和命令
|
|
134
|
+
3. 配置 API - 管理 API 认证
|
|
135
|
+
4. 配置 MCP 服务 - 管理 MCP 集成
|
|
136
|
+
5. 配置默认模型 - 设置默认 AI 模型
|
|
137
|
+
6. 配置 AI 个性 - 设置 AI 助手人格
|
|
138
|
+
|
|
139
|
+
------------ ZCF ------------
|
|
140
|
+
0. 更改语言 - 切换界面语言
|
|
141
|
+
-. 清理缓存 - 清理 ZCF 缓存文件
|
|
142
|
+
q. 退出
|
|
143
|
+
|
|
144
|
+
请输入选择: _
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### 完整初始化流程(选择1或使用 `zcf i`)
|
|
148
|
+
|
|
149
|
+
```bash
|
|
102
150
|
? 选择 Claude Code 配置语言:
|
|
103
151
|
❯ 简体中文 (zh-CN) - 中文版(便于中文用户自定义)
|
|
104
152
|
English (en) - 英文版(推荐,token 消耗更低)
|
|
@@ -110,6 +158,13 @@ $ npx zcf
|
|
|
110
158
|
Custom
|
|
111
159
|
(支持日语、法语、德语等多种语言)
|
|
112
160
|
|
|
161
|
+
? 选择 AI 个性化设置:
|
|
162
|
+
❯ 专业助手(默认)
|
|
163
|
+
猫娘助手
|
|
164
|
+
友好助手
|
|
165
|
+
导师模式
|
|
166
|
+
自定义
|
|
167
|
+
|
|
113
168
|
? 检测到 Claude Code 未安装,是否自动安装?(Y/n)
|
|
114
169
|
|
|
115
170
|
✔ Claude Code 安装成功
|
|
@@ -154,10 +209,11 @@ $ npx zcf
|
|
|
154
209
|
|
|
155
210
|
#### 命令速查表
|
|
156
211
|
|
|
157
|
-
| 命令 | 缩写
|
|
158
|
-
| ------------ |
|
|
159
|
-
| `zcf` | -
|
|
160
|
-
| `zcf
|
|
212
|
+
| 命令 | 缩写 | 说明 |
|
|
213
|
+
| ------------ | --------- | --------------------------------------- |
|
|
214
|
+
| `zcf` | - | 显示交互式菜单(v2.0默认命令) |
|
|
215
|
+
| `zcf init` | `zcf i` | 初始化 Claude Code 配置 |
|
|
216
|
+
| `zcf update` | `zcf u` | 更新 Prompt 文档并备份旧配置 |
|
|
161
217
|
|
|
162
218
|
#### 常用选项
|
|
163
219
|
|
|
@@ -186,15 +242,20 @@ npx zcf -v
|
|
|
186
242
|
#### 使用示例
|
|
187
243
|
|
|
188
244
|
```bash
|
|
189
|
-
#
|
|
245
|
+
# 显示交互式菜单(默认)
|
|
190
246
|
npx zcf
|
|
191
247
|
|
|
248
|
+
# 首次安装,完整初始化
|
|
249
|
+
npx zcf i
|
|
250
|
+
npx zcf init # 完整命令
|
|
251
|
+
|
|
192
252
|
# 更新 Prompt 文档并备份旧配置,保留 API 和 MCP 配置
|
|
193
253
|
npx zcf u
|
|
254
|
+
npx zcf update # 完整命令
|
|
194
255
|
|
|
195
256
|
# 强制使用中文配置重新初始化
|
|
196
|
-
npx zcf --config-lang zh-CN --force
|
|
197
|
-
npx zcf -c zh-CN -f # 使用缩写
|
|
257
|
+
npx zcf i --config-lang zh-CN --force
|
|
258
|
+
npx zcf i -c zh-CN -f # 使用缩写
|
|
198
259
|
|
|
199
260
|
# 更新到英文版 Prompt(降低 token 消耗)
|
|
200
261
|
npx zcf u --config-lang en
|
|
@@ -215,9 +276,12 @@ claude-code-config/
|
|
|
215
276
|
│ ├── utils/ # 工具函数
|
|
216
277
|
│ └── constants.ts # 常量定义
|
|
217
278
|
├── templates/ # 配置模板
|
|
279
|
+
│ ├── CLAUDE.md # 项目级配置(v2.0新增)
|
|
218
280
|
│ ├── settings.json # 基础配置(含隐私保护环境变量)
|
|
219
281
|
│ ├── en/ # 英文版
|
|
220
|
-
│ │ ├──
|
|
282
|
+
│ │ ├── rules.md # 核心原则(原CLAUDE.md)
|
|
283
|
+
│ │ ├── personality.md # AI个性化(v2.0新增)
|
|
284
|
+
│ │ ├── mcp.md # MCP服务说明(v2.0新增)
|
|
221
285
|
│ │ ├── agents/ # AI 代理
|
|
222
286
|
│ │ └── commands/ # 命令定义
|
|
223
287
|
│ └── zh-CN/ # 中文版
|
|
@@ -225,12 +289,13 @@ claude-code-config/
|
|
|
225
289
|
└── dist/ # 构建输出
|
|
226
290
|
```
|
|
227
291
|
|
|
228
|
-
## ✨
|
|
292
|
+
## ✨ 核心特性(v2.0增强)
|
|
229
293
|
|
|
230
294
|
### 🤖 专业代理
|
|
231
295
|
|
|
232
296
|
- **任务规划师**:将复杂任务拆解为可执行步骤
|
|
233
297
|
- **UI/UX 设计师**:提供专业界面设计指导
|
|
298
|
+
- **AI 个性化**:支持多种预设人格和自定义(v2.0新增)
|
|
234
299
|
|
|
235
300
|
### ⚡ 命令系统
|
|
236
301
|
|
|
@@ -239,9 +304,11 @@ claude-code-config/
|
|
|
239
304
|
|
|
240
305
|
### 🔧 智能配置
|
|
241
306
|
|
|
242
|
-
- API
|
|
307
|
+
- API 密钥管理(支持部分修改)
|
|
243
308
|
- 细粒度权限控制
|
|
244
|
-
- 多种 Claude
|
|
309
|
+
- 多种 Claude 模型支持(可配置默认模型)
|
|
310
|
+
- 交互式菜单系统(v2.0新增)
|
|
311
|
+
- AI 记忆管理(v2.0新增)
|
|
245
312
|
|
|
246
313
|
## 🎯 开发工作流
|
|
247
314
|
|