Rokoko CLI

The Rokoko CLI (rokoko) is the command-line companion to the Rokoko Device SDK. You use it to sign in to your Rokoko account, activate the SDK on a workstation, inspect and update connected devices, run diagnostics, and check whether a newer SDK release is available. It is a single self-contained binary that ships for all supported platforms.

This guide documents each command’s behavior, where state is stored, and how to recover from the most common error conditions.

Installation

The tool is installed by the SDK installer script. You can find it in $ROKOKO_SDK_HOME/bin after installation. The path should have been added to your PATH environment variable, but if not, you can add it manually.

You can verify that the CLI is installed and on your PATH by running:

rokoko --version
rokoko --help

Command overview

Command	Purpose	Requires sign-in
`rokoko signin`	Authenticate via browser	—
`rokoko signout`	Clear the local session	No
`rokoko activate`	Activate the SDK on this workstation	Yes (via browser)
`rokoko deactivate`	Release this workstation’s activation	Yes
`rokoko doctor`	Print environment and license diagnostics	Yes
`rokoko outdated`	Check whether a newer SDK version is available	No
`rokoko device`	Inspect and manage connected devices	No

Every command exits 0 on success and 1 on failure, printing a human-readable error to stderr.

Authentication

`rokoko signin`

Starts a browser-based sign-in. The CLI requests a one-time token, opens your default browser to the Rokoko ID site, and then waits (up to 5 minutes) for you to complete the login. On success it stores your tokens locally and prints the account email.

rokoko signin
# Opening browser to sign in…
# Signed in as you@example.com

`rokoko signout`

Removes the stored session. It is safe to run even when not signed in — it is idempotent and never contacts the network.

rokoko signout
# Signed out.

Workstation activation

Activation binds an SDK license to a specific machine, so the SDK knows it is authorized to run locally.

`rokoko activate`

Requests an activation session and opens your browser to sign in and confirm.
Waits (up to 5 minutes) for browser confirmation, then registers the workstation with the license API, sending a hardware fingerprint, your OS, and the SDK version.

rokoko activate
# Opening browser to (sign in) and confirm activation…
# Waiting for browser confirmation…
# Workstation activated (ID: ws-7f3a…)

On success the license certificate and lease token are written together in a single atomic file, and your session tokens are refreshed.

If too few hardware identifiers are available (for example inside a restricted container), you’ll see:

could not collect enough hardware identifiers for fingerprint (2/5 found, need 3)

`rokoko deactivate`

Releases this workstation’s activation so the license can be moved to another machine. Requires a valid session.

rokoko deactivate
# Workstation deactivated (ID: ws-7f3a…)

The command transparently refreshes an expired access token using your stored refresh token and retries once. If the refresh token is also expired or missing, it clears the local session and asks you to sign in again:

Session expired. Run `rokoko signin` again.

Devices

The rokoko device commands talk to the local RCSP server (the SDK driver) rather than the Rokoko backend, so they do not require you to be signed in. By default they connect to localhost:45451; override this with the global --host and --port options if your driver listens elsewhere:

rokoko device --host 192.168.1.50 --port 45451 list

`rokoko device list`

Lists every device the RCSP server currently sees, with its ID, type, connection method, whether a firmware update is available, and whether it is in bootloader mode.

rokoko device list
# ID     TYPE           CONNECTION   UPDATABLE   BOOTLOADER
# 1      SmartsuitPro   usb          yes         no
# 2      Smartgloves    wifi         no          no

If nothing is connected, it prints No devices found.

`rokoko device info <device-id>`

Shows detailed information for a single device — firmware, bootloader, and hardware versions; production metadata; and device-specific details such as glove side or Smartsuit Pro feature flags. Pass the ID shown by device list.

rokoko device info 1
# Device 1
#   Device type  SmartsuitPro
#   Firmware     1.8.4
#   Bootloader   1.2.0
#   …

Fields that the device does not report are omitted from the output.

`rokoko device update <device-id>`

Updates a device to the firmware bundled with your installed SDK. The CLI inspects the device, selects the matching firmware from the SDK, and flashes it, printing live progress as a percentage.

rokoko device update 1
# hub firmware: updating to 1.9.0…
#   hub firmware: 100%
# hub firmware: update complete

By default a target is skipped when the device is already at or above the bundled version:

hub firmware: already up to date (1.9.0 >= 1.9.0), skipping

Pass --force to flash regardless of the current version:

rokoko device update 1 --force

A Smartsuit Pro II is updated in two parts — hub firmware and sensor firmware — and each is reported independently. If one target fails the other still runs, and the command exits non-zero with a summary such as 1 firmware update(s) failed. Firmware updates are only supported for Smartsuit Pro II and Smartgloves devices.

Diagnostics and updates

`rokoko doctor`

Prints a diagnostics banner summarizing the CLI’s view of your environment and license. It contacts the license API to fetch your current status, so it requires an active session. The banner reports:

the installed SDK version and its location (ROKOKO_SDK_HOME),
the SDK driver version,
your signed-in email,
whether this workstation is activated, and
license status, including the renewal or expiry date and how many seats are in use.

rokoko doctor

Run it before reporting a bug. If you are not signed in it prints Not signed in. Run `rokoko signin` first.

If the license check shows your workstation is no longer registered (for example it was deactivated remotely), doctor prints a hint to re-activate:

Run `rokoko deactivate` followed by `rokoko activate` to re-activate

`rokoko outdated`

Compares your installed SDK version against the latest published release and tells you whether an update is available. It does not require sign-in.

rokoko outdated
# You are up to date (version 1.9.0).

When a newer version exists it prints the install command to run:

New version 1.9.1 available, you have 1.9.0
To update, run:
  curl -fsSL https://sdk-downloads.rokoko.com/latest/install-device-sdk.sh | sh

(On Windows the suggested command uses the PowerShell installer instead.)

Local state

The CLI stores all state in your platform’s standard config directory:

Platform	Location
macOS	`~/Library/Application Support/com.Rokoko.rokoko-cli/`
Linux	`$XDG_CONFIG_HOME/rokoko-cli/` (usually `~/.config/rokoko-cli/`)
Windows	`%APPDATA%\Rokoko\rokoko-cli\config\`

Within that directory, session and activation files are written atomically (and with 0600 permissions on Unix):

tokens-<env>.json — session access/refresh tokens.
activation-<env>.json — the license certificate and lease token, bundled so they can never get out of sync.

To fully reset your local state, run rokoko signout and rokoko deactivate, or delete the corresponding files.

Troubleshooting

Message	Cause	Fix
Not signed in. Run `rokoko signin` first.	No stored session	`rokoko signin`
`Already signed in as …`	A session already exists	`rokoko signout`, then sign in
`Already activated (ID: …)`	This machine is already activated	`rokoko deactivate` first
Not activated. Run `rokoko activate` first.	`deactivate` with no activation	Nothing to do, or `rokoko activate`
`could not collect enough hardware identifiers …`	Too few hardware IDs readable	Run on real hardware / outside a restricted container
`Session expired. Run` rokoko signin `again.`	Access and refresh tokens both expired	`rokoko signin`
Connection error from `rokoko device …`	The RCSP server / device driver isn’t running or is on another host	Start the driver, or pass `--host`/`--port`
`firmware update is not supported for … devices`	The device type can’t be flashed by the CLI	Only Smartsuit Pro II and Smartgloves are supported