lrk-hello-cli
v1.0.1
Published
一个用于学习 npm 包生命周期的 CLI 示例项目
Readme
lrk-hello-cli
一个用于学习 npm 包完整生命周期的 CLI 示例项目。
功能特性
- 🎉 greet - 向用户打招呼，支持自定义颜色和大小写
- ℹ️ info - 显示系统和包信息
- 📝 create - 创建示例文件（支持 txt、json、md 格式）
- 📂 list - 列出目录中的文件
安装
全局安装
npm install -g lrk-hello-cli本地测试
# 克隆项目
git clone <repository-url>
cd lrk-hello-cli
# 安装依赖
npm install
# 链接到全局
npm link
# 现在可以使用 hello-cli 命令了
hello-cli --version查看已链接的本地包
# 查看全局已链接的包
npm ls -g --depth=0 --link取消本地链接
# 取消全局链接
npm unlink -g lrk-hello-cli
# 或者先进入项目目录
npm unlink使用方法
查看版本
hello-cli --version查看帮助
hello-cli --help命令详解
1. greet - 打招呼
# 基本用法
hello-cli greet
# 指定名字
hello-cli greet 小明
# 大写输出
hello-cli greet 小明 --uppercase
# 指定颜色（支持 red, green, yellow, blue, magenta, cyan）
hello-cli greet 小明 --color blue
hello-cli greet 小明 -c red2. info - 系统信息
hello-cli info输出示例：
=== 系统信息 ===
Node.js 版本: v18.12.1
平台: darwin
架构: arm64
=== 包信息 ===
包名: lrk-hello-cli
版本: 1.0.0
描述: 一个用于学习 npm 包生命周期的 CLI 示例项目
作者: Your Name
许可证: MIT3. create - 创建文件
# 创建文本文件（默认）
hello-cli create myfile
# 创建 JSON 文件
hello-cli create myfile --template json
hello-cli create myfile -t json
# 创建 Markdown 文件
hello-cli create myfile --template md4. list - 列出文件
# 列出当前目录
hello-cli list
# 列出指定目录
hello-cli list /path/to/dir
# 显示隐藏文件
hello-cli list --all
hello-cli list -a发布到 npm
1. 准备工作
确保你有一个 npm 账号：
npm adduser
# 或登录已有账号
npm login2. 检查包配置
# 检查包信息
npm pack
# 查看将被发布的文件
npm publish --dry-run3. 发布
# 发布公开包
npm publish --access public
# 如果包名已被占用，可以使用作用域
npm publish --access public --scope=@yourname4. 更新版本
# 补丁版本 (1.0.0 -> 1.0.1)
npm version patch
# 次要版本 (1.0.0 -> 1.1.0)
npm version minor
# 主要版本 (1.0.0 -> 2.0.0)
npm version major
# 发布后记得推送标签
git push --tags卸载
全局卸载
npm uninstall -g lrk-hello-cli验证卸载
# 检查命令是否还存在
hello-cli --version # 应该显示 command not found项目结构
lrk-hello-cli/
├── bin/
│ └── cli.js # CLI 入口文件
├── package.json # 包配置
├── README.md # 项目文档
└── .gitignore # Git 忽略配置依赖说明
许可证
MIT