Documentation

The Tribot CLI is a command-line tool for launching and managing bot clients. It works independently from the launcher and is available for Windows, macOS, and Linux.

Prerequisites

Before using the CLI, you must log in to the Tribot Launcher at least once. The CLI uses your saved credentials to authenticate.

Download

Download the CLI for your platform from the Tribot Downloads page.

Getting Started

  1. Download and extract the CLI to a folder on your computer.

  2. Open a terminal and navigate to the folder containing the CLI:

Windows (Command Prompt):

cd C:\path\to\tribot-cli

macOS / Linux:

cd /path/to/tribot-cli
  1. Run the help command to see available options:

Windows:

.\tribot.exe --help

macOS / Linux:

./tribot --help

Each subcommand has its own help documentation:

./tribot run --help
./tribot bulk-launch --help

Commands

run

Launches a single bot client with specified options.

./tribot run [OPTIONS]

Account Options:

  • --jagex-character-name - Character name (must be saved in launcher)
  • --jagex-character-id - Character ID (alternative to name)
  • --legacy-username - Legacy account username
  • --legacy-password-raw - Use raw password instead of saved
  • --legacy-totp-raw - TOTP secret for legacy accounts
  • --bank-pin-raw - Override saved bank pin

Raw Jagex Authentication (bypasses account manager):

  • --jagex-character-id-raw - Raw character ID
  • --jagex-session-id-raw - Raw session ID
  • --jagex-character-name-raw - Raw character display name

Proxy Options:

  • --proxy-name - Proxy name or host (must be saved in launcher)
  • --proxy-host-raw - Raw proxy host
  • --proxy-port-raw - Raw proxy port
  • --proxy-username-raw - Raw proxy username
  • --proxy-password-raw - Raw proxy password

Script Options:

  • --script-name - Script to run
  • --script-args - Script arguments
  • --break-profile-name - Break profile (must exist in launcher)

Client Settings:

  • --world - Starting world
  • --fps-limit - FPS limit (1-50)
  • --render-distance - Render distance (1-25)
  • --use-opengl - Enable OpenGL rendering (true/false)
  • --heap-mb - JVM heap size in MB
  • --minimized - Start minimized (true/false)
  • --window-width - Window width in pixels
  • --window-height - Window height in pixels
  • --window-x - Window X position
  • --window-y - Window Y position

Example:

./tribot run \
  --legacy-username "[email protected]" \
  --proxy-name "us-proxy-1" \
  --script-name "MyScript" \
  --script-args "arg1,arg2" \
  --heap-mb 1024

bulk-launch

Launches multiple clients from a CSV file.

./tribot bulk-launch --file path/to/file.csv --config-file path/to/config.json

CSV Headers:

The CSV file must have these headers in order: jagex_character_name, jagex_character_id, legacy_account_name, jagex_character_id_raw, jagex_session_id_raw, jagex_character_name_raw, proxy_name, script_name, script_args, fps_limit, render_distance, use_opengl, heap_mb, minimized, window_height, window_width, window_x, window_y

Empty fields are allowed. When using multiple tabs per client, accounts are grouped sequentially and window settings are taken from the first account in each group.

Config File (Optional):

{
  "tabs_per_client": 3,
  "default_heap_mb": 1024,
  "default_use_opengl": false,
  "default_minimized": false,
  "default_window_height": 768,
  "default_window_width": 1024,
  "window_size_randomness_percent": 5,
  "client_launch_delay_ms": 2000,
  "tab_launch_delay_ms": 500
}

All config fields are optional and will use defaults if not specified.

accounts

Import and export accounts from the launcher database.

./tribot accounts export --file accounts.csv
./tribot accounts import --file accounts.csv

Account CSV Headers: legacy_username, legacy_password, bank_pin, preferred_world, proxy_host

When importing, proxies must already exist in the launcher. Existing accounts are merged based on username.

proxies

Import and export proxies from the launcher database.

./tribot proxies export --file proxies.csv
./tribot proxies import --file proxies.csv

Proxy CSV Headers: name, host, port, username, password

Existing proxies are merged based on host and port.

Global Options

  • --no-update - Skip the automatic CLI update check
  • --version - Show version information
  • --help - Show help information

Troubleshooting

Windows: VCRUNTIME140.dll Error

If you see "VCRUNTIME140.dll was not found", install the Visual C++ Redistributable from Microsoft.

Authentication Errors

Ensure you have logged in to the Tribot Launcher at least once before using the CLI. The CLI uses credentials saved by the launcher.