zcf 2.10.2 → 2.12.0

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 (40) hide show
  1. package/README.md +48 -26
  2. package/bin/zcf.mjs +1 -1
  3. package/dist/chunks/simple-config.mjs +1275 -1104
  4. package/dist/cli.mjs +298 -265
  5. package/dist/index.d.mts +16 -15
  6. package/dist/index.d.ts +16 -15
  7. package/dist/index.mjs +4 -5
  8. package/package.json +20 -15
  9. package/templates/CLAUDE.md +249 -5
  10. package/templates/en/output-styles/engineer-professional.md +130 -0
  11. package/templates/en/output-styles/laowang-engineer.md +62 -0
  12. package/templates/en/output-styles/nekomata-engineer.md +165 -0
  13. package/templates/en/workflow/bmad/commands/bmad-init.md +58 -56
  14. package/templates/en/workflow/common/agents/get-current-datetime.md +29 -0
  15. package/templates/en/workflow/common/agents/init-architect.md +114 -0
  16. package/templates/en/workflow/common/commands/init-project.md +53 -0
  17. package/templates/en/workflow/git/commands/git-cleanBranches.md +2 -1
  18. package/templates/en/workflow/git/commands/git-commit.md +36 -31
  19. package/templates/en/workflow/git/commands/git-rollback.md +27 -26
  20. package/templates/en/workflow/git/commands/git-worktree.md +197 -222
  21. package/templates/zh-CN/output-styles/engineer-professional.md +130 -0
  22. package/templates/zh-CN/output-styles/laowang-engineer.md +62 -0
  23. package/templates/zh-CN/output-styles/nekomata-engineer.md +165 -0
  24. package/templates/zh-CN/workflow/bmad/commands/bmad-init.md +58 -55
  25. package/templates/zh-CN/workflow/common/agents/get-current-datetime.md +29 -0
  26. package/templates/zh-CN/workflow/common/agents/init-architect.md +114 -0
  27. package/templates/zh-CN/workflow/common/commands/init-project.md +53 -0
  28. package/templates/zh-CN/workflow/git/commands/git-cleanBranches.md +2 -1
  29. package/templates/zh-CN/workflow/git/commands/git-commit.md +0 -5
  30. package/templates/zh-CN/workflow/git/commands/git-rollback.md +1 -1
  31. package/templates/zh-CN/workflow/git/commands/git-worktree.md +197 -222
  32. package/templates/en/memory/mcp.md +0 -22
  33. package/templates/en/memory/personality.md +0 -1
  34. package/templates/en/memory/rules.md +0 -45
  35. package/templates/en/memory/technical-guides.md +0 -126
  36. package/templates/zh-CN/memory/mcp.md +0 -22
  37. package/templates/zh-CN/memory/personality.md +0 -1
  38. package/templates/zh-CN/memory/rules.md +0 -45
  39. package/templates/zh-CN/memory/technical-guides.md +0 -126
  40. /package/templates/{settings.json → common/settings.json} +0 -0
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 personality, etc.)
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,38 @@ 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 | 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, -o` | 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) | `sixStepsWorkflow`, `featPlanUx`, `gitWorkflow`, `bmadWorkflow`, or `skip` for none | No | `all` |
87
- | `--ai-personality, -p` | AI personality type | `professional`, `catgirl`, `friendly`, `mentor`, `custom` | No | `professional` |
88
- | `--install-cometix-line, -x` | Install CCometixLine statusline tool | `true`, `false` | No | `true` |
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
+ - `engineer-professional`: Professional software engineer following SOLID, KISS, DRY, YAGNI principles
97
+ - `nekomata-engineer`: Professional catgirl engineer Nova, combining rigorous engineering with cute catgirl traits
98
+ - `laowang-engineer`: Laowang grumpy tech style, never tolerates code errors and non-standard code
99
+ - Built-in styles: `default`, `explanatory`, `learning` (always available)
100
+
101
+ **Features:**
102
+ - Install multiple styles and switch between them
103
+ - Set global default style for all projects
104
+ - Automatic cleanup of legacy personality files
105
+ - Template-based customization system
89
106
 
90
107
  #### 🎯 BMad Workflow (v2.7 New Feature)
91
108
 
@@ -139,6 +156,7 @@ After CCR setup, ZCF automatically configures Claude Code to use CCR as the API
139
156
  - **Auto Updates**: Included in ZCF's update checking system
140
157
 
141
158
  CCometixLine menu options (accessible via `npx zcf` → `L`):
159
+
142
160
  - `1` Install or Update - Install or update CCometixLine using npm
143
161
  - `2` Print Default Configuration - Display current CCometixLine configuration
144
162
  - `3` Custom Config - TUI Configuration Mode - Interactive terminal UI for customizing settings
@@ -167,7 +185,7 @@ Full initialization (`npx zcf`) will automatically:
167
185
 
168
186
  After configuration:
169
187
 
170
- - **For first-time project use, strongly recommend running `/init` to generate CLAUDE.md for better AI understanding of project architecture**
188
+ - **For first-time project use, strongly recommend running `/init-project` to generate CLAUDE.md for better AI understanding of project architecture**
171
189
  - `<task description>` - Execute directly without workflow, following SOLID, KISS, DRY, and YAGNI principles, suitable for small tasks like bug fixes
172
190
  - `/feat <task description>` - Start new feature development, divided into plan and UI phases
173
191
  - `/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
@@ -306,7 +324,8 @@ Enter your choice: _
306
324
  ✔ Config files copied to ~/.claude
307
325
 
308
326
  ? Select workflows to install (space to select, enter to confirm)
309
- ❯ ◉ Six Steps Workflow (workflow) - Complete 6-phase development process
327
+ ❯ ◉ Common Tools (init-project + init-architect + get-current-datetime) - Essential project initialization and utility commands
328
+ ◉ Six Steps Workflow (workflow) - Complete 6-phase development process
310
329
  ◉ Feature Planning and UX Design (feat + planner + ui-ux-designer) - Structured feature development
311
330
  ◉ Git Commands (commit + rollback + cleanBranches + worktree) - Streamlined Git operations
312
331
  ◉ BMAD-Method Extension Installer - Enterprise agile development workflow
@@ -345,13 +364,14 @@ Enter your choice: _
345
364
 
346
365
  #### Commands Quick Reference
347
366
 
348
- | Command | Alias | Description |
349
- | ------------ | ------- | ------------------------------------------------------------------------------------- |
350
- | `zcf` | - | Show interactive menu (v2.0 default command) |
351
- | `zcf init` | `zcf i` | Initialize Claude Code configuration |
352
- | `zcf update` | `zcf u` | Update workflow-related md files with backup |
353
- | `zcf ccu` | - | Run Claude Code usage analysis tool - [ccusage](https://github.com/ryoppippi/ccusage) |
354
- | `zcf ccr` | - | Open CCR (Claude Code Router) management menu |
367
+ | Command | Alias | Description |
368
+ | ------------------- | ------- | ------------------------------------------------------------------------------------- |
369
+ | `zcf` | - | Show interactive menu (v2.0 default command) |
370
+ | `zcf init` | `zcf i` | Initialize Claude Code configuration |
371
+ | `zcf update` | `zcf u` | Update workflow-related md files with backup |
372
+ | `zcf ccu` | - | Run Claude Code usage analysis tool - [ccusage](https://github.com/ryoppippi/ccusage) |
373
+ | `zcf ccr` | - | Open CCR (Claude Code Router) management menu |
374
+ | `zcf check-updates` | - | Check and update Claude Code, CCR and CCometixLine versions |
355
375
 
356
376
  #### Common Options
357
377
 
@@ -576,7 +596,9 @@ If you find this project helpful, please consider sponsoring its development. Yo
576
596
  A huge thank you to all our sponsors for their generous support!
577
597
 
578
598
  - Tc (first sponsor)
579
- - 16°C 咖啡 (My best friend🤪, offered Claude Code max $200 package)
599
+ - Argolinhas (first ko-fi sponsor ٩(•̤̀ᵕ•̤́๑))
600
+ - r\*r (first anonymous sponsor🤣)
601
+ - 16°C coffee (My best friend🤪, offered Claude Code max $200 package)
580
602
 
581
603
  ## 📄 License
582
604
 
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'