Documentation Guide

Changelog

Version updates and changelog for Wuji CLI

Introduction

What Wuji CLI is, command overview, and design principles

• Command Overview
  Quick reference for all commands
• Design Principles
  Stateless design, read-only fallback, and exit codes
• Output Modes
  When to use --json and --jsonl structured output

Getting Started

Install and update the CLI, verify device connection, and set up shell completions

• Prerequisites
  Check system version and device connection
• Installation
  Install the CLI with the script or a binary
• Verification
  Run wuji devices to confirm discovery
• Update the CLI
  Self-update with wuji update, background checks can be turned off
• Set up Shell Completions (Optional)
  Generate auto-completion scripts for your shell
• Install AI Skills (Optional)
  Install Wuji CLI skills for AI coding assistants

Device Management

Scan devices, probe connectivity, and target a specific device

• Scan Devices
  List all devices on USB and UDP buses
• Probe Connectivity
  Confirm reachability and firmware via handshake
• Target a Specific Device
  Select a device by SN, address, or handedness
• Behavior When the Device Is Occupied
  Understand read-only fallback and write limits
• Common Messages
  Look up common messages and how to handle them

Read and Write Parameters

Discover device resources, then read and write parameters

• Discover Resources
  List readable/writable parameters and topics
• Read a Parameter
  Read parameters decoded into typed JSON
• Write a Parameter
  Write JSON values or raw hex bytes
• Notes
  Network parameter timing and virtual parameters

Data Subscription

Subscribe to real-time data streams and capture them to files

• Subscribe to a Topic
  Subscribe to live data and control frame counts
• Capture Data to Files
  Record lightweight data with --jsonl and pipes

Health Diagnostics

Check device health to locate EMF and tactile faults

• What It Checks
  Supported devices and fault types
• Usage
  Common commands for all or specific devices
• Read the Report
  Status marks, fix suggestions, and exit codes
• Expand All Checks
  Use -v to see the full check list
• Structured Output
  Save full results with raw metrics via --json

Firmware Upgrade

Check for firmware updates, upgrade devices in batch, or install a specific version

• Scope and Action
  Pick devices with a scope, pick a version with an action
• Usage
  Common upgrade and query commands
• Read the Report
  Per-device status and exit code semantics
• Examples
  Update overview, batch upgrade, and downgrade flagging
• Structured Output
  JSON reports and the --yes requirement