zcf 2.11.0 → 2.12.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 +104 -53
- package/dist/chunks/simple-config.mjs +419 -252
- package/dist/cli.mjs +15 -11
- package/dist/index.d.mts +3 -2
- package/dist/index.d.ts +3 -2
- package/dist/index.mjs +2 -2
- package/package.json +1 -1
- package/templates/en/output-styles/engineer-professional.md +130 -0
- package/templates/en/output-styles/laowang-engineer.md +62 -0
- package/templates/en/output-styles/nekomata-engineer.md +165 -0
- package/templates/en/workflow/git/commands/git-worktree.md +51 -0
- package/templates/zh-CN/output-styles/engineer-professional.md +130 -0
- package/templates/zh-CN/output-styles/laowang-engineer.md +62 -0
- package/templates/zh-CN/output-styles/nekomata-engineer.md +165 -0
- package/templates/zh-CN/workflow/git/commands/git-worktree.md +51 -0
- package/templates/common/CLAUDE.md +0 -5
- package/templates/en/memory/mcp.md +0 -25
- package/templates/en/memory/personality.md +0 -1
- package/templates/en/memory/rules.md +0 -42
- package/templates/en/memory/technical-guides.md +0 -126
- package/templates/zh-CN/memory/mcp.md +0 -25
- package/templates/zh-CN/memory/personality.md +0 -1
- package/templates/zh-CN/memory/rules.md +0 -42
- package/templates/zh-CN/memory/technical-guides.md +0 -126
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ 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-7` Configuration management (API/CCR, MCP, Model settings, AI
|
|
27
|
+
- `3-7` Configuration management (API/CCR, MCP, Model settings, AI output style, environment permissions, etc.)
|
|
28
28
|
- `R` Claude Code Router management (enhanced in v2.8.1)
|
|
29
29
|
- `U` ccusage - Claude Code usage analysis
|
|
30
30
|
- `L` CCometixLine - High-performance statusline tool with Git integration and real-time usage tracking (v2.9.9+ new)
|
|
@@ -71,21 +71,50 @@ npx zcf i --skip-prompt --all-lang zh-CN --api-type api_key --api-key "sk-xxx" -
|
|
|
71
71
|
|
|
72
72
|
When using `--skip-prompt`, the following parameters are available:
|
|
73
73
|
|
|
74
|
-
| Parameter | Description
|
|
75
|
-
| ---------------------------- |
|
|
76
|
-
| `--skip-prompt, -s` | Skip all interactive prompts
|
|
77
|
-
| `--lang, -l` | ZCF display language
|
|
78
|
-
| `--config-lang, -c` | Configuration language
|
|
79
|
-
| `--ai-output-lang, -a` | AI output language
|
|
80
|
-
| `--all-lang, -g` | Set all language parameters to this value
|
|
81
|
-
| `--config-action, -
|
|
82
|
-
| `--api-type, -t` | API configuration type
|
|
83
|
-
| `--api-key, -k` | API key (for both API key and auth token types)
|
|
84
|
-
| `--api-url, -u` | Custom API URL
|
|
85
|
-
| `--mcp-services, -m` | MCP services to install (multi-select, comma-separated)
|
|
86
|
-
| `--workflows, -w` | Workflows to install (multi-select, comma-separated)
|
|
87
|
-
| `--
|
|
88
|
-
| `--
|
|
74
|
+
| Parameter | Description | Values | Required | Default |
|
|
75
|
+
| ---------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
76
|
+
| `--skip-prompt, -s` | Skip all interactive prompts | - | Yes (for non-interactive mode) | - |
|
|
77
|
+
| `--lang, -l` | ZCF display language | `zh-CN`, `en` | No | `en` |
|
|
78
|
+
| `--config-lang, -c` | Configuration language | `zh-CN`, `en` | No | `en` |
|
|
79
|
+
| `--ai-output-lang, -a` | AI output language | `zh-CN`, `en`, custom string | No | `en` |
|
|
80
|
+
| `--all-lang, -g` | Set all language parameters to this value | `zh-CN`, `en`, custom string | No | - (overrides above 3 params. Custom string sets AI output language to custom while interaction and config languages remain 'en') |
|
|
81
|
+
| `--config-action, -r` | Config handling | `new`, `backup`, `merge`, `docs-only`, `skip` | No | `backup` |
|
|
82
|
+
| `--api-type, -t` | API configuration type | `auth_token`, `api_key`, `ccr_proxy`, `skip` | No | `skip` |
|
|
83
|
+
| `--api-key, -k` | API key (for both API key and auth token types) | string | Required when `api-type` is not `skip` | - |
|
|
84
|
+
| `--api-url, -u` | Custom API URL | URL string | No | official API |
|
|
85
|
+
| `--mcp-services, -m` | MCP services to install (multi-select, comma-separated) | `context7`, `mcp-deepwiki`, `Playwright`, `exa`, or `skip` for none | No | `all` |
|
|
86
|
+
| `--workflows, -w` | Workflows to install (multi-select, comma-separated) | `commonTools`, `sixStepsWorkflow`, `featPlanUx`, `gitWorkflow`, `bmadWorkflow`, or `skip` for none | No | `all` |
|
|
87
|
+
| `--output-styles, -o` | Output styles to install (multi-select, comma-separated) | `engineer-professional`, `nekomata-engineer`, `laowang-engineer`, or `skip` for none | No | `all` |
|
|
88
|
+
| `--default-output-style, -d` | Default output style | Same as output styles plus built-in: `default`, `explanatory`, `learning` | No | `engineer-professional` |
|
|
89
|
+
| `--install-cometix-line, -x` | Install CCometixLine statusline tool | `true`, `false` | No | `true` |
|
|
90
|
+
|
|
91
|
+
#### 🎨 AI Output Styles (v2.12+ New Feature)
|
|
92
|
+
|
|
93
|
+
ZCF now supports customizable AI output styles to personalize your Claude Code experience:
|
|
94
|
+
|
|
95
|
+
**Available Output Styles:**
|
|
96
|
+
|
|
97
|
+
- `engineer-professional`: Professional software engineer following SOLID, KISS, DRY, YAGNI principles
|
|
98
|
+
- `nekomata-engineer`: Professional catgirl engineer Nova, combining rigorous engineering with cute catgirl traits
|
|
99
|
+
- `laowang-engineer`: Laowang grumpy tech style, never tolerates code errors and non-standard code
|
|
100
|
+
- Built-in styles: `default`, `explanatory`, `learning` (always available)
|
|
101
|
+
|
|
102
|
+
**Features:**
|
|
103
|
+
|
|
104
|
+
- Install multiple styles and switch between them
|
|
105
|
+
- Set global default style for all projects
|
|
106
|
+
- Automatic cleanup of legacy personality files
|
|
107
|
+
- Template-based customization system
|
|
108
|
+
|
|
109
|
+
**Usage Tips:**
|
|
110
|
+
|
|
111
|
+
- Use `/output-style` command to switch project-level output styles anytime
|
|
112
|
+
- Or modify global output styles in ZCF menu option 6
|
|
113
|
+
|
|
114
|
+
**Important:**
|
|
115
|
+
|
|
116
|
+
- Claude Code version must be greater than 1.0.81 to support output-style. Use `npx zcf check` to update.
|
|
117
|
+
- Legacy global memory rules have been migrated to the `engineer-professional` output style, solving issues with excessive token usage and AI forgetting global memory.
|
|
89
118
|
|
|
90
119
|
#### 🎯 BMad Workflow (v2.7 New Feature)
|
|
91
120
|
|
|
@@ -168,7 +197,7 @@ Full initialization (`npx zcf`) will automatically:
|
|
|
168
197
|
|
|
169
198
|
After configuration:
|
|
170
199
|
|
|
171
|
-
- **For first-time project use, strongly recommend running `/init` to generate CLAUDE.md for better AI understanding of project architecture**
|
|
200
|
+
- **For first-time project use, strongly recommend running `/init-project` to generate CLAUDE.md for better AI understanding of project architecture**
|
|
172
201
|
- `<task description>` - Execute directly without workflow, following SOLID, KISS, DRY, and YAGNI principles, suitable for small tasks like bug fixes
|
|
173
202
|
- `/feat <task description>` - Start new feature development, divided into plan and UI phases
|
|
174
203
|
- `/workflow <task description>` - Execute complete development workflow, not automated, starts with multiple solution options, asks for user feedback at each step, allows plan modifications, maximum control
|
|
@@ -185,7 +214,7 @@ After configuration:
|
|
|
185
214
|
- Script interaction language: Controls installation prompts language
|
|
186
215
|
- Configuration file language: Determines which configuration set to install (zh-CN/en)
|
|
187
216
|
- AI output language: Choose the language for AI responses (supports Chinese, English, and custom languages)
|
|
188
|
-
- AI
|
|
217
|
+
- AI output styles: Support multiple preset styles (Professional Engineer, Nekomata Engineer, Laowang Engineer) for customized experience
|
|
189
218
|
|
|
190
219
|
### 🔧 Smart Installation
|
|
191
220
|
|
|
@@ -243,7 +272,7 @@ Select function:
|
|
|
243
272
|
3. Configure API - Configure API URL and authentication (supports CCR proxy)
|
|
244
273
|
4. Configure MCP - Configure MCP services (includes Windows fix)
|
|
245
274
|
5. Configure default model - Set default model (opus/sonnet)
|
|
246
|
-
6. Configure Claude global memory - Configure AI output language and
|
|
275
|
+
6. Configure Claude global memory - Configure AI output language and output styles
|
|
247
276
|
7. Import recommended environment variables and permissions - Import privacy protection environment variables and system permissions
|
|
248
277
|
|
|
249
278
|
--------- Other Tools ----------
|
|
@@ -274,17 +303,16 @@ Enter your choice: _
|
|
|
274
303
|
Custom
|
|
275
304
|
(Supports Japanese, French, German, and more)
|
|
276
305
|
|
|
277
|
-
? Select AI personality:
|
|
278
|
-
❯ Professional Assistant(Default)
|
|
279
|
-
Catgirl Assistant
|
|
280
|
-
Friendly Assistant
|
|
281
|
-
Mentor Mode
|
|
282
|
-
Custom
|
|
283
|
-
|
|
284
306
|
? Claude Code not found. Install automatically? (Y/n)
|
|
285
307
|
|
|
286
308
|
✔ Claude Code installed successfully
|
|
287
309
|
|
|
310
|
+
? Existing config detected. How to proceed?
|
|
311
|
+
❯ Backup and overwrite - Backup existing config to ~/.claude/backup/
|
|
312
|
+
Update docs only - Only update workflows and docs, keep existing API config
|
|
313
|
+
Merge config - Merge with existing config, preserve user customizations
|
|
314
|
+
Skip - Skip configuration update
|
|
315
|
+
|
|
288
316
|
? Select API authentication method
|
|
289
317
|
❯ Use Auth Token (OAuth authentication)
|
|
290
318
|
For tokens obtained via OAuth or browser login
|
|
@@ -297,32 +325,54 @@ Enter your choice: _
|
|
|
297
325
|
? Enter API URL: https://api.anthropic.com
|
|
298
326
|
? Enter Auth Token or API Key: xxx
|
|
299
327
|
|
|
300
|
-
?
|
|
301
|
-
❯
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
328
|
+
? Select output styles to install:
|
|
329
|
+
❯ Engineer Professional - Professional software engineer following SOLID, KISS, DRY, YAGNI principles
|
|
330
|
+
Nekomata Engineer - Professional catgirl engineer Nova, combining rigorous engineering with cute catgirl traits
|
|
331
|
+
Laowang Grumpy Tech - Laowang grumpy tech style, never tolerates code errors and non-standard code
|
|
332
|
+
|
|
333
|
+
? Select global default output style:
|
|
334
|
+
❯ Engineer Professional
|
|
335
|
+
|
|
336
|
+
? Configure MCP services? (Y/n)
|
|
337
|
+
|
|
338
|
+
? Select MCP services to install:
|
|
339
|
+
❯ context7 - Get latest library and framework documentation
|
|
340
|
+
mcp-deepwiki - Access deepwiki.com knowledge base
|
|
341
|
+
Playwright - Browser automation and web testing
|
|
342
|
+
exa - Advanced search and enterprise research tools
|
|
343
|
+
|
|
344
|
+
? Select workflows to install:
|
|
345
|
+
❯ Common Tools Workflow - init-project and related agents
|
|
346
|
+
Six Steps Workflow - Complete six-stage development process
|
|
347
|
+
Feature Planning UX - Complete feature development lifecycle
|
|
348
|
+
Git Workflow - Git operations and branch management
|
|
349
|
+
BMad Workflow - AI-driven agile development methodology
|
|
350
|
+
|
|
351
|
+
? Install CCometixLine statusline tool? (Y/n)
|
|
352
|
+
|
|
353
|
+
✔ Setup complete! Claude Code environment is ready
|
|
354
|
+
```
|
|
305
355
|
|
|
306
356
|
✔ All config files backed up to ~/.claude/backup/xxx
|
|
307
357
|
✔ Config files copied to ~/.claude
|
|
308
358
|
|
|
309
359
|
? Select workflows to install (space to select, enter to confirm)
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
360
|
+
❯ ◉ Common Tools (init-project + init-architect + get-current-datetime) - Essential project initialization and utility commands
|
|
361
|
+
◉ Six Steps Workflow (workflow) - Complete 6-phase development process
|
|
362
|
+
◉ Feature Planning and UX Design (feat + planner + ui-ux-designer) - Structured feature development
|
|
363
|
+
◉ Git Commands (commit + rollback + cleanBranches + worktree) - Streamlined Git operations
|
|
364
|
+
◉ BMAD-Method Extension Installer - Enterprise agile development workflow
|
|
315
365
|
|
|
316
366
|
✔ Installing workflows...
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
367
|
+
✔ Installed command: zcf/workflow.md
|
|
368
|
+
✔ Installed command: zcf/feat.md
|
|
369
|
+
✔ Installed agent: zcf/plan/planner.md
|
|
370
|
+
✔ Installed agent: zcf/plan/ui-ux-designer.md
|
|
371
|
+
✔ Installed command: zcf/git/git-commit.md
|
|
372
|
+
✔ Installed command: zcf/git/git-rollback.md
|
|
373
|
+
✔ Installed command: zcf/git/git-cleanBranches.md
|
|
374
|
+
✔ Installed command: zcf/git/git-worktree.md
|
|
375
|
+
✔ Installed command: zcf/bmad-init.md
|
|
326
376
|
✔ Workflow installation successful
|
|
327
377
|
|
|
328
378
|
✔ API configured
|
|
@@ -330,18 +380,19 @@ Enter your choice: _
|
|
|
330
380
|
? Configure MCP services? (Y/n)
|
|
331
381
|
|
|
332
382
|
? Select MCP services to install (space to select, enter to confirm)
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
383
|
+
❯ ◯ Install all
|
|
384
|
+
◯ Context7 Documentation Query - Query latest library docs and code examples
|
|
385
|
+
◯ DeepWiki - Query GitHub repository docs and examples
|
|
386
|
+
◯ Playwright Browser Control - Direct browser automation control
|
|
387
|
+
◯ Exa AI Search - Web search using Exa AI
|
|
338
388
|
|
|
339
389
|
? Enter Exa API Key (get from https://dashboard.exa.ai/api-keys)
|
|
340
390
|
|
|
341
391
|
✔ MCP services configured
|
|
342
392
|
|
|
343
393
|
🎉 Setup complete! Use 'claude' command to start.
|
|
344
|
-
|
|
394
|
+
|
|
395
|
+
````
|
|
345
396
|
|
|
346
397
|
### Command Line Options
|
|
347
398
|
|
|
@@ -378,7 +429,7 @@ npx zcf -h
|
|
|
378
429
|
# Show version
|
|
379
430
|
npx zcf --version
|
|
380
431
|
npx zcf -v
|
|
381
|
-
|
|
432
|
+
````
|
|
382
433
|
|
|
383
434
|
#### Usage Examples
|
|
384
435
|
|
|
@@ -424,7 +475,7 @@ zcf/
|
|
|
424
475
|
│ ├── settings.json # Base configuration (with privacy env vars)
|
|
425
476
|
│ ├── en/ # English version
|
|
426
477
|
│ │ ├── rules.md # Core principles (formerly CLAUDE.md)
|
|
427
|
-
│ │ ├──
|
|
478
|
+
│ │ ├── output-styles/ # AI output styles (v2.12+ new)
|
|
428
479
|
│ │ ├── mcp.md # MCP services guide (v2.0 new)
|
|
429
480
|
│ │ ├── agents/ # AI agents
|
|
430
481
|
│ │ └── commands/ # Command definitions
|