命令行参考

TranNAP 客户端是一个独立的二进制程序，文件名为 trannap（在 Windows 上为 trannap.exe）。它的命令行界面（CLI）基于 Cobra 构建。本页介绍每一个命令及其参数。

在 Windows 上以 trannap.exe 运行该程序；在 macOS 和 Linux 上为 ./trannap（需先执行 chmod +x）。为简洁起见，下文示例统一使用 trannap。

总览 

trannap [command]

不带子命令运行 trannap（或运行 trannap help）会打印可用命令列表：

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  install     Install TranNAP as a system service
  restart     Restart TranNAP service
  run         Run the TranNAP client in the foreground
  start       Start TranNAP service
  status      Check TranNAP service status
  stop        Stop TranNAP service
  uninstall   Uninstall TranNAP
  update      Update TranNAP to the latest version
  version     Print version info

Flags:
  -h, --help   help for trannap

任何时候想查看某个命令的帮助，都可以追加 --help，例如 trannap run --help。

命令详解

run — 前台运行 

trannap run [flags]

在当前终端中启动 TranNAP 客户端，并持续运行直到你手动停止（Ctrl+C）。这是使用 TranNAP 最直接的方式，适合测试或交由你自己的进程管理器托管。

参数说明
--device-token string用于身份认证的 Device Token，连接账号时必填。
-h, --help显示 run 的帮助信息。

示例：

trannap run --device-token=YOUR_DEVICE_TOKEN

install — 安装为系统服务 

trannap install [flags]

将 TranNAP 注册为系统服务（Windows 服务 / systemd 单元），以便开机自启并在后台持续运行。这是在生产环境运行 TranNAP 的推荐方式，详见 让 TranNAP 持续运行 。

install 成功后服务会自动启动，因此通常无需再手动执行 trannap start。
参数说明
--device-token string用于身份认证的 Device Token，必填，以便安装后的服务每次启动都能完成认证。
-h, --help显示 install 的帮助信息。

示例：

trannap install --device-token=YOUR_DEVICE_TOKEN

start — 启动服务 

trannap start [flags]

启动之前通过 install 安装好的 TranNAP 服务，不会重新安装。

参数说明
-h, --help显示 start 的帮助信息。

stop — 停止服务 

trannap stop [flags]

停止正在运行的 TranNAP 服务。

参数说明
-h, --help显示 stop 的帮助信息。

restart — 重启服务 

trannap restart [flags]

一步完成「停止再启动」TranNAP 服务（例如修改配置后使其生效）。

参数说明
-h, --help显示 restart 的帮助信息。

status — 查看服务状态 

trannap status [flags]

报告 TranNAP 服务是否已安装以及当前的运行状态。

参数说明
-h, --help显示 status 的帮助信息。

uninstall — 卸载 

trannap uninstall [flags]

移除由 install 创建的 TranNAP 系统服务。卸载成功时，trannap 二进制文件本身也会被一并删除。

参数说明
-h, --help显示 uninstall 的帮助信息。

update — 更新 TranNAP 

trannap update [flags]

将 TranNAP 二进制更新到最新版本。也可以仅检查新版本，或切换到 / 回滚到特定版本。

参数说明
--check仅检查更新，不下载也不应用。
--rollback回滚到上一个已安装的版本。
--version string切换到指定版本，而非最新版。
-h, --help显示 update 的帮助信息。

示例：

trannap update            # 更新到最新版本
trannap update --check    # 仅检查是否存在更新的版本
trannap update --version v1.2.3   # 切换到指定版本
trannap update --rollback # 回滚到上一个版本

version — 打印版本信息 

trannap version [flags]

打印当前二进制文件的版本信息。

参数说明
--short仅打印版本号（不含其它细节）。
-h, --help显示 version 的帮助信息。

completion — 命令行补全 

trannap completion [command]

为你的 Shell 生成自动补全脚本，从而可以用 Tab 键补全 trannap 的命令和参数。支持的 Shell：

  • trannap completion bash
  • trannap completion fish
  • trannap completion powershell
  • trannap completion zsh

使用 trannap completion [shell] --help 查看如何将生成的脚本加载到对应 Shell 中。

help — 查看任意命令的帮助 

trannap help [command]

显示 trannap 自身或某个具体子命令的帮助，等价于给命令追加 --help。

典型工作流

  1. trannap install --device-token=YOUR_DEVICE_TOKEN —— 安装并作为服务运行（会自动启动，无需手动 start）。
  2. trannap status —— 确认服务正在运行。
  3. trannap restart —— 修改配置后使其生效。
  4. trannap update —— 保持二进制为最新版本。
  5. trannap uninstall —— 不再需要时移除服务及二进制文件本身。

如需图文并茂的引导式说明，请参阅 快速上手 与 让 TranNAP 持续运行 。

快速上手

一个简单的示例，帮助你快速启动本地服务。

让 TranNAP 持续运行

让 TranNAP 不间断地连接你的内网。