zcf 2.10.1 → 2.11.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.
- package/README.md +35 -24
- package/bin/zcf.mjs +1 -1
- package/dist/chunks/simple-config.mjs +948 -896
- package/dist/cli.mjs +319 -256
- package/dist/index.d.mts +13 -13
- package/dist/index.d.ts +13 -13
- package/dist/index.mjs +3 -4
- package/package.json +20 -15
- package/templates/CLAUDE.md +249 -5
- package/templates/common/CLAUDE.md +5 -0
- package/templates/en/memory/mcp.md +4 -1
- package/templates/en/memory/personality.md +1 -1
- package/templates/en/memory/rules.md +1 -4
- package/templates/en/workflow/bmad/commands/bmad-init.md +58 -56
- package/templates/en/workflow/common/agents/get-current-datetime.md +29 -0
- package/templates/en/workflow/common/agents/init-architect.md +114 -0
- package/templates/en/workflow/common/commands/init-project.md +53 -0
- package/templates/en/workflow/git/commands/git-cleanBranches.md +2 -1
- package/templates/en/workflow/git/commands/git-commit.md +36 -31
- package/templates/en/workflow/git/commands/git-rollback.md +27 -26
- package/templates/en/workflow/git/commands/git-worktree.md +145 -221
- package/templates/zh-CN/memory/mcp.md +4 -1
- package/templates/zh-CN/memory/personality.md +1 -1
- package/templates/zh-CN/memory/rules.md +1 -4
- package/templates/zh-CN/workflow/bmad/commands/bmad-init.md +58 -55
- package/templates/zh-CN/workflow/common/agents/get-current-datetime.md +29 -0
- package/templates/zh-CN/workflow/common/agents/init-architect.md +114 -0
- package/templates/zh-CN/workflow/common/commands/init-project.md +53 -0
- package/templates/zh-CN/workflow/git/commands/git-cleanBranches.md +2 -1
- package/templates/zh-CN/workflow/git/commands/git-commit.md +0 -5
- package/templates/zh-CN/workflow/git/commands/git-rollback.md +1 -1
- package/templates/zh-CN/workflow/git/commands/git-worktree.md +145 -221
- /package/templates/{settings.json → common/settings.json} +0 -0
package/README.md
CHANGED
|
@@ -71,21 +71,21 @@ 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
|
|
75
|
-
| ---------------------------- | ------------------------------------------------------- |
|
|
76
|
-
| `--skip-prompt, -s` | Skip all interactive prompts | -
|
|
77
|
-
| `--lang, -l` | ZCF display language | `zh-CN`, `en`
|
|
78
|
-
| `--config-lang, -c` | Configuration language | `zh-CN`, `en`
|
|
79
|
-
| `--ai-output-lang, -a` | AI output language | `zh-CN`, `en`, custom string
|
|
80
|
-
| `--all-lang, -g` | Set all language parameters to this value | `zh-CN`, `en`, custom string
|
|
81
|
-
| `--config-action, -o` | Config handling | `new`, `backup`, `merge`, `docs-only`, `skip`
|
|
82
|
-
| `--api-type, -t` | API configuration type | `auth_token`, `api_key`, `ccr_proxy`, `skip`
|
|
83
|
-
| `--api-key, -k` | API key (for both API key and auth token types) | string
|
|
84
|
-
| `--api-url, -u` | Custom API URL | URL string
|
|
85
|
-
| `--mcp-services, -m` | MCP services to install (multi-select, comma-separated) | `context7`, `mcp-deepwiki`, `Playwright`, `exa`, or `skip` for none
|
|
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`
|
|
88
|
-
| `--install-cometix-line, -x` | Install CCometixLine statusline tool | `true`, `false`
|
|
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) | `commonTools`, `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` |
|
|
89
89
|
|
|
90
90
|
#### 🎯 BMad Workflow (v2.7 New Feature)
|
|
91
91
|
|
|
@@ -135,8 +135,15 @@ After CCR setup, ZCF automatically configures Claude Code to use CCR as the API
|
|
|
135
135
|
- **Git Integration**: Display Git status and branch information
|
|
136
136
|
- **Status Line Display**: Native integration with your terminal statusline
|
|
137
137
|
- **Performance Optimized**: Built with Rust for minimal resource usage
|
|
138
|
+
- **TUI Configuration**: Interactive terminal UI for customizing themes, segments, and display options
|
|
138
139
|
- **Auto Updates**: Included in ZCF's update checking system
|
|
139
140
|
|
|
141
|
+
CCometixLine menu options (accessible via `npx zcf` → `L`):
|
|
142
|
+
|
|
143
|
+
- `1` Install or Update - Install or update CCometixLine using npm
|
|
144
|
+
- `2` Print Default Configuration - Display current CCometixLine configuration
|
|
145
|
+
- `3` Custom Config - TUI Configuration Mode - Interactive terminal UI for customizing settings
|
|
146
|
+
|
|
140
147
|
> **Important Note for v2.9.9 Users**: If you have previously used ZCF v2.9.9 to set up your environment, please re-run the initialization process to ensure CCometixLine configuration is properly added. Run `npx zcf` and select the appropriate setup option to update your configuration with CCometixLine support.
|
|
141
148
|
|
|
142
149
|
#### 🚀 Check for updates (v2.8.1+, CCometixLine support v2.9.9+):
|
|
@@ -300,7 +307,8 @@ Enter your choice: _
|
|
|
300
307
|
✔ Config files copied to ~/.claude
|
|
301
308
|
|
|
302
309
|
? Select workflows to install (space to select, enter to confirm)
|
|
303
|
-
❯ ◉
|
|
310
|
+
❯ ◉ Common Tools (init-project + init-architect + get-current-datetime) - Essential project initialization and utility commands
|
|
311
|
+
◉ Six Steps Workflow (workflow) - Complete 6-phase development process
|
|
304
312
|
◉ Feature Planning and UX Design (feat + planner + ui-ux-designer) - Structured feature development
|
|
305
313
|
◉ Git Commands (commit + rollback + cleanBranches + worktree) - Streamlined Git operations
|
|
306
314
|
◉ BMAD-Method Extension Installer - Enterprise agile development workflow
|
|
@@ -339,13 +347,14 @@ Enter your choice: _
|
|
|
339
347
|
|
|
340
348
|
#### Commands Quick Reference
|
|
341
349
|
|
|
342
|
-
| Command
|
|
343
|
-
|
|
|
344
|
-
| `zcf`
|
|
345
|
-
| `zcf init`
|
|
346
|
-
| `zcf update`
|
|
347
|
-
| `zcf ccu`
|
|
348
|
-
| `zcf ccr`
|
|
350
|
+
| Command | Alias | Description |
|
|
351
|
+
| ------------------- | ------- | ------------------------------------------------------------------------------------- |
|
|
352
|
+
| `zcf` | - | Show interactive menu (v2.0 default command) |
|
|
353
|
+
| `zcf init` | `zcf i` | Initialize Claude Code configuration |
|
|
354
|
+
| `zcf update` | `zcf u` | Update workflow-related md files with backup |
|
|
355
|
+
| `zcf ccu` | - | Run Claude Code usage analysis tool - [ccusage](https://github.com/ryoppippi/ccusage) |
|
|
356
|
+
| `zcf ccr` | - | Open CCR (Claude Code Router) management menu |
|
|
357
|
+
| `zcf check-updates` | - | Check and update Claude Code, CCR and CCometixLine versions |
|
|
349
358
|
|
|
350
359
|
#### Common Options
|
|
351
360
|
|
|
@@ -570,7 +579,9 @@ If you find this project helpful, please consider sponsoring its development. Yo
|
|
|
570
579
|
A huge thank you to all our sponsors for their generous support!
|
|
571
580
|
|
|
572
581
|
- Tc (first sponsor)
|
|
573
|
-
-
|
|
582
|
+
- Argolinhas (first ko-fi sponsor ٩(•̤̀ᵕ•̤́๑))
|
|
583
|
+
- r\*r (first anonymous sponsor🤣)
|
|
584
|
+
- 16°C coffee (My best friend🤪, offered Claude Code max $200 package)
|
|
574
585
|
|
|
575
586
|
## 📄 License
|
|
576
587
|
|
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'
|