Documentation

CLI Reference

Command-line operations for installing, running, and managing ARX.

Overview

The global arx command is installed during setup and provides runtime lifecycle control.

arx help

Core commands

arx startLaunch dashboard, Minecraft runtime, and AI services

arx statusShow live status for dashboard/server/ollama/playit

arx shutdownGracefully stop all managed services

arx helpShow complete command menu

arx ai set-context 4096Set Gemma context size for local runtime

arx tunnel setupSet up optional Playit tunnel

arx tunnel statusShow tunnel status and configured public URL

Lifecycle examples

# Start everything
arx start
# Start single targets
arx start dashboard
arx start server
arx start ollama
# Stop behavior
arx stop        # keeps ollama running
arx shutdown    # stops all services

Status and diagnostics

arx status
arx doctor
arx logs dashboard --lines 120
arx logs server --lines 120

AI tuning commands

arx ai set-context 4096
arx restart

Context values should remain in stable local ranges for your hardware.

Tunnel commands

arx tunnel setup
arx tunnel setup --url your-name.playit.gg:12345 --enable
arx tunnel status
arx tunnel open
arx tunnel stop

Version

arx version

Edit this page on GitHub

← Previous

Quick Start

Configuration