@casatwy/deyo 0.1.0 → 0.1.3

package/README.md

@@ -1,8 +1,12 @@
 # deyo
 
-`@casatwy/deyo` installs the `deyo` command for sending transcription jobs to Deyo from your terminal.
+`deyo` 是 [https://deyo.miaobi.fun](https://deyo.miaobi.fun) 的命令行工具。你可以直接在终端里提交音视频链接进行转写，并把结果输出到终端或保存到本地文件。
 
-## Install
+当前支持的来源包括小宇宙单集、B 站单视频和 YouTube 单视频。
+
+## 安装
+
+安装前请确认本机 Node.js 版本不低于 `18`。
 
 ```bash
 npm install -g @casatwy/deyo
@@ -12,89 +16,150 @@ npm install -g @casatwy/deyo
 pnpm add -g @casatwy/deyo
 ```
 
-## First-time login
+安装完成后，可以先执行下面的命令确认 CLI 已可用：
+
+```bash
+deyo --help
+```
+
+## 使用前准备
+
+在使用 CLI 之前，你需要先创建一个 Deyo API Key：
+
+1. 打开 `https://deyo.miaobi.fun/me/api-keys`
+2. 创建一个新的 API Key
+3. 复制这个 Key，后面登录 CLI 时会用到
+
+`deyo` 默认连接正式服务 `https://deyo.miaobi.fun`，普通用户不需要额外配置服务地址。
+
+## 首次登录
 
-Create a Deyo API key from `https://deyo.miaobi.fun/me/api-keys`, then save it once locally:
+把 API Key 保存到本地后，后续就不需要每次转写时都重复传 `--api-key`。
 
 ```bash
 deyo auth login --api-key 'deyo_sk_xxx'
 ```
 
-Check whether the local config is active:
+查看当前本地登录状态：
 
 ```bash
 deyo auth status
 ```
 
-Remove the saved local config:
+如果你想清除本地保存的配置：
 
 ```bash
 deyo auth logout
 ```
 
-## Usage
+## 快速开始
 
-The published CLI defaults to the production service at `https://deyo.miaobi.fun`.
+最简单的用法是直接给 `deyo` 一个链接：
 
-After `deyo auth login`, you can run transcription commands without repeating `--api-key`:
+```bash
+deyo 'https://www.youtube.com/watch?v=xxxx'
+```
+
+这条命令会：
+
+1. 使用你本地已保存的 API Key
+2. 提交一个转写任务
+3. 在终端里持续显示任务进度
+4. 完成后直接把结果输出到终端
+
+如果你希望把结果保存到文件：
 
 ```bash
-deyo --language zh -O ./transcript.txt 'https://www.bilibili.com/video/BVxxxx'
+deyo -O ./transcript.txt 'https://www.bilibili.com/video/BVxxxx'
 ```
 
+## 常见用法
+
+处理小宇宙单集并保存为文本：
+
 ```bash
-deyo --language zh --format srt -O ./transcript.srt 'https://www.youtube.com/watch?v=xxxx'
+deyo -O ./episode.txt 'https://www.xiaoyuzhoufm.com/episode/xxxx'
 ```
 
+保存为普通文本：
+
 ```bash
-deyo --language en 'https://www.youtube.com/watch?v=xxxx'
+deyo -O ./transcript.txt 'https://www.bilibili.com/video/BVxxxx'
 ```
 
-If you need local development, pass `--base-url` explicitly:
+导出为 `srt` 字幕文件：
 
 ```bash
-deyo auth login --api-key 'deyo_sk_xxx' --base-url 'http://deyo.mac-studio'
-deyo --base-url 'http://deyo.mac-studio' --language zh -O ./transcript.txt 'https://www.bilibili.com/video/BVxxxx'
+deyo --format srt -O ./transcript.srt 'https://www.youtube.com/watch?v=xxxx'
 ```
 
-For a one-off override, `--api-key` still takes precedence over local config:
+如果输出文件名本身就是 `.srt`，也可以省略 `--format srt`，CLI 会自动识别格式。
+
+指定输出英文转写结果：
 
 ```bash
-deyo --api-key 'deyo_sk_other' --language zh 'https://www.youtube.com/watch?v=xxxx'
+deyo --language en 'https://www.youtube.com/watch?v=xxxx'
 ```
 
-By default, the CLI requests Chinese output, which is equivalent to `--language zh`.
+如果某一次命令想临时使用另一个 API Key，可以直接显式传入：
 
-Run `deyo --help` to see the full argument list.
+```bash
+deyo --api-key 'deyo_sk_other' 'https://www.youtube.com/watch?v=xxxx'
+```
 
-## Install in AI tools
+## 常用参数
 
-The official install pages live at:
+`--language <value>`
 
-- Codex: `https://deyo.miaobi.fun/ai/install/codex`
-- Claude: `https://deyo.miaobi.fun/ai/install/claude`
+指定转写语言。默认是 `zh`，也就是中文输出。也可以写 `en`，英文输出。
 
-These pages tell the AI how to install the `deyo` skill or plugin, ask for the user's API key once, and run `deyo auth login` locally.
+`-O, --output <path>`
 
-## Publish
+把结果写入文件。如果不传这个参数，结果会直接打印到终端。
 
-For maintainers, publish from the `cli_` directory:
+`--format <value>`
 
-```bash
-cd cli_
-make deploy
-```
+指定结果格式，支持：
 
-If you need to publish a new version, pass it explicitly:
+- `text`
+- `srt`
+- `vtt`
 
-```bash
-cd cli_
-make deploy VERSION=0.1.1
-```
+如果你已经通过 `-O` 指定了输出文件名，CLI 会根据扩展名自动推断常见格式：
+
+- `.srt` 会自动使用 `srt`
+- `.vtt` 会自动使用 `vtt`
+- 其他情况默认使用 `text`
+
+`--api-key <key>`
+
+为当前这一次命令临时指定 API Key。  
+如果你已经执行过 `deyo auth login`，平时通常不需要再传。  
+当它和本地已保存配置同时存在时，会优先使用这次命令里传入的 `--api-key`。
+
+`-v, --version`
+
+打印当前 CLI 版本号并退出，适合快速确认本机装的是哪个版本。
+
+## 在 AI 工具中使用
+
+如果你希望让 AI 助手在你的本机环境里调用 `deyo`，可以参考官方安装页：
+
+- Codex：[https://deyo.miaobi.fun/ai/install/codex](https://deyo.miaobi.fun/ai/install/codex)
+- Claude：[https://deyo.miaobi.fun/ai/install/claude](https://deyo.miaobi.fun/ai/install/claude)
+
+这些页面面向普通用户，主要会指导 AI：
+
+1. 如何安装 `deyo` 的技能或插件
+2. 如何向你索取一次 API Key
+3. 如何在你的本地环境执行 `deyo auth login`
+
+完成后，你就可以让 AI 直接帮你调用 `deyo` 提交转写任务。
+
+## 更多帮助
 
-With npm 2FA enabled, pass the current OTP code explicitly:
+查看完整参数说明：
 
 ```bash
-cd cli_
-make deploy OTP=123456
+deyo --help
 ```

package/deyo.mjs

@@ -1,10 +1,13 @@
 #!/usr/bin/env node
 
 import { chmod, mkdir, readFile, rm, writeFile } from 'node:fs/promises'
+import { createRequire } from 'node:module'
 import { dirname, extname, resolve } from 'node:path'
 import { homedir } from 'node:os'
 import process from 'node:process'
 
+const CLI_VERSION = createRequire(import.meta.url)('./package.json').version
+
 const DEFAULT_BASE_URL = 'https://deyo.miaobi.fun'
 const DEFAULT_LANGUAGE = 'zh'
 const POLL_INTERVAL_MS = 1500
@@ -37,6 +40,7 @@ function printUsage() {
   --format <value>      可选，text | srt | vtt | json | verbose_json
   --base-url <url>      可选，默认 ${DEFAULT_BASE_URL}
   -h, --help            显示帮助
+  -v, --version         显示 CLI 版本
 
 auth 子命令:
   deyo auth login --api-key <key> [--base-url <url>]
@@ -825,6 +829,11 @@ async function main() {
   const argv = process.argv.slice(2)
   const primaryCommand = argv[0]
 
+  if (primaryCommand === '-v' || primaryCommand === '--version') {
+    process.stdout.write(`${CLI_VERSION}\n`)
+    return
+  }
+
   if (!primaryCommand || primaryCommand === '-h' || primaryCommand === '--help') {
     printUsage()
     return

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casatwy/deyo",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "CLI for submitting Deyo transcription jobs from the terminal",
   "homepage": "https://deyo.miaobi.fun/docs",
   "license": "UNLICENSED",