> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wuji.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Wuji CLI · Reading guide

> Command-line tool.

<Card img="https://mintcdn.com/wuji-0bbde051/32vMaCBOgjCFMkOf/assets/covers/cover-cli-live-blank.png?fit=max&auto=format&n=32vMaCBOgjCFMkOf&q=85&s=b9683996918b6ac21609edd172ec1631" className="wj-media wj-cover" width="1536" height="486" data-path="assets/covers/cover-cli-live-blank.png">
  <span className="wj-eyebrow">Device Tools · Product Documentation</span>
  <span className="wj-hero-name">Wuji CLI</span>
  <span className="wj-hero-tag">Command-line tool.</span>
  <span className="wj-hero-specs"><Badge>v2026.8.31</Badge> <Badge>macOS · Windows · Linux</Badge></span>
</Card>

## Recommended Reading Path

Follow these stages to install the CLI, operate devices, calibrate data, and diagnose issues.

<Steps>
  <Step title="Install and Verify">
    Install the CLI, then verify the device connection and shell environment.

    * [Introduction](/en/docs/wuji-cli/introduction) — CLI purpose, command overview, output modes, and error output
    * [Getting Started](/en/docs/wuji-cli/getting-started) — Prerequisites, installation, verification, updates, and shell completions
      * [Installation](/en/docs/wuji-cli/getting-started#installation)
      * [Verification](/en/docs/wuji-cli/getting-started#verification)
      * [Update the CLI](/en/docs/wuji-cli/getting-started#update-the-cli)
  </Step>

  <Step title="Operate Devices">
    Start with device discovery, then read and write parameters, subscribe to data, record sessions, and visualize them.

    * [Device Management](/en/docs/wuji-cli/device-management) — Scan devices, probe connectivity, and target a specific device
      * [Scan Devices](/en/docs/wuji-cli/device-management#scan-devices)
      * [Probe Connectivity](/en/docs/wuji-cli/device-management#probe-connectivity)
      * [Target a Specific Device](/en/docs/wuji-cli/device-management#target-a-specific-device)
    * [Parameters](/en/docs/wuji-cli/parameters) — Discover resources, then read or write parameters
    * [Subscription](/en/docs/wuji-cli/subscription) — Subscribe to data streams and capture them to files
    * [Recording](/en/docs/wuji-cli/recording) — Record, review, and export teleoperation sessions
    * [Visualization](/en/docs/wuji-cli/visualization) — View live joint and tactile data in Rerun Web Viewer
  </Step>

  <Step title="Calibrate and Manage User Data">
    Manage profiles, run hand model and tactile calibration, and move calibration data between machines.

    * [User and Calibration Data](/en/docs/wuji-cli/user) — Profiles, data export and import, and automation
    * [Hand Model Calibration](/en/docs/wuji-cli/hand-model-calibration) — Run hand model calibration and hot-load the result
    * [Tactile Calibration](/en/docs/wuji-cli/tactile-calibration) — Options, abort behavior, reports, and post-calibration checks
  </Step>

  <Step title="Diagnose and Upgrade">
    Export diagnostic information before upgrading firmware.

    * [Doctor](/en/docs/wuji-cli/doctor) — Check connectivity, versions, permissions, and device status
    * [Logs](/en/docs/wuji-cli/logs) — Export support bundles, snapshots, and structured logs
    * [Firmware Upgrade](/en/docs/wuji-cli/firmware-upgrade) — Check for updates, upgrade devices in batches, or flash a local firmware file
  </Step>

  <Step title="Migrate from Studio">
    Move Studio data to the CLI and map Studio features to CLI commands.

    * [Migration from Studio](/en/docs/wuji-cli/migration-from-studio) — Export and import data, then find the matching CLI command and documentation
  </Step>
</Steps>

## All Pages in This Version

<Columns cols={2}>
  <Card title="Release Notes" href="/en/release-notes" horizontal>Version updates and changelog for Wuji CLI</Card>
  <Card title="Introduction" href="/en/docs/wuji-cli/introduction" horizontal>CLI purpose, command overview, output modes, and error output</Card>
  <Card title="Getting Started" href="/en/docs/wuji-cli/getting-started" horizontal>Prerequisites, installation, verification, updates, and shell completions</Card>
  <Card title="Device Management" href="/en/docs/wuji-cli/device-management" horizontal>Scan devices, probe connectivity, and target a specific device</Card>
  <Card title="Parameters" href="/en/docs/wuji-cli/parameters" horizontal>Discover resources, then read or write parameters</Card>
  <Card title="User and Calibration Data" href="/en/docs/wuji-cli/user" horizontal>Manage profiles, move calibration data, and automate CLI tasks</Card>
  <Card title="Hand Model Calibration" href="/en/docs/wuji-cli/hand-model-calibration" horizontal>Run hand model calibration and hot-load the result</Card>
  <Card title="Subscription" href="/en/docs/wuji-cli/subscription" horizontal>Subscribe to real-time data streams and capture them to files</Card>
  <Card title="Recording" href="/en/docs/wuji-cli/recording" horizontal>Record, review, and export teleoperation sessions</Card>
  <Card title="Visualization" href="/en/docs/wuji-cli/visualization" horizontal>View live joint and tactile data in Rerun Web Viewer</Card>
  <Card title="Tactile Calibration" href="/en/docs/wuji-cli/tactile-calibration" horizontal>Run tactile calibration and verify the result</Card>
  <Card title="Doctor" href="/en/docs/wuji-cli/doctor" horizontal>Check connectivity, versions, permissions, and device status</Card>
  <Card title="Logs" href="/en/docs/wuji-cli/logs" horizontal>Export support bundles, snapshots, and structured logs</Card>
  <Card title="Firmware Upgrade" href="/en/docs/wuji-cli/firmware-upgrade" horizontal>Check updates, upgrade devices in batches, and flash local firmware</Card>
  <Card title="Migration from Studio" href="/en/docs/wuji-cli/migration-from-studio" horizontal>Move Studio data and map Studio features to CLI commands</Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.