文档阅读指引

版本发布记录

Wuji CLI 各版本更新内容与变更说明

产品介绍

Wuji CLI 的定位、命令一览与设计理念

• 命令一览
  全部命令与作用速查
• 设计理念
  无状态、占用只读降级与可脚本化退出码
• 输出模式
  --json 与 --jsonl 结构化输出的适用场景

快速开始

安装与更新 CLI、验证设备连接与配置 shell 补全

• 前置条件
  确认系统版本与设备连接方式
• 安装
  用安装脚本或二进制文件安装 CLI
• 验证
  运行 wuji devices 确认能发现设备
• 更新 CLI
  用 wuji update 自更新，被动检查可关闭
• 配置 shell 补全（可选）
  生成 bash 等 shell 的自动补全脚本
• 安装 AI skills（可选）
  为 AI 编程助手安装 Wuji CLI skills

设备管理

扫描设备、探测连通性与指定目标设备

• 扫描设备
  列出 USB 和 UDP 总线上的全部设备
• 探测连通性
  握手确认设备可用并报告固件版本
• 指定目标设备
  按序列号、地址或手性选择设备
• 设备被占用时的行为
  了解只读回退与写操作限制
• 常见提示与处理
  速查常见提示消息的含义与处理

参数读写

发现设备资源，读取与写入参数

• 发现资源
  列出设备的可读写参数与可订阅 topic
• 读取参数
  用 get 读取参数并自动解码为 JSON
• 写入参数
  用 set 写入 JSON 值或十六进制字节
• 注意事项
  网络参数生效时机与虚拟参数行为

用户与标定数据

Profile 为什么与标定相关、管理 Profile、在机器间迁移标定、脚本化与退出码

• Profile 为什么与标定相关
  IK 手部模型标定会写入按 Profile 隔离的 URDF。默认用户无法执行 IK 标定，需先新建并切换到命名 Profile。触觉标定按设备归属，不受此限制。
• 管理 Profile
  用户名为 1–32 个字母/数字/下划线/连字符，且不得以连字符开头。list 用 * 标记当前 Profile，把 Default 标为「不可标定」，并显示各命名 Profile 的左右手标定状态。show 列出左右手 IK 模型（状态/文件/大小/时间）与按设备 SN 分组的触觉模型。
• 在机器间迁移标定
  标定数据——按 Profile 隔离的手部模型 URDF，加上每只手套的触觉模型、触觉参数与最近一次完整触觉 run——打包为单个 .zip。
• 脚本化与退出码
  --json 每条命令输出一个文档，错误输出 {"error":{"code":…,"message":…}}。由于 import/delete 在无终端时无法交互，非交互场景需加 --yes（或 --preview）。退出码细分：

IK 标定

用法、标定结果、脚本化与退出码

• 用法
  标定过程展示当前用户、连接状态、姿势进度与稳定性诊断，跟随提示完成各动作。按 Ctrl+C 随时取消，设备连接会安全释放。
• 标定结果
  成功后展示本次标定手别对应产物（left_hand.urdf 或 right_hand.urdf）的路径、大小与时间摘要。产物写入当前 Profile，用 wuji user show 查看完整标定状态，用 wuji user export 在机器间迁移。
• 脚本化与退出码
  --json 输出最终结果文档，--jsonl 流式输出带版本号的 progress / result / error / cancelled 事件。

数据订阅

订阅实时数据流并采集到文件

• 订阅 topic
  订阅实时数据并控制接收帧数
• 采集数据到文件
  用 --jsonl 配合管道轻量录制数据

触觉标定

用法、选项、中止与退出码、标定报告、标定后验证

• 用法
  序列号用 wuji devices 查询。命令连接手套后依次引导 4 个采集动作：
• 选项
• 中止与退出码
• 标定报告
  标定完成后输出结果报告，加 --json 得到结构化输出：
• 标定后验证

健康诊断

逐项检查设备，定位 EMF 断线与触觉坏点故障

• 检测范围
  了解支持的设备与故障类型
• 用法
  诊断全部或指定设备的常用命令
• 读懂报告
  理解状态标记、修复建议与退出码
• 展开全部检查项
  用 -v 查看包含通过项的完整清单
• 结构化输出
  用 --json 保存含原始指标的完整结果

日志导出

导出并发送支持包、查看日志目录、列出日志文件、结构化输出

• 导出并发送支持包
  默认在当前目录生成带时间戳的 wuji-logs-*.zip。把它连同问题描述——现象、发生时间、设备序列号——一起发给支持人员即可。
• 查看日志目录
  显示日志目录路径，默认为 ~/.wuji/logs，SDK、Wuji Studio 等组件的运行日志都存放在该目录。
• 列出日志文件
• 结构化输出
  三个子命令都支持全局参数 --json（格式化 JSON）与 --jsonl（每行一条紧凑 JSON），便于脚本解析。

固件升级

检查固件更新，批量升级设备或安装指定版本

• 范围与动作
  范围选设备、动作选版本的组合模型
• 用法
  常用升级与查询命令速查
• 读懂报告
  理解逐台状态与退出码语义
• 示例
  更新概览、批量升级与降级标注
• 结构化输出
  --json 报告与 --yes 的配合