claude-init-cli
v1.0.0
Published
CLI tool to initialize claude-code-spec-workflow
Maintainers
Readme
claude-init-cli
一个用于快速初始化 claude-code-spec-workflow 系统的 CLI 工具。
这个工具自动化了安装和设置过程,让您能够在几秒钟内开始使用 Claude Code Spec Workflow。
特性
- 🚀 一键初始化:使用单个命令完成完整工作流的设置
- 📦 灵活安装:支持全局和本地安装选项
- 🔍 智能验证:自动检查 Node.js 版本和系统要求
- 🎨 用户友好:彩色输出和进度指示器,提升用户体验
- ⚡ 节省时间:跳过手动步骤,将设置时间从几分钟缩短到几秒钟
- 🛡️ 安全可靠:检查现有安装,防止意外覆盖
前提条件
- Node.js:版本 16.0.0 或更高
- npm:Node 包管理器(通常随 Node.js 一起安装)
- Claude Code:您需要已经安装并配置了 Claude Code
安装
全局安装(推荐)
全局安装后可以从任何目录使用该命令:
npm install -g claude-init-cli本地安装
作为项目依赖安装:
npm install claude-init-cli --save-dev使用 npx(无需安装)
无需安装即可直接运行:
npx claude-init-cli使用方法
基本初始化
在当前目录初始化工作流:
claude-init在指定目录初始化
指定一个目录来初始化工作流:
claude-init --project /path/to/your/project强制覆盖现有文件
如果已存在 .claude 目录,使用此选项强制覆盖:
claude-init --force跳过依赖安装
如果已经安装了 claude-code-spec-workflow,可以跳过安装步骤:
claude-init --skip-install显示帮助信息
显示帮助信息:
claude-init --help显示版本
显示当前版本:
claude-init --version工作流程
当您运行 claude-init 时,该工具将:
- 检查 Node.js 版本:确保您使用的是 Node.js 16.0.0 或更高版本
- 验证目录:检查目标目录是否存在且有效
- 安装依赖:安装 claude-code-spec-workflow 包
- 运行初始化:执行官方工作流初始化
- 验证结果:验证 .claude 目录是否成功创建
- 显示下一步:提供后续操作指南
输出结构
成功初始化后,您将在项目中找到一个 .claude 目录,其结构如下:
.claude/
├── commands/ # Claude Code 的斜杠命令
├── steering/ # 项目上下文和指南
├── templates/ # 文档模板
├── specs/ # 生成的规格文档
├── bugs/ # 缺陷跟踪文档
└── agents/ # 可选的代理配置配置
命令行选项
| 选项 | 别名 | 描述 |
| ------------------ | ---- | ----------------------- |
| --project <path> | -p | 指定项目目录 |
| --force | -f | 覆盖现有的 .claude 目录 |
| --skip-install | -s | 跳过依赖安装 |
| --help | -h | 显示帮助信息 |
| --version | -v | 显示版本号 |
故障排除
Node.js 版本错误
如果您看到关于 Node.js 版本的错误,请将 Node.js 升级到 16.0.0 或更高版本:
# 使用 nvm(推荐)
nvm install 16
nvm use 16
# 或者从 nodejs.org 下载权限被拒绝
在 Linux/macOS 上,您可能需要使用 sudo 进行全局安装:
sudo npm install -g claude-init-cli在 Windows 上,请以管理员身份运行命令提示符。
网络问题
如果由于网络问题导致安装失败,请检查您的互联网连接或使用代理:
npm config set proxy http://proxy.example.com:8080现有安装
如果您已经有一个 .claude 目录,请使用 --force 选项覆盖它:
claude-init --force示例
示例 1:基本用法
# 创建一个新目录并初始化
mkdir my-new-project
cd my-new-project
claude-init示例 2:在指定目录初始化
# 在现有目录中初始化
claude-init --project ~/projects/my-existing-project示例 3:强制覆盖
# 覆盖现有的 .claude 目录
claude-init --force示例 4:使用 npx 运行
# 无需安装直接运行
npx claude-init-cli --project ./my-project贡献
欢迎贡献!请随时提交问题和拉取请求。
开发设置
# 克隆仓库
git clone <repository-url>
cd claude-init-cli
# 安装依赖
npm install
# 本地运行 CLI
node bin/claude-init.js
# 运行测试
npm test
# 代码检查
npm run lint许可证
MIT 许可证 - 详见 LICENSE 文件
相关项目
- claude-code-spec-workflow - 此工具初始化的工作流系统
- Claude Code - Anthropic 的 AI 编码助手
支持
如果您遇到任何问题或有疑问,请在 GitHub 仓库中创建一个 issue。
更新日志
v1.0.0
- 初始版本发布
- 基本初始化功能
- 支持全局和本地安装
- 跨平台兼容性
