zcf 2.12.0 → 2.12.2
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 -53
- package/dist/chunks/simple-config.mjs +244 -207
- package/dist/cli.mjs +4 -3
- package/dist/index.mjs +3 -3
- package/package.json +1 -1
- package/templates/en/output-styles/engineer-professional.md +11 -54
- package/templates/en/output-styles/laowang-engineer.md +76 -12
- package/templates/en/output-styles/nekomata-engineer.md +27 -74
- package/templates/zh-CN/output-styles/engineer-professional.md +13 -55
- package/templates/zh-CN/output-styles/laowang-engineer.md +76 -12
- package/templates/zh-CN/output-styles/nekomata-engineer.md +30 -77
package/README.md
CHANGED
|
@@ -71,39 +71,51 @@ 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, -r` | Config handling
|
|
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
|
-
| `--output-styles, -o` | Output styles to install (multi-select, comma-separated) | `engineer-professional`, `nekomata-engineer`, `laowang-engineer`, or `skip` for none
|
|
88
|
-
| `--default-output-style, -d`
|
|
89
|
-
| `--install-cometix-line, -x` | Install CCometixLine statusline tool
|
|
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
90
|
|
|
91
91
|
#### 🎨 AI Output Styles (v2.12+ New Feature)
|
|
92
92
|
|
|
93
93
|
ZCF now supports customizable AI output styles to personalize your Claude Code experience:
|
|
94
94
|
|
|
95
95
|
**Available Output Styles:**
|
|
96
|
+
|
|
96
97
|
- `engineer-professional`: Professional software engineer following SOLID, KISS, DRY, YAGNI principles
|
|
97
|
-
- `nekomata-engineer`: Professional catgirl engineer
|
|
98
|
+
- `nekomata-engineer`: Professional catgirl engineer UFO Nya, combining rigorous engineering with cute catgirl traits
|
|
98
99
|
- `laowang-engineer`: Laowang grumpy tech style, never tolerates code errors and non-standard code
|
|
99
100
|
- Built-in styles: `default`, `explanatory`, `learning` (always available)
|
|
100
101
|
|
|
101
102
|
**Features:**
|
|
103
|
+
|
|
102
104
|
- Install multiple styles and switch between them
|
|
103
105
|
- Set global default style for all projects
|
|
104
106
|
- Automatic cleanup of legacy personality files
|
|
105
107
|
- Template-based customization system
|
|
106
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.
|
|
118
|
+
|
|
107
119
|
#### 🎯 BMad Workflow (v2.7 New Feature)
|
|
108
120
|
|
|
109
121
|
[BMad](https://github.com/bmad-code-org/BMAD-METHOD) (BMad-Method: Universal AI Agent Framework) is an enterprise-grade workflow system that provides:
|
|
@@ -202,7 +214,7 @@ After configuration:
|
|
|
202
214
|
- Script interaction language: Controls installation prompts language
|
|
203
215
|
- Configuration file language: Determines which configuration set to install (zh-CN/en)
|
|
204
216
|
- AI output language: Choose the language for AI responses (supports Chinese, English, and custom languages)
|
|
205
|
-
- AI
|
|
217
|
+
- AI output styles: Support multiple preset styles (Professional Engineer, Nekomata Engineer, Laowang Engineer) for customized experience
|
|
206
218
|
|
|
207
219
|
### 🔧 Smart Installation
|
|
208
220
|
|
|
@@ -260,7 +272,7 @@ Select function:
|
|
|
260
272
|
3. Configure API - Configure API URL and authentication (supports CCR proxy)
|
|
261
273
|
4. Configure MCP - Configure MCP services (includes Windows fix)
|
|
262
274
|
5. Configure default model - Set default model (opus/sonnet)
|
|
263
|
-
6. Configure Claude global memory - Configure AI output language and
|
|
275
|
+
6. Configure Claude global memory - Configure AI output language and output styles
|
|
264
276
|
7. Import recommended environment variables and permissions - Import privacy protection environment variables and system permissions
|
|
265
277
|
|
|
266
278
|
--------- Other Tools ----------
|
|
@@ -291,17 +303,16 @@ Enter your choice: _
|
|
|
291
303
|
Custom
|
|
292
304
|
(Supports Japanese, French, German, and more)
|
|
293
305
|
|
|
294
|
-
? Select AI personality:
|
|
295
|
-
❯ Professional Assistant(Default)
|
|
296
|
-
Catgirl Assistant
|
|
297
|
-
Friendly Assistant
|
|
298
|
-
Mentor Mode
|
|
299
|
-
Custom
|
|
300
|
-
|
|
301
306
|
? Claude Code not found. Install automatically? (Y/n)
|
|
302
307
|
|
|
303
308
|
✔ Claude Code installed successfully
|
|
304
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
|
+
|
|
305
316
|
? Select API authentication method
|
|
306
317
|
❯ Use Auth Token (OAuth authentication)
|
|
307
318
|
For tokens obtained via OAuth or browser login
|
|
@@ -314,32 +325,54 @@ Enter your choice: _
|
|
|
314
325
|
? Enter API URL: https://api.anthropic.com
|
|
315
326
|
? Enter Auth Token or API Key: xxx
|
|
316
327
|
|
|
317
|
-
?
|
|
318
|
-
❯
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
328
|
+
? Select output styles to install:
|
|
329
|
+
❯ Engineer Professional - Professional software engineer following SOLID, KISS, DRY, YAGNI principles
|
|
330
|
+
Nekomata Engineer - Professional catgirl engineer UFO Nya, 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
|
+
```
|
|
322
355
|
|
|
323
356
|
✔ All config files backed up to ~/.claude/backup/xxx
|
|
324
357
|
✔ Config files copied to ~/.claude
|
|
325
358
|
|
|
326
359
|
? Select workflows to install (space to select, enter to confirm)
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
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
|
|
332
365
|
|
|
333
366
|
✔ Installing workflows...
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
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
|
|
343
376
|
✔ Workflow installation successful
|
|
344
377
|
|
|
345
378
|
✔ API configured
|
|
@@ -347,18 +380,19 @@ Enter your choice: _
|
|
|
347
380
|
? Configure MCP services? (Y/n)
|
|
348
381
|
|
|
349
382
|
? Select MCP services to install (space to select, enter to confirm)
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
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
|
|
355
388
|
|
|
356
389
|
? Enter Exa API Key (get from https://dashboard.exa.ai/api-keys)
|
|
357
390
|
|
|
358
391
|
✔ MCP services configured
|
|
359
392
|
|
|
360
393
|
🎉 Setup complete! Use 'claude' command to start.
|
|
361
|
-
|
|
394
|
+
|
|
395
|
+
````
|
|
362
396
|
|
|
363
397
|
### Command Line Options
|
|
364
398
|
|
|
@@ -395,7 +429,7 @@ npx zcf -h
|
|
|
395
429
|
# Show version
|
|
396
430
|
npx zcf --version
|
|
397
431
|
npx zcf -v
|
|
398
|
-
|
|
432
|
+
````
|
|
399
433
|
|
|
400
434
|
#### Usage Examples
|
|
401
435
|
|
|
@@ -441,7 +475,7 @@ zcf/
|
|
|
441
475
|
│ ├── settings.json # Base configuration (with privacy env vars)
|
|
442
476
|
│ ├── en/ # English version
|
|
443
477
|
│ │ ├── rules.md # Core principles (formerly CLAUDE.md)
|
|
444
|
-
│ │ ├──
|
|
478
|
+
│ │ ├── output-styles/ # AI output styles (v2.12+ new)
|
|
445
479
|
│ │ ├── mcp.md # MCP services guide (v2.0 new)
|
|
446
480
|
│ │ ├── agents/ # AI agents
|
|
447
481
|
│ │ └── commands/ # Command definitions
|