Package Exports

zcf
zcf/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (zcf) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ZCF - Zero-Config Claude-Code Flow

中文 | English

零配置，一键搞定 Claude Code 环境设置 - 支持中英文双语配置和智能代理系统

🚀 快速开始

根据你的情况选择：

🆕 首次使用 Claude Code

npx zcf          # 完整初始化：安装 Claude Code + 配置 API + 设置 MCP 服务

🔄 已有 Claude Code 环境

npx zcf u        # 仅导入工作流：快速添加 AI 工作流和命令系统

提示：zcf u 是 zcf update 的缩写，专为已配置用户设计，只更新工作流相关文件，保留你的 API 和 MCP 配置。

初始化流程

完整初始化（npx zcf）会自动：

✅ 检测并安装 Claude Code
✅ 配置 API 密钥
✅ 选择并配置 MCP 服务
✅ 设置所有必要的配置文件

使用方式

配置完成后：

项目第一次使用强烈建议先运行 /init 进行初始化，生成 CLAUDE.md 便于 AI 理解项目架构
<任务描述> - 不使用任何工作流直接执行，会遵循 SOLID、KISS、DRY 和 YAGNI 原则，适合修复 Bug 等小任务
/feat <任务描述> - 开始新功能开发，分为 plan 和 ui 两个阶段
/workflow <任务描述> - 执行完整开发工作流，不是自动化，开始会给出多套方案，每一步会询问用户意见，可随时修改方案，掌控力 MAX

PS:

feat 和 workflow 这两套各有优势，可以都试试比较一下

生成的文档位置默认都是项目根目录下的 .claude/xxx.md，可以把 .claude/ 加入项目的 .gitignore 里

✨ ZCF 工具特性

🌏 双语支持

脚本交互语言：控制安装过程的提示语言
配置文件语言：决定安装哪套配置文件（zh-CN/en）

🔧 智能安装

自动检测 Claude Code 安装状态
使用 npm 进行自动安装（确保兼容性）
跨平台支持（Windows/macOS/Linux）
自动配置 MCP 服务（新增）

📦 完整配置

CLAUDE.md 系统指令
settings.json 设置文件
commands 自定义命令
agents AI 代理配置

🔐 API 配置

自定义 API 支持
API Key 自动配置
支持稍后在 claude 命令中配置（如 OAuth）

💾 配置管理

智能备份现有配置（所有备份保存在 ~/.claude/backup/）
配置合并选项
安全的覆盖机制
MCP 配置修改前自动备份

📖 使用说明

交互式配置流程

$ npx zcf

? Select script language / 选择脚本语言:
  ❯ 简体中文
    English

? 选择 Claude Code 配置语言:
  ❯ 简体中文 (zh-CN) - 中文版（便于中文用户自定义）
    English (en) - 英文版（推荐，token 消耗更低）

? 检测到 Claude Code 未安装，是否自动安装？(Y/n)

✔ Claude Code 安装成功

? 是否配置 API？
  ❯ 配置 API
    跳过（稍后在 claude 命令中自行配置，如 OAuth）

? 请输入 API URL: https://api.anthropic.com
? 请输入 API Key: sk-xxx

? 检测到已有配置文件，如何处理？
  ❯ 备份并覆盖全部
    仅更新工作流相关md并备份旧配置
    合并配置
    跳过

✔ 已备份所有配置文件到 ~/.claude/backup/xxx
✔ 配置文件已复制到 ~/.claude
✔ API 配置完成

? 是否配置 MCP 服务？(Y/n)

? 选择要安装的 MCP 服务（空格选择，回车确认）
  ❯ ◯ 全部安装
    ◯ Context7 文档查询 - 查询最新的库文档和代码示例
    ◯ DeepWiki - 查询 GitHub 仓库文档和示例
    ◯ Playwright 浏览器控制 - 直接控制浏览器进行自动化操作
    ◯ Exa AI 搜索 - 使用 Exa AI 进行网页搜索

? 请输入 Exa API Key（可从 https://dashboard.exa.ai/api-keys 获取）

✔ MCP 服务已配置

🎉 配置完成！使用 'claude' 命令开始体验。

命令行参数

命令速查表

命令	缩写	说明
`zcf`	-	初始化配置（默认命令）
`zcf update`	`zcf u`	更新 Prompt 文档并备份旧配置

常用选项

# 指定配置语言
npx zcf --config-lang zh-CN
npx zcf -c zh-CN            # 使用缩写

# 强制覆盖现有配置
npx zcf --force
npx zcf -f                 # 使用缩写

# 更新 Prompt 文档并备份旧配置（保留 API 和 MCP 配置）
npx zcf u                  # 使用 update 命令
npx zcf update             # 完整命令

# 查看帮助信息
npx zcf --help
npx zcf -h

# 查看版本
npx zcf --version
npx zcf -v

使用示例

# 首次安装，交互式配置
npx zcf

# 更新 Prompt 文档并备份旧配置，保留 API 和 MCP 配置
npx zcf u

# 强制使用中文配置重新初始化
npx zcf --config-lang zh-CN --force
npx zcf -c zh-CN -f      # 使用缩写

# 更新到英文版 Prompt（降低 token 消耗）
npx zcf u --config-lang en
npx zcf u -c en            # 使用缩写

📁 项目结构

claude-code-config/
├── README.md              # 说明文档
├── package.json           # npm 包配置
├── bin/
│   └── zcf.mjs           # CLI 入口
├── src/                  # 源代码
│   ├── cli.ts           # CLI 主逻辑
│   ├── commands/        # 命令实现
│   ├── utils/           # 工具函数
│   └── constants.ts     # 常量定义
├── templates/            # 配置模板
│   ├── en/              # 英文版
│   │   ├── CLAUDE.md    # 核心原则
│   │   ├── settings.json
│   │   ├── agents/      # AI 代理
│   │   └── commands/    # 命令定义
│   └── zh-CN/           # 中文版
│       └── ... (相同结构)
└── dist/                # 构建输出

✨ 核心特性

🤖 专业代理

任务规划师：将复杂任务拆解为可执行步骤
UI/UX 设计师：提供专业界面设计指导

⚡ 命令系统

功能开发 (/feat)：结构化新功能开发
工作流 (/workflow)：完整的六阶段开发流程

🔧 智能配置

API 密钥管理
细粒度权限控制
多种 Claude 模型支持

🎯 开发工作流

六阶段工作流

[模式：研究] - 理解需求
[模式：构思] - 设计方案
[模式：计划] - 制定详细计划
[模式：执行] - 实施开发
[模式：优化] - 提升质量
[模式：评审] - 最终评估

⚙️ 支持的模型

opus：最强大，适合复杂任务
sonnet：平衡性能和成本
haiku：快速轻量级模型

🛠️ 开发

# 克隆项目
git clone https://github.com/UfoMiao/zcf.git
cd zcf

# 安装依赖（使用 pnpm）
pnpm install

# 构建项目
pnpm build

# 本地测试
node bin/zcf.mjs

💡 最佳实践

任务分解：保持任务独立可测试
代码质量：遵循 SOLID、KISS、DRY 和 YAGNI 原则
文档管理：计划存储在 .claude/ 目录

🔧 故障排除

如果遇到问题，可以：

重新运行 npx zcf 重新配置
检查 ~/.claude/ 目录下的配置文件
确保 Claude Code 已正确安装

🙏 鸣谢

本项目的部分 Prompt 参考了以下优秀作品：

感谢这些社区贡献者的分享！

📄 许可证

MIT 许可证

如果这个项目对你有帮助，请给我一个 ⭐️ Star！