aigcode-comp-cli
v1.0.5
Published
一个用于快速安装组件和生成配置文件的命令行工具,适用于组件库的初始化和使用。
Readme
aigcode-comp-cli
一个用于快速安装组件和生成配置文件的命令行工具,适用于组件库的初始化和使用。
🚀 快速开始
无需安装,推荐直接使用 npx:
# 安装组件
npx aigcode-comp-cli add Button Input
# 添加配置文件
npx aigcode-comp-cli add-config
# 克隆组件库
npx aigcode-comp-cli clone🧩 支持的命令
add [components...]
安装一个或多个组件。
语法:
npx aigcode-comp-cli add [组件名1] [组件名2] ...可选参数:
-p, --path <path>:自定义安装路径(默认路径会根据实现自行决定)-a, --all:安装所有支持的组件
示例:
# 安装 Button 和 Input 组件
npx aigcode-comp-cli add Button Input
# 安装全部组件
npx aigcode-comp-cli add --all
# 安装组件并指定目录
npx aigcode-comp-cli add Button -p ./src/componentsadd-config
添加一份配置文件模板到项目中,建议在首次使用时执行:
npx aigcode-comp-cli add-configclone [repository]
克隆指定的git仓库,默认克隆aigcode-comps-storybook组件库。
语法:
npx aigcode-comp-cli clone [仓库地址]可选参数:
-p, --path <path>:指定克隆目标路径(默认为当前目录)
示例:
# 克隆默认组件库
npx aigcode-comp-cli clone
# 克隆指定仓库到特定目录
npx aigcode-comp-cli clone username/repo -p ./my-components📁 项目结构(简要)
aigcode-comp-cli/
├── bin/
│ └── index.js # CLI 命令入口
├── src/
│ ├── install.js # 组件安装逻辑
│ ├── config.js # 配置文件写入逻辑
│ └── clone.js # 仓库克隆逻辑
├── package.json
└── README.md🧪 本地开发调试(可选)
# 将本地 CLI 链接到全局,便于开发调试
npm link
# 然后像全局命令一样使用
aigcode-comp-cli add Button📄 License
MIT © 2025 aigcode.com
