alpenl-cli

一个基于 Gluegun 框架构建的现代化 TypeScript 命令行工具。

✨ 特性

• 🚀 基于 TypeScript 开发，类型安全
• 📦 模块化架构，易于扩展
• 🎨 支持模板代码生成
• 🔌 插件系统支持

📦 安装

全局安装（推荐）

# 使用 npm
npm install -g alpenl-cli

# 使用 yarn
yarn global add alpenl-cli

# 使用 pnpm
pnpm add -g alpenl-cli

验证安装

alpenl --version
alpenl --help

🚀 使用方法

基础命令

# 查看帮助
alpenl --help

# 查看版本
alpenl --version

# 打印消息
alpenl print

# 生成文件（使用模板）
alpenl generate <name>
# 或使用别名
alpenl g <name>

命令示例

# 生成一个模型文件
alpenl generate User
# 输出：生成文件：models/User-model.ts

# 使用别名
alpenl g Product

📚 文档

完整的开发指南和 API 文档请查看：

• 开发指南
• 命令参考
• 插件指南

🔌 插件开发

alpenl-cli 支持通过插件扩展功能。插件包名必须以 alpenl- 开头：

# 安装插件
npm install --save-dev alpenl-myplugin

# CLI 会自动加载和使用插件

更多信息请查看 插件开发指南。

🛠️ 开发

克隆仓库

git clone https://github.com/Alpenl/alpenl-cli.git
cd alpenl

安装依赖

yarn install
# 或
npm install

构建项目

yarn build

本地开发

# 直接运行命令
node bin/alpenl <command>

# 或链接到全局
yarn link
alpenl <command>

运行测试

# 运行所有测试
yarn test

# 监视模式
yarn watch

# 生成覆盖率报告
yarn coverage

📝 技术栈

• Gluegun - CLI 框架
• TypeScript - 类型安全
• Jest - 测试框架
• EJS - 模板引擎

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📄 许可证

MIT - 详见 LICENSE 文件

🔗 链接

• npm 包
• Gluegun 文档

提示: 这是一个命令行工具，请使用 npm install -g alpenl-cli 全局安装，而不是作为项目依赖安装。