hicli 命令参考

HiCLI 提供了一套完整的命令行工具，用于管理 HiTerm PC 端的所有功能。

安装 HiCLI

系统要求

  • Linux: Ubuntu, Debian, CentOS, Fedora, Arch Linux 等
  • macOS: 10.15 (Catalina) 或更高版本
  • Windows: ⚠️ 仅支持 WSL2 (Windows Subsystem for Linux 2)

⚠️ 前置依赖：Tailscale

Tailscale 是 HiTerm 的核心网络依赖，必须先安装！

# Linux/macOS 一键安装 Tailscale
curl -fsSL https://tailscale.com/install.sh | sh
sudo tailscale up

安装 HiCLI

curl -fsSL https://www.yinbin.ink/install.sh | bash

快速开始

对于新用户，推荐运行以下命令完成初始化：

hicli setup    # 完成首次初始化（推荐）

命令列表

setup - 首次初始化

完成 HiTerm PC 端的完整初始化设置。

使用方法：

hicli setup [--force]

参数说明：

  • -f, --force - 强制重新执行所有步骤（忽略已有配置）

执行步骤：

  1. 环境检查（Tailscale、sudo 权限）
  2. OAuth 登录
  3. 上报设备信息到云端
  4. 安装 mosh（弱网 SSH 服务端）
  5. 安装系统服务（开机自启）
  6. 配置通知（AI 工具推送）

示例：

hicli setup           # 标准初始化
hicli setup --force   # 强制重新初始化

login - 登录

通过 OAuth 登录 HiTerm 账号。

使用方法：

hicli login

功能说明：

  • 启动 OAuth 登录流程
  • 获取并保存认证 Token
  • 查询订阅状态
  • 在浏览器中显示二维码供移动端扫描

示例：

hicli login

logout - 注销

注销当前用户的登录状态。

使用方法：

hicli logout

功能说明：

  • 清除本地存储的认证 Token
  • 清除云端设备信息
  • 停止后台守护进程

示例：

hicli logout

status - 查看状态

显示 hicli 当前运行状态。

使用方法：

hicli status

显示内容：

  • 认证状态和用户信息
  • 心跳上报状态
  • mosh 安装状态
  • 系统服务状态
  • 通知服务状态

示例：

hicli status

doctor - 诊断问题

运行诊断检查，发现并修复常见的配置问题。

使用方法：

hicli doctor [--fix]

参数说明：

  • --fix - 自动修复发现的问题

检查项目：

  • Tailscale 安装和运行状态
  • 配置文件完整性和权限
  • 系统服务状态
  • mosh 安装状态

示例：

hicli doctor          # 仅检查问题
hicli doctor --fix    # 检查并自动修复

restart - 重启服务

重启 hicli 后台守护进程。

使用方法：

hicli restart

功能说明：

  • 重启系统服务（systemd/launchd）
  • 立即启动心跳和通知功能

示例：

hicli restart

version - 版本信息

显示 hicli 的版本信息。

使用方法：

hicli version [--verbose]

参数说明：

  • -v, --verbose - 显示详细的版本信息（提交哈希和构建时间）

示例：

hicli version          # 显示简洁版本信息
hicli version -v       # 显示详细版本信息

update - 更新

检查并更新 hicli 到最新版本。

使用方法：

hicli update [OPTIONS]

参数说明：

  • --check - 仅检查是否有新版本
  • --version <版本> - 指定要安装的版本
  • --skip-verify - 跳过 SHA256 校验
  • --source <源> - 下载源（hicloud 或 github，默认：hicloud）

示例：

hicli update                    # 更新到最新版本
hicli update --check            # 仅检查更新
hicli update --source github   # 从 GitHub 下载

uninstall - 卸载

完全卸载 hicli。

使用方法：

hicli uninstall

功能说明：

  • 停止所有服务
  • 清除配置文件
  • 删除系统服务配置
  • 清理通知钩子

注意： 此操作不可撤销，请谨慎使用。

示例：

hicli uninstall

notify - 通知管理

管理 hicli 的通知功能。

notify on - 启用通知

启用 hicli 的通知功能。

使用方法：

hicli notify on

功能说明：

  • 接收云端推送的通知
  • 在本地显示桌面通知
  • 处理 AI 工具的钩子事件
  • 自动安装 AI 工具的钩子

示例：

hicli notify on

notify off - 禁用通知

禁用 hicli 的通知功能。

使用方法：

hicli notify off

功能说明：

  • 不再显示通知
  • 移除 AI 工具的钩子

示例：

hicli notify off

notify status - 查看通知状态

显示通知功能的当前状态。

使用方法：

hicli notify status

显示内容：

  • 通知开关状态
  • 本地通知可用性
  • 云端推送连接状态
  • 已安装的钩子列表

示例：

hicli notify status

notify test - 测试通知

发送测试通知以验证通知功能是否正常工作。

使用方法：

hicli notify test [OPTIONS]

参数说明：

  • --title <标题> - 通知标题（默认："HiTerm 测试通知"）
  • --message <内容> - 通知内容（默认："这是一条测试通知消息"）
  • --local - 仅测试本地通知
  • --cloud - 仅测试云端推送

示例：

hicli notify test                              # 测试本地和云端
hicli notify test --local                      # 仅测试本地通知
hicli notify test --title="自定义标题" --message="自定义内容"

notify alerts - 管理告警事件

管理通知监听的告警事件类型。

使用方法：

hicli notify alerts [事件类型] [--list]

参数说明：

  • --list - 列出所有可用的事件类型

可用的事件类型：

  • idle_prompt - 任务空闲等待输入
  • permission_prompt - 权限请求提示
  • stop - 任务停止
  • notification - 通知事件

示例：

hicli notify alerts                    # 显示当前配置
hicli notify alerts --list             # 列出所有可用事件
hicli notify alerts idle_prompt stop   # 设置监听的事件类型

notify hook - 管理钩子

管理 AI 工具的通知钩子集成。

子命令：

  • install [工具] - 安装钩子到指定工具
  • uninstall [工具] - 从指定工具移除钩子
  • list - 列出钩子状态

参数说明：

  • --tool <工具> - 工具名称（claude/codex/gemini）
  • --event <事件> - 事件类型（stop/notification）

示例：

hicli notify hook install              # 安装到所有工具
hicli notify hook install claude       # 仅安装到 Claude Code
hicli notify hook uninstall            # 从所有工具移除
hicli notify hook list                 # 列出钩子状态

notify repair - 修复钩子

修复 AI 工具通知钩子的路径问题。

使用方法：

hicli notify repair

功能说明：

  • 当 hicli 二进制文件位置变更后，钩子配置中的路径可能失效
  • 此命令会重新安装所有钩子，使用当前的 hicli 路径

示例：

hicli notify repair

daemon - 后台守护进程（隐藏）

启动 hicli 后台守护进程。

注意： 此命令由 systemd/launchd 自动调用，用户无需手动执行。

功能说明：

  • 定时心跳上报（每 5 分钟）
  • IP 自动同步到云端
  • SSH 公钥接收服务（需要认证）

通用选项

所有命令都支持以下选项：

-v, --verbose    # 显示详细输出
-h, --help       # 显示帮助信息
--version        # 显示版本信息

配置文件

hicli 的配置文件位置：

  • Linux/macOS: ~/.hiterm/config.json
  • Windows (WSL): ~/.hiterm/config.json

配置文件包含：

  • 认证信息（Token）
  • 用户信息
  • 订阅状态
  • 设备信息
  • 通知配置
  • 心跳配置

常见问题

如何查看当前状态？

hicli status

如何重启服务？

hicli restart

如何更新 hicli？

hicli update

如何卸载？

hicli uninstall

如何测试通知功能？

hicli notify test

如何修复配置问题？

hicli doctor --fix

提示： 使用 hicli <command> --help 查看每个命令的详细帮助信息。

在 GitHub 上编辑此页