feihuo-cli 0.0.1

package/README.md

@@ -0,0 +1,118 @@
+# feihuo-cli
+
+飞伙 CLI，用于在命令行中搜索航班。
+
+## 安装
+
+```bash
+npm install -g feihuo-cli
+```
+
+安装后会获得 `feihuo` 命令：
+
+```bash
+feihuo --help
+```
+
+## 配置 API Key
+
+首次使用前需要配置 API Key：
+
+```bash
+feihuo config set api-key xxxxxx
+```
+
+配置会保存到当前用户目录：
+
+```text
+~/.config/feihuo/config.json
+```
+
+后续请求会自动读取配置，并通过 `Authorization: Bearer <api-key>` 访问服务。
+
+## 搜索航班
+
+```bash
+feihuo search-flight --dep "上海" --arr "东京" --dep-date 2026-03-20
+```
+
+往返搜索：
+
+```bash
+feihuo search-flight --dep "上海" --arr "东京" --dep-date 2026-03-20 --back-date 2026-03-25
+```
+
+指定舱位：
+
+```bash
+feihuo search-flight --dep "上海" --arr "东京" --dep-date 2026-03-20 --berth-type Y
+```
+
+完整示例：
+
+```bash
+feihuo search-flight --dep "上海" --arr "东京" --dep-date 2026-03-20 --back-date 2026-03-25 --berth-type Y
+```
+
+## 参数说明
+
+### search-flight
+
+| 参数 | 必填 | 说明 |
+| --- | --- | --- |
+| `--dep <dep>` | 是 | 出发地，例如：`上海` |
+| `--arr <arr>` | 是 | 到达地，例如：`东京` |
+| `--dep-date <depDate>` | 是 | 出发日期，格式：`YYYY-MM-DD` |
+| `--back-date <backDate>` | 否 | 返程日期，格式：`YYYY-MM-DD` |
+| `--berth-type <berthType>` | 否 | 舱位等级：`Y` 经济舱，`C` 公务舱，`F` 头等舱 |
+
+## 查看帮助
+
+```bash
+feihuo --help
+feihuo search-flight --help
+feihuo config --help
+```
+
+## 本地开发
+
+安装依赖：
+
+```bash
+npm install
+```
+
+生成 API 客户端：
+
+```bash
+npm run nswag
+```
+
+构建 CLI：
+
+```bash
+npm run build
+```
+
+本地运行：
+
+```bash
+node dist/index.js --help
+node dist/index.js search-flight --dep "上海" --arr "东京" --dep-date 2026-03-20
+```
+
+## 发布
+
+发布前请确认已登录 npm：
+
+```bash
+npm login
+```
+
+发布：
+
+```bash
+npm publish
+```
+
+`npm publish` 前会自动执行构建，最终发布的包只包含 `dist` 和本文档。npmjs 页面会自动显示本 `README.md`。