XeCLI / Getting Started

Hardware and System Controls

Repo Releases

Hardware and System Controls

XeCLI exposes a small set of operator-facing hardware and session controls that are useful during daily RGH/JTAG work:

  • sign-in state inspection
  • ring-of-light LED control
  • manual fan command dispatch
  • SMC version probing

This page explains what those commands do, how they are intended to be used, and what their current practical limits are.

Command Overview

rgh signin state
rgh led set --preset quadrant1
rgh led state
rgh fan set --speed 55 --channel both
rgh fan show
rgh smc version

Signed-In Session State

rgh signin state

Reads the active XAM sign-in slot and resolves:

  • whether a user is signed in
  • the sign-in state
  • the current gamertag
  • the current XUID
  • the user slot

Examples:

rgh signin state
rgh signin state --json

Representative output:

Signed In   Yes
State       Signed in locally
Gamertag    Diamond KSG
XUID        0x5D83300C00000900
Slot        0

Sign-in state meanings:

Value Meaning
0 Not signed in
1 Signed in locally
2 Signed in to Xbox Live

This command is the cleanest way to answer the operator questions:

  • is anyone signed in right now?
  • which profile is active?
  • what XUID is attached to the current session?

Ring-of-Light LED Control

rgh led set

Sets the four ring-of-light quadrants through the console’s RPC path.

You can use:

  • a preset
  • explicit per-quadrant colors
  • optional success notification flags

Examples:

rgh led set --preset quadrant1
rgh led set --preset all-green
rgh led set --tl green --tr off --bl off --br off
rgh led set --preset all-orange --notify

Supported colors:

  • off
  • green
  • red
  • orange

Built-in presets:

  • all-green
  • all-red
  • all-orange
  • all-off
  • quadrant1
  • quadrant2
  • quadrant3
  • quadrant4
  • player1
  • player2
  • player3
  • player4

Representative output:

SUCCESS Ring light updated
TL=green, TR=off, BL=off, BR=off

rgh led state

Shows the last ring-light state requested through XeCLI.

Examples:

rgh led state
rgh led state --json

Representative output:

Source        Last XeCLI-applied ring-light state
Preset        quadrant1
Top Left      green
Top Right     off
Bottom Left   off
Bottom Right  off
Updated       08:45:30

Important note:

  • led state is an operator cache of the last XeCLI-applied state
  • it is not a hardware readback from the SMC

That distinction matters after a reboot or if another tool changes the LEDs.

Manual Fan Control

rgh fan set

Dispatches a manual fan-speed command through the console’s SMC RPC path.

Examples:

rgh fan set --speed 55 --channel both
rgh fan set --speed 45 --channel primary
rgh fan set --speed 60 --channel secondary --notify

Channel values:

  • primary
  • secondary
  • both

Representative output:

SUCCESS Fan command sent
50% requested for both

Practical notes:

  • XeCLI clamps the requested value to 10-100
  • current fan control is a command-dispatch workflow, not a tachometer readback workflow
  • fan show reports the last XeCLI-requested manual setting, not a live measured RPM

rgh fan show

Shows the last manual fan setting requested through XeCLI.

Examples:

rgh fan show
rgh fan show --json

Representative output:

Source   Last XeCLI-applied manual setting
Speed    50%
Channel  both
Updated  09:12:04

SMC Version

rgh smc version

Attempts to query the console’s SMC version.

Examples:

rgh smc version
rgh smc version --json

When the installed console-side plugin stack exposes the required SMC path cleanly, the command returns a simple version string.

Representative success output:

SUCCESS SMC version
2.3

Operational reality:

  • SMC version probing is more plugin-stack-sensitive than normal JRPC title/temperature calls
  • if the installed JRPC/XBDM stack does not expose a usable SMC reply path, XeCLI reports the failure instead of fabricating a value
  • rgh status treats SMC version as optional and does not let an SMC failure poison the rest of the status output

Status Integration

rgh status and rgh status --json surface the session fields directly:

  • Signed In
  • Sign-In State
  • Gamertag
  • Signed In XUID
  • SMC Version when available

That means you can use status for the dashboard-level snapshot and signin state when you want the session details isolated.

Use the commands in this order:

rgh ping
rgh status --quick
rgh signin state
rgh led set --preset quadrant1
rgh notify "XeCLI connected" 14

Then move to the less routine controls:

rgh fan set --speed 55 --channel both
rgh smc version

That sequencing keeps the basic transport validation separate from the hardware/session controls.