zcf 2.7.1 → 2.8.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 CHANGED
@@ -24,7 +24,9 @@ Menu options include:
24
24
 
25
25
  - `1` Full initialization (equivalent to `zcf i`)
26
26
  - `2` Import workflows (equivalent to `zcf u`)
27
- - `3-6` Configuration management (API, MCP, Model, AI personality, etc.)
27
+ - `3-7` Configuration management (API/CCR, MCP, Model settings, AI personality, etc.)
28
+ - `R` Claude Code Router management (enhanced in v2.8.1)
29
+ - `U` ccusage - Claude Code usage analysis
28
30
  - More features...
29
31
 
30
32
  ### Or, use direct commands:
@@ -45,9 +47,15 @@ npx zcf u # Update workflows only: Quick add AI workflows and command sys
45
47
  npx zcf → select 2 # Execute workflow update via menu
46
48
  ```
47
49
 
48
- #### 🎯 BMad Workflow (New Feature)
50
+ > **Note**:
51
+ >
52
+ > - Since v2.0, `zcf` opens the interactive menu by default, providing a visual operation interface
53
+ > - You can choose operations through the menu or use commands directly for quick execution
54
+ > - `zcf i` = full initialization, `zcf u` = update workflows only
55
+
56
+ #### 🎯 BMad Workflow (v2.7 New Feature)
49
57
 
50
- BMad (Business-Minded Agile Development) is an enterprise-grade workflow system that provides:
58
+ [BMad](https://github.com/bmad-code-org/BMAD-METHOD) (BMad-Method: Universal AI Agent Framework) is an enterprise-grade workflow system that provides:
51
59
 
52
60
  - Complete team of specialized AI agents (PO, PM, Architect, Dev, QA, etc.)
53
61
  - Structured development process with quality gates
@@ -56,11 +64,38 @@ BMad (Business-Minded Agile Development) is an enterprise-grade workflow system
56
64
 
57
65
  After installation, use `/bmad-init` to initialize the BMad workflow in your project.
58
66
 
59
- > **Note**:
60
- >
61
- > - Since v2.0, `zcf` opens the interactive menu by default, providing a visual operation interface
62
- > - You can choose operations through the menu or use commands directly for quick execution
63
- > - `zcf i` = full initialization, `zcf u` = update workflows only
67
+ #### 🚀 CCR (Claude Code Router) Support (v2.8+ Enhanced)
68
+
69
+ [CCR](https://github.com/musistudio/claude-code-router/blob/main/README.md) is a powerful proxy router that enables:
70
+
71
+ - **Free Model Access**: Use free AI models (like Gemini, DeepSeek) through Claude Code interface
72
+ - **Custom Routing**: Route different types of requests to different models based on your rules
73
+ - **Cost Optimization**: Significantly reduce API costs by using appropriate models for different tasks
74
+ - **Easy Management**: Interactive menu for CCR configuration and service control
75
+ - **Auto Updates**: Automatic version checking and updates for CCR and Claude Code (v2.8.1+)
76
+
77
+ To access CCR features:
78
+
79
+ ```bash
80
+ npx zcf ccr # Open CCR management menu
81
+ # or
82
+ npx zcf → select R
83
+ ```
84
+
85
+ Check for updates (v2.8.1+):
86
+
87
+ ```bash
88
+ npx zcf check-updates # Check and update Claude Code and CCR to latest versions
89
+ ```
90
+
91
+ CCR menu options:
92
+
93
+ - Initialize CCR - Install and configure CCR with preset providers
94
+ - Start UI - Launch CCR web interface for advanced configuration
95
+ - Service Control - Start/stop/restart CCR service
96
+ - Check Status - View current CCR service status
97
+
98
+ After CCR setup, ZCF automatically configures Claude Code to use CCR as the API proxy.
64
99
 
65
100
  ### Setup Process
66
101
 
@@ -68,7 +103,7 @@ Full initialization (`npx zcf`) will automatically:
68
103
 
69
104
  - ✅ Detect and install Claude Code
70
105
  - ✅ Select AI output language (new feature)
71
- - ✅ Configure API keys
106
+ - ✅ Configure API keys or CCR proxy
72
107
  - ✅ Select and configure MCP services
73
108
  - ✅ Set up all necessary configuration files
74
109
 
@@ -138,7 +173,7 @@ After configuration:
138
173
  ```bash
139
174
  $ npx zcf
140
175
 
141
- ZCF - Zero-Config Claude-Code Flow v2.3.0
176
+ ZCF - Zero-Config Claude-Code Flow
142
177
 
143
178
  ? Select ZCF display language / 选择ZCF显示语言:
144
179
  ❯ 简体中文
@@ -146,18 +181,22 @@ $ npx zcf
146
181
 
147
182
  Select function:
148
183
  -------- Claude Code --------
149
- 1. Full initialization - Install Claude Code + Import workflow + Configure API + Configure MCP services
184
+ 1. Full initialization - Install Claude Code + Import workflow + Configure API or CCR proxy + Configure MCP services
150
185
  2. Import workflow - Import/update workflow-related files only
151
- 3. Configure API - Configure API URL and authentication
186
+ 3. Configure API - Configure API URL and authentication (supports CCR proxy)
152
187
  4. Configure MCP - Configure MCP services (includes Windows fix)
153
188
  5. Configure default model - Set default model (opus/sonnet)
154
189
  6. Configure Claude global memory - Configure AI output language and personality
155
190
  7. Import recommended environment variables and permissions - Import privacy protection environment variables and system permissions
156
191
 
192
+ --------- Other Tools ----------
193
+ R. CCR Management - Claude Code Router management
194
+ U. CCUsage - Claude Code usage analysis tool
195
+
157
196
  ------------ ZCF ------------
158
197
  0. Select display language / 更改显示语言 - Change ZCF interface language
159
198
  -. Clear preference cache - Clear preference language and other caches
160
- q. Exit
199
+ Q. Exit
161
200
 
162
201
  Enter your choice: _
163
202
  ```
@@ -192,6 +231,8 @@ Enter your choice: _
192
231
  For tokens obtained via OAuth or browser login
193
232
  Use API Key (Key authentication)
194
233
  For API keys from Anthropic Console
234
+ Configure CCR Proxy (Claude Code Router)
235
+ Use free models and custom routing to reduce costs and explore the possibilities of Claude Code
195
236
  Skip (configure manually later)
196
237
 
197
238
  ? Enter API URL: https://api.anthropic.com
@@ -241,12 +282,13 @@ Enter your choice: _
241
282
 
242
283
  #### Commands Quick Reference
243
284
 
244
- | Command | Alias | Description |
245
- | ------------ | ------- | -------------------------------------------- |
246
- | `zcf` | - | Show interactive menu (v2.0 default command) |
247
- | `zcf init` | `zcf i` | Initialize Claude Code configuration |
248
- | `zcf update` | `zcf u` | Update workflow-related md files with backup |
249
- | `zcf ccu` | - | Run Claude Code usage analysis tool |
285
+ | Command | Alias | Description |
286
+ | ------------ | ------- | ------------------------------------------------------------------------------------- |
287
+ | `zcf` | - | Show interactive menu (v2.0 default command) |
288
+ | `zcf init` | `zcf i` | Initialize Claude Code configuration |
289
+ | `zcf update` | `zcf u` | Update workflow-related md files with backup |
290
+ | `zcf ccu` | - | Run Claude Code usage analysis tool - [ccusage](https://github.com/ryoppippi/ccusage) |
291
+ | `zcf ccr` | - | Open CCR (Claude Code Router) management menu |
250
292
 
251
293
  #### Common Options
252
294
 
@@ -438,14 +480,28 @@ To protect user data security, the following operations require explicit confirm
438
480
 
439
481
  ## 🙏 Acknowledgments
440
482
 
441
- Some prompts in this project are inspired by the following excellent works:
483
+ This project is inspired by and incorporates the following open source projects:
442
484
 
443
- - [Linux.do - Share a universal Prompt for AI to generate only necessary code, welcome to optimize together~](https://linux.do/t/topic/830802)
444
- - [Linux.do - Don't worry about claude code degradation, using agent and command combination to break down tasks in detail may help you](https://linux.do/t/topic/815230)
445
- - [Linux.do - cursor rapid development rules](https://linux.do/t/topic/697566)
485
+ - [LINUX DO - The New Ideal Community](https://linux.do)
486
+ - [CCR](https://github.com/musistudio/claude-code-router)
487
+ - [ccusage](https://github.com/ryoppippi/ccusage)
488
+ - [BMad Method](https://github.com/bmad-code-org/BMAD-METHOD)
446
489
 
447
490
  Thanks to these community contributors for sharing!
448
491
 
492
+ ## ❤️ Support & Sponsorship
493
+
494
+ If you find this project helpful, please consider sponsoring its development. Your support is greatly appreciated!
495
+
496
+ [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/UfoMiao)
497
+
498
+ <table>
499
+ <tr>
500
+ <td><img src="/src/assets/alipay.webp" width="200" alt="Alipay" /></td>
501
+ <td><img src="/src/assets/wechat.webp" width="200" alt="WeChat Pay" /></td>
502
+ </tr>
503
+ </table>
504
+
449
505
  ## 📄 License
450
506
 
451
507
  MIT License
package/bin/zcf.mjs CHANGED
@@ -1,2 +1,2 @@
1
1
  #!/usr/bin/env node
2
- import '../dist/cli.mjs'
2
+ import '../dist/cli.mjs';