01
INTERACTIVE

transx

打开交互界面,可翻译文本或文件。非交互环境输出帮助。

transx
TransX CLI 未配置状态
未配置
TransX CLI 已配置状态
已配置
02
COMMAND

transx help

显示命令、参数和示例。

transx help
参数无。也可以使用 transx --helptransx -h
03
COMMAND

transx init

设置 DLX API Key。前往 Linux.do Connect 获取。

transx init [--key-stdin]

专属参数

参数作用
--key-stdin从 stdin 读取 API Key;省略时隐藏输入

示例

transx init

自动化示例:printf '%s' "$DLX_API_KEY" | transx init --key-stdin

04
TRANSLATE

transx translate

翻译文本、stdin 或文件。Agent 调用使用 --json

transx translate [text | --file <path>] --to <lang> [options]

专属参数

参数作用默认值
[text]待翻译文本;省略时从 stdin 读取stdin
-t, --to <lang>目标语言,必填,例如 ZHEN
-s, --source <lang>源语言auto
-f, --file <path>翻译 txt/md/csv/log/docx/xlsx/pptx/pdf,与位置文本互斥
-o, --output <path>指定译文文件路径源文件目录
--json输出单行 JSON关闭
--timeout <seconds>仅设置本次请求的超时时间,必须为正数20
-h, --help显示 CLI 帮助

示例

transx translate "Hello world" --to ZH --json

stdin:echo "Hello world" | transx translate --to ZH --json

文件:transx translate --file ./paper.pdf --to ZH --json

输出:<源文件名>_<目标语言>;PDF 输出 DOCX。

限制:文件 20MB,可翻译文本 100000 字符,最多 500 次请求。

05
COMMAND

transx languages

显示 --source--to 支持的语言代码。

transx languages [--json]

专属参数

参数作用
--json输出适合程序读取的 JSON;省略时输出带中文名称的列表

语言范围

目标语言31 个代码
中文ZH 默认简体,ZH-HANT 繁体
源语言AUTO,以及全部目标代码
AR BG CS DA DE EL EN ES ET FI FR HU ID IT JA KO LT LV NB NL PL PT RO RU SK SL SV TR UK ZH ZH-HANT

DLX 接口支持 31 个目标语言代码。

JSON 示例

transx languages --json
06
COMMAND GROUP

transx history

查看、搜索或清理本地翻译历史。文件记录只保存源文件和译文文件信息。

transx history [list|search|status|clear|help]

transx history [list]

按时间倒序查看记录。省略 list 时行为相同,默认显示 20 条。

参数作用
--limit <n>本次返回条数,默认 20
--offset <n>跳过前 n 条,默认 0
--from <time>仅返回此时间及之后的记录
--to <time>仅返回此时间及之前的记录
--since <Nd>查看最近 N 天,例如 7d;不能与 --from 同用
--json输出适合程序读取的单行 JSON
transx history --limit 50 --offset 100 --json

transx history search <keyword>

不区分英文大小写。文本记录搜索原文和译文,文件记录搜索源文件名和译文文件名。支持与查看命令相同的 --limit--offset、时间范围和 --json 参数。

transx history search "环境审查" --limit 50 --json

transx history status [--json]

显示历史目录、记录数量、文件总量、最早和最新记录,以及是否需要清理。

transx history clear <mode>

参数作用
--oldest <n>删除最旧的 n 条
--keep <n>只保留最新的 n 条
--before <time>删除指定时间之前的记录
--older-than <Nd>删除早于最近 N 天的记录,例如 30d
--from <time> --to <time>删除指定时间范围内的记录,两项必须同时提供
--all删除全部记录
--yes跳过确认;非交互环境必须提供
--json以 JSON 返回删除条数
transx history clear --older-than 30d --yes

存储与时间

目录~/.transx/history/
文件index.jsonYYYY-MM-DD.json
提醒超过 30 天或 100 MB,每天最多一次

记录不限制条数,也不会自动删除。时间统一按中国时间处理,格式为 YYYY-MM-DD HH:mm:ss.SSS,不附带时区标记。运行 transx history help 可在终端查看此命令组帮助。

07
COMMAND GROUP

transx config

查看 URL 模板和完整 API Key,或维护本地配置。

transx config [set-key|reset]

transx config

参数无。输出 URL 模板、完整 API Key、初始化状态和配置文件路径。

transx config set-key [--stdin]

参数作用
--stdin从 stdin 读取新的 API Key;省略时隐藏输入

transx config reset <target>

参数作用
key删除本地 API Key
all重置全部配置(当前等同于删除 Key)

示例

transx config set-key --stdin

环境变量 DLX_API_KEY 会覆盖本地配置,但不会写入配置文件。

08
COMMAND

transx install

把当前包安装到用户目录并配置 PATH,支持 Windows、macOS 与 Linux。

transx install [--force]

专属参数

参数作用
--force覆盖用户目录中已存在的同版本安装

首次安装

npx @gushengcode/transx-cli@latest install

要求 Node.js > 22。安装完成后重新打开终端。

09
COMMAND

transx version

显示当前版本;--check 检查最新版。

transx version [--check]

专属参数

参数作用
--check查询 npm Registry 并比较最新版本
10
COMMAND

transx update

更新 TransX CLI。

transx update
参数无。执行前可先运行 transx version --check
11
OUTPUT

JSON 与错误码

translate --json:成功写入 stdout,失败写入 stderr。

SUCCESSEXIT 0
{
  "ok": true,
  "data": "你好,世界",
  "source_lang": "auto",
  "target_lang": "ZH",
  "provider": "dlx"
}
ERROREXIT ≠ 0
{
  "ok": false,
  "error": {
    "code": "CONFIG_NOT_INITIALIZED",
    "message": "缺少 DLX API Key,请先运行 transx init"
  }
}

错误码

code含义exit
INVALID_ARGUMENT参数错误2
CONFIG_NOT_INITIALIZED未初始化配置3
CONFIG_INVALID配置无效3
NETWORK_ERROR网络或超时4
API_HTTP_ERRORDLX 返回错误5
API_RESPONSE_INVALID响应格式无效6
FILE_READ_ERROR文件读取失败7
FILE_DEPENDENCY_MISSING文件依赖未安装7
FILE_FORMAT_UNSUPPORTED文件格式不支持7
FILE_TOO_LARGE文件或文本超限7
FILE_TEXT_EMPTY未提取到文本7
HISTORY_ERROR历史文件读取、写入或锁定失败7
INSTALL_ERROR安装失败5
UPDATE_ERROR更新失败5
CANCELLED用户取消130
已复制