zcf 1.0.0

package/README.md

@@ -0,0 +1,238 @@
+# ZCF - Zero-Config Claude-Code Flow
+
+**中文** | [English](README_EN.md)
+
+> 零配置，一键搞定 Claude Code 环境设置 - 支持中英文双语配置和智能代理系统
+
+## 🚀 快速开始
+
+```bash
+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/yarn/pnpm 包管理器
+- 跨平台支持（Windows/macOS/Linux）
+- 自动配置 MCP 服务（新增）
+
+### 📦 完整配置
+- CLAUDE.md 系统指令
+- settings.json 设置文件
+- commands 自定义命令
+- agents AI 代理配置
+
+### 🔐 API 配置
+- 自定义 API 支持
+- API Key 自动配置
+- 支持稍后在 claude 命令中配置（如 OAuth）
+
+### 💾 配置管理
+- 智能备份现有配置（所有备份保存在 ~/.claude/backup/）
+- 配置合并选项
+- 安全的覆盖机制
+- MCP 配置修改前自动备份
+
+## 📖 使用说明
+
+### 交互式配置流程
+
+```bash
+$ 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
+
+? 检测到已有配置文件，如何处理？
+  ❯ 备份并覆盖全部
+    仅更新 Prompt 文档并备份旧配置
+    合并配置
+    跳过
+
+✔ 已备份所有配置文件到 ~/.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' 命令开始体验。
+```
+
+### 命令行参数
+
+```bash
+# 指定配置语言
+npx zcf --config-lang zh-CN
+
+# 强制覆盖现有配置
+npx zcf --force
+
+# 跳过 Claude Code 安装检测
+npx zcf --skip-install
+
+# 帮助信息
+npx zcf --help
+```
+
+## 📁 项目结构
+
+```
+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 模型支持
+
+## 🎯 开发工作流
+
+### 六阶段工作流
+
+1. **[模式：研究]** - 理解需求
+2. **[模式：构思]** - 设计方案
+3. **[模式：计划]** - 制定详细计划
+4. **[模式：执行]** - 实施开发
+5. **[模式：优化]** - 提升质量
+6. **[模式：评审]** - 最终评估
+
+## ⚙️ 支持的模型
+
+- **opus**：最强大，适合复杂任务
+- **sonnet**：平衡性能和成本
+- **haiku**：快速轻量级模型
+
+## 🛠️ 开发
+
+```bash
+# 克隆项目
+git clone https://github.com/UfoMiao/claude-code-config.git
+cd claude-code-config
+
+# 安装依赖（使用 pnpm）
+pnpm install
+
+# 构建项目
+pnpm build
+
+# 本地测试
+node bin/zcf.mjs
+```
+
+## 💡 最佳实践
+
+1. **任务分解**：保持任务独立可测试
+2. **代码质量**：遵循 SOLID、KISS、DRY 和 YAGNI 原则
+3. **文档管理**：计划存储在 `.claude/` 目录
+
+## 🔧 故障排除
+
+如果遇到问题，可以：
+
+1. 重新运行 `npx zcf` 重新配置
+2. 检查 `~/.claude/` 目录下的配置文件
+3. 确保 Claude Code 已正确安装
+
+## 🙏 鸣谢
+
+本项目的部分 Prompt 参考了以下优秀作品：
+
+- [Linux.do - 分享一个让 AI 只生成必要的代码的通用 Prompt，欢迎一起调优~](https://linux.do/t/topic/830802)
+- [Linux.do - claude code 降智不怕，使用 agent 与 command 结合将任务做详细的拆分大概可以帮助到你](https://linux.do/t/topic/815230)
+- [Linux.do - cursor 快速开发规则](https://linux.do/t/topic/697566)
+
+感谢这些社区贡献者的分享！
+
+## 📄 许可证
+
+MIT 许可证
+
+---
+
+如果这个项目对你有帮助，请给我一个 ⭐️ Star！
+
+[![Star History Chart](https://api.star-history.com/svg?repos=UfoMiao/claude-code-config&type=Date)](https://star-history.com/#UfoMiao/claude-code-config&Date)

package/bin/zcf.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.mjs'

package/dist/cli.d.mts

@@ -0,0 +1 @@
+

package/dist/cli.d.ts

@@ -0,0 +1 @@
+

package/dist/cli.mjs

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+import cac from 'cac';
+import { i as init } from './shared/zcf.DMG6psxU.mjs';
+import '@posva/prompts';
+import 'ansis';
+import 'node:fs';
+import 'node:os';
+import 'pathe';
+import 'dayjs';
+import 'tinyexec';
+
+const version = "1.0.0";
+
+const cli = cac("zcf");
+cli.command("[lang]", "Initialize Claude Code configuration").option("--config-lang <lang>", "Configuration language (zh-CN, en)").option("--force", "Force overwrite existing configuration").option("--skip-install", "Skip Claude Code installation check").action(async (lang, options) => {
+  await init({
+    lang: lang || options.lang,
+    configLang: options.configLang,
+    force: options.force,
+    skipInstall: options.skipInstall
+  });
+});
+cli.help();
+cli.version(version);
+cli.parse();

package/dist/index.d.mts

@@ -0,0 +1,154 @@
+interface McpService {
+    id: string;
+    name: {
+        en: string;
+        'zh-CN': string;
+    };
+    description: {
+        en: string;
+        'zh-CN': string;
+    };
+    requiresApiKey: boolean;
+    apiKeyPrompt?: {
+        en: string;
+        'zh-CN': string;
+    };
+    apiKeyPlaceholder?: string;
+    config: McpServerConfig;
+}
+interface McpServerConfig {
+    type: 'stdio' | 'sse';
+    command?: string;
+    args?: string[];
+    url?: string;
+    env?: Record<string, string>;
+}
+interface McpConfiguration {
+    mcpServers: Record<string, McpServerConfig>;
+}
+
+declare const CLAUDE_DIR: string;
+declare const SETTINGS_FILE: string;
+declare const CLAUDE_MD_FILE: string;
+declare const MCP_CONFIG_FILE: string;
+declare const SUPPORTED_LANGS: readonly ["zh-CN", "en"];
+type SupportedLang = typeof SUPPORTED_LANGS[number];
+declare const LANG_LABELS: {
+    readonly 'zh-CN': "简体中文";
+    readonly en: "English";
+};
+declare const I18N: {
+    'zh-CN': {
+        selectScriptLang: string;
+        selectConfigLang: string;
+        configLangHint: {
+            'zh-CN': string;
+            en: string;
+        };
+        installPrompt: string;
+        installing: string;
+        installSuccess: string;
+        installFailed: string;
+        npmNotFound: string;
+        configureApi: string;
+        customApi: string;
+        skipApi: string;
+        enterApiUrl: string;
+        enterApiKey: string;
+        existingConfig: string;
+        backupAndOverwrite: string;
+        updateDocsOnly: string;
+        mergeConfig: string;
+        skip: string;
+        backupSuccess: string;
+        copying: string;
+        configSuccess: string;
+        apiConfigSuccess: string;
+        mcpConfigSuccess: string;
+        selectMcpServices: string;
+        allServices: string;
+        mcpServiceInstalled: string;
+        enterExaApiKey: string;
+        skipMcp: string;
+        configureMcp: string;
+        mcpBackupSuccess: string;
+        complete: string;
+        error: string;
+        yes: string;
+        no: string;
+    };
+    en: {
+        selectScriptLang: string;
+        selectConfigLang: string;
+        configLangHint: {
+            'zh-CN': string;
+            en: string;
+        };
+        installPrompt: string;
+        installing: string;
+        installSuccess: string;
+        installFailed: string;
+        npmNotFound: string;
+        configureApi: string;
+        customApi: string;
+        skipApi: string;
+        enterApiUrl: string;
+        enterApiKey: string;
+        existingConfig: string;
+        backupAndOverwrite: string;
+        updateDocsOnly: string;
+        mergeConfig: string;
+        skip: string;
+        backupSuccess: string;
+        copying: string;
+        configSuccess: string;
+        apiConfigSuccess: string;
+        mcpConfigSuccess: string;
+        selectMcpServices: string;
+        allServices: string;
+        mcpServiceInstalled: string;
+        enterExaApiKey: string;
+        skipMcp: string;
+        configureMcp: string;
+        mcpBackupSuccess: string;
+        complete: string;
+        error: string;
+        yes: string;
+        no: string;
+    };
+};
+declare const MCP_SERVICES: McpService[];
+
+interface InitOptions {
+    lang?: SupportedLang;
+    configLang?: SupportedLang;
+    force?: boolean;
+    skipInstall?: boolean;
+}
+declare function init(options?: InitOptions): Promise<void>;
+
+declare function getPlatform(): "windows" | "macos" | "linux";
+declare function commandExists(command: string): Promise<boolean>;
+
+declare function isClaudeCodeInstalled(): Promise<boolean>;
+declare function installClaudeCode(lang: SupportedLang): Promise<void>;
+
+declare function ensureClaudeDir(): void;
+declare function backupExistingConfig(): string | null;
+declare function copyConfigFiles(lang: SupportedLang, onlyMd?: boolean): void;
+interface ApiConfig {
+    url: string;
+    key: string;
+}
+declare function configureApi(apiConfig: ApiConfig | null): void;
+declare function mergeConfigs(sourceFile: string, targetFile: string): void;
+
+declare function getMcpConfigPath(): string;
+declare function readMcpConfig(): McpConfiguration | null;
+declare function writeMcpConfig(config: McpConfiguration): void;
+declare function backupMcpConfig(): string | null;
+declare function mergeMcpServers(existing: McpConfiguration | null, newServers: Record<string, McpServerConfig>): McpConfiguration;
+declare function buildMcpServerConfig(baseConfig: McpServerConfig, apiKey?: string, placeholder?: string): McpServerConfig;
+
+export { CLAUDE_DIR, CLAUDE_MD_FILE, I18N, LANG_LABELS, MCP_CONFIG_FILE, MCP_SERVICES, SETTINGS_FILE, SUPPORTED_LANGS, backupExistingConfig, backupMcpConfig, buildMcpServerConfig, commandExists, configureApi, copyConfigFiles, ensureClaudeDir, getMcpConfigPath, getPlatform, init, installClaudeCode, isClaudeCodeInstalled, mergeConfigs, mergeMcpServers, readMcpConfig, writeMcpConfig };
+export type { ApiConfig, McpConfiguration, McpServerConfig, McpService, SupportedLang };

package/dist/index.d.ts

@@ -0,0 +1,154 @@
+interface McpService {
+    id: string;
+    name: {
+        en: string;
+        'zh-CN': string;
+    };
+    description: {
+        en: string;
+        'zh-CN': string;
+    };
+    requiresApiKey: boolean;
+    apiKeyPrompt?: {
+        en: string;
+        'zh-CN': string;
+    };
+    apiKeyPlaceholder?: string;
+    config: McpServerConfig;
+}
+interface McpServerConfig {
+    type: 'stdio' | 'sse';
+    command?: string;
+    args?: string[];
+    url?: string;
+    env?: Record<string, string>;
+}
+interface McpConfiguration {
+    mcpServers: Record<string, McpServerConfig>;
+}
+
+declare const CLAUDE_DIR: string;
+declare const SETTINGS_FILE: string;
+declare const CLAUDE_MD_FILE: string;
+declare const MCP_CONFIG_FILE: string;
+declare const SUPPORTED_LANGS: readonly ["zh-CN", "en"];
+type SupportedLang = typeof SUPPORTED_LANGS[number];
+declare const LANG_LABELS: {
+    readonly 'zh-CN': "简体中文";
+    readonly en: "English";
+};
+declare const I18N: {
+    'zh-CN': {
+        selectScriptLang: string;
+        selectConfigLang: string;
+        configLangHint: {
+            'zh-CN': string;
+            en: string;
+        };
+        installPrompt: string;
+        installing: string;
+        installSuccess: string;
+        installFailed: string;
+        npmNotFound: string;
+        configureApi: string;
+        customApi: string;
+        skipApi: string;
+        enterApiUrl: string;
+        enterApiKey: string;
+        existingConfig: string;
+        backupAndOverwrite: string;
+        updateDocsOnly: string;
+        mergeConfig: string;
+        skip: string;
+        backupSuccess: string;
+        copying: string;
+        configSuccess: string;
+        apiConfigSuccess: string;
+        mcpConfigSuccess: string;
+        selectMcpServices: string;
+        allServices: string;
+        mcpServiceInstalled: string;
+        enterExaApiKey: string;
+        skipMcp: string;
+        configureMcp: string;
+        mcpBackupSuccess: string;
+        complete: string;
+        error: string;
+        yes: string;
+        no: string;
+    };
+    en: {
+        selectScriptLang: string;
+        selectConfigLang: string;
+        configLangHint: {
+            'zh-CN': string;
+            en: string;
+        };
+        installPrompt: string;
+        installing: string;
+        installSuccess: string;
+        installFailed: string;
+        npmNotFound: string;
+        configureApi: string;
+        customApi: string;
+        skipApi: string;
+        enterApiUrl: string;
+        enterApiKey: string;
+        existingConfig: string;
+        backupAndOverwrite: string;
+        updateDocsOnly: string;
+        mergeConfig: string;
+        skip: string;
+        backupSuccess: string;
+        copying: string;
+        configSuccess: string;
+        apiConfigSuccess: string;
+        mcpConfigSuccess: string;
+        selectMcpServices: string;
+        allServices: string;
+        mcpServiceInstalled: string;
+        enterExaApiKey: string;
+        skipMcp: string;
+        configureMcp: string;
+        mcpBackupSuccess: string;
+        complete: string;
+        error: string;
+        yes: string;
+        no: string;
+    };
+};
+declare const MCP_SERVICES: McpService[];
+
+interface InitOptions {
+    lang?: SupportedLang;
+    configLang?: SupportedLang;
+    force?: boolean;
+    skipInstall?: boolean;
+}
+declare function init(options?: InitOptions): Promise<void>;
+
+declare function getPlatform(): "windows" | "macos" | "linux";
+declare function commandExists(command: string): Promise<boolean>;
+
+declare function isClaudeCodeInstalled(): Promise<boolean>;
+declare function installClaudeCode(lang: SupportedLang): Promise<void>;
+
+declare function ensureClaudeDir(): void;
+declare function backupExistingConfig(): string | null;
+declare function copyConfigFiles(lang: SupportedLang, onlyMd?: boolean): void;
+interface ApiConfig {
+    url: string;
+    key: string;
+}
+declare function configureApi(apiConfig: ApiConfig | null): void;
+declare function mergeConfigs(sourceFile: string, targetFile: string): void;
+
+declare function getMcpConfigPath(): string;
+declare function readMcpConfig(): McpConfiguration | null;
+declare function writeMcpConfig(config: McpConfiguration): void;
+declare function backupMcpConfig(): string | null;
+declare function mergeMcpServers(existing: McpConfiguration | null, newServers: Record<string, McpServerConfig>): McpConfiguration;
+declare function buildMcpServerConfig(baseConfig: McpServerConfig, apiKey?: string, placeholder?: string): McpServerConfig;
+
+export { CLAUDE_DIR, CLAUDE_MD_FILE, I18N, LANG_LABELS, MCP_CONFIG_FILE, MCP_SERVICES, SETTINGS_FILE, SUPPORTED_LANGS, backupExistingConfig, backupMcpConfig, buildMcpServerConfig, commandExists, configureApi, copyConfigFiles, ensureClaudeDir, getMcpConfigPath, getPlatform, init, installClaudeCode, isClaudeCodeInstalled, mergeConfigs, mergeMcpServers, readMcpConfig, writeMcpConfig };
+export type { ApiConfig, McpConfiguration, McpServerConfig, McpService, SupportedLang };

package/dist/index.mjs

@@ -0,0 +1,8 @@
+export { C as CLAUDE_DIR, a as CLAUDE_MD_FILE, I as I18N, L as LANG_LABELS, M as MCP_CONFIG_FILE, d as MCP_SERVICES, S as SETTINGS_FILE, b as SUPPORTED_LANGS, j as backupExistingConfig, o as backupMcpConfig, q as buildMcpServerConfig, c as commandExists, l as configureApi, k as copyConfigFiles, h as ensureClaudeDir, n as getMcpConfigPath, g as getPlatform, i as init, f as installClaudeCode, e as isClaudeCodeInstalled, m as mergeConfigs, p as mergeMcpServers, r as readMcpConfig, w as writeMcpConfig } from './shared/zcf.DMG6psxU.mjs';
+import '@posva/prompts';
+import 'ansis';
+import 'node:fs';
+import 'node:os';
+import 'pathe';
+import 'dayjs';
+import 'tinyexec';