-
Notifications
You must be signed in to change notification settings - Fork 0
Beginner Guide
This guide covers the safe, practical path from a fresh install to a working live-console session.
On the PC side:
- Windows
- no extra runtime if you are using the published
win-x64release package - .NET 10 only if you are building or running XeCLI from source
- Network access to the console
On the console side:
- XBDM enabled
- JRPC2 if you want RPC, temps, CPU key, notifications, or Title ID reads
- FTP service if you want FTP-backed save, content, or file workflows
Direct plugin downloads from the XeCLI repo:
Use these if you want the exact plugin files bundled with XeCLI instead of sourcing them separately.
If you are using the published Windows installer, launch the setup executable:
.\XeCLI-1.0.8-setup-win-x64.exeThe published release is self-contained. You do not need to install .NET separately for the normal installer or portable win-x64 release paths.
The installer walks through:
- install scope: current user or all users
- install directory selection
- PATH registration for new terminals
After setup finishes, XeCLI silently scans for consoles. If one console is detected, it can ask whether to connect immediately. If multiple consoles are detected, it lists them and asks you to choose one. When you confirm, XeCLI runs rgh status on the selected console.
After installation completes, open a new terminal and use:
rgh --help
rgh status
rgh languageIf you prefer the portable zip instead of the installer, extract it and run rgh.exe directly from that folder.
If you skipped the post-install connection prompt, use the manual discovery path:
rgh startDirect targeting:
rgh target --set <console-ip>If you use FTP features, set that target too:
rgh ftp target --set <console-ip> --user <ftp-user> --pass <ftp-pass>Read FTP-and-File-Transfer.md if you want the full FTP command set and the guidance on when to use FTP instead of rgh fs.
rgh ping
rgh status
rgh status --quickIf you accepted the installer’s connect prompt, XeCLI already ran rgh status for the selected console. Use these commands any time you want to recheck reachability or switch back to a manual verification flow.
rgh title
rgh title --jsonrgh title with no arguments resolves the active title from the connected console. If the bundled database only knows the base system Title ID, XeCLI can still show a better path-based title name such as Aurora.
Modules:
rgh modules list
rgh modules info --name Aurora.xexMemory:
rgh mem hexdump --addr 0x30000000 --size 0x40
rgh mem peek --addr 0x30000000 --type u32Screenshot:
rgh screenshot --out .\screen.bmpBrowse files:
rgh ftp list --path /Hdd1/List saves for a title:
rgh save list --titleid FFFE07D1 --device Hdd1List installed content:
rgh content list --device Hdd1 --show-typesList DashLaunch plugins:
rgh plugin listRead FTP-and-File-Transfer.md for the broader file and storage workflow.
XeCLI can either stage the common public dashboards and tools to a USB drive or folder, or install them directly onto a detected console drive.
rgh homebrew install aurora --usb E:
rgh homebrew install all --usb E: --auto-confirm
rgh homebrew install aurora --device Hdd1 --ini-mode merge
rgh homebrew install xm360 --usb E:
rgh homebrew install timefixer --usb E:
rgh homebrew install simple360 --usb E:
rgh homebrew install xelllaunch --usb E:USB or folder staging:
- downloads the selected public package archives
- extracts them into clean folders on the USB or staging path
- copies the bundled
xbdm.xex,JRPC2.xex, andXDRPC.xexfiles intoPlugins\ - generates
launch.iniwhen Aurora is present - prompts before staging or installing unless
--auto-confirmis supplied - supports Aurora, DashLaunch, XeXMenu, Freestyle Dash, XM360, TimeFixer, Simple 360 NAND Flasher, and XellLaunch
If no removable USB drive is visible, use a normal folder path instead:
rgh homebrew install all --usb A:\UsbStage --auto-confirmDirect console install:
- detects only
Hdd1,Usb0,Usb1, andUsb2from the live console over FTP - asks which detected drive you want to install to
- asks whether XeCLI should generate a new
launch.ini, merge plugin entries into the existing file, or leave it unchanged - uploads the selected dashboards/tools and bundled plugins directly onto the selected console drive
Read Homebrew-and-USB.md for the full package workflow.
If you want original Xbox backwards compatibility on a modded console, use the dedicated ogxbox workflow instead of the normal homebrew installer:
rgh ogxbox list
rgh ogxbox install hacked --usb E:
rgh ogxbox install hud --include-fixerUse hacked as the default choice for the widest compatibility on an exploited console. Use hud only if you specifically want the 360 guide available inside original Xbox titles and can accept the extra performance cost. Use retail when you want the stock Microsoft emulator behavior.
Read Original-Xbox-Compatibility.md for the XeFu set differences and HddX:\Compatibility workflow.
Launch a XEX:
rgh launch Hdd1:\Aurora\Aurora.xex --titleid FFFE07D1Send a notification:
rgh notify "XeCLI connected" 14Signed-in user:
rgh signin stateRing light:
rgh led set --preset quadrant1
rgh led stateIf you want the hardware/session details explained in depth, read Hardware-and-System.md.
Do not start with dangerous commands until the basic path is stable.
Start with:
statustitlemodules listftp listscreenshotsignin statehomebrew install all --usb E: --auto-confirmogxbox install hacked --include-fixer --usb E:led set --preset quadrant1
Delay these until you know the target is stable:
mem pokemem search --freezemodules unload --forcemodules load --systemfan set- deletion commands
- Commands Reference for full command coverage
- Homebrew and USB for USB/folder staging and direct console installs
- Original Xbox Compatibility for XeFu pack installs and HddX setup
- Hardware and System Controls for sign-in, LED, fan, and SMC behavior
- XNotify for icon IDs and notification usage
- Advanced Guide for reverse-engineering and automation workflows
- Troubleshooting when the console or plugin stack does not behave as expected
XeCLI documentation for the rgh command. For release downloads, use the latest release.