Skip to main content

EpicBot CLI

EpicBot also provides a Command Line Interface (CLI) which allows you to launch clients and start scripts directly from the terminal without using the graphical launcher.

This is useful for automation, scripting, or running multiple bot clients.

Usage​

EpicBot-NXT.exe [OPTIONS]

For help:

EpicBot-NXT.exe --help

Options​

JVM, Platform & Proxy​

  • --heap <value> The initial or minimum amount of memory assigned to one EpicBot client. For example: 512 or 1024.
  • --max-heap <value> The maximum amount of memory assigned to one EpicBot client. For example: 1024 or 2048.
  • --platform <name> The name of the platform to use. Platforms spoof JVM details and help hide the identity of the client.
  • --proxy <name> The name of the proxy to use. The name must match an existing proxy nickname you've preconfigured via the EpicBot Launcher.
  • --proxy-host <host> The host or IP of the proxy server.
  • --proxy-port <port> The username of the proxy server
  • --proxy-username <username> The username of the proxy server
  • --proxy-password <password> The password of the proxy server

Jagex Accounts​

There are two ways to use Jagex Accounts:

  1. You either provide an existing session id and character/account id
  2. Or you provide the email, password, character name and optionally TOTP key

Option #1

  • --jagex-session-id The session id of the Jagex Account
  • --jagex-character-id The character id of the Jagex Account. This can be used together with the session id to reuse an existing session without having to provide the email and password.

Option #2

  • --jagex-email <email> The email of the Jagex Account.
    info

    If an account with this email has been used before (found in jagex_accounts.json), the session will be re-used.

  • --jagex-password <password> The password for the Jagex Account.
  • --jagex-character <character> The character name of the Jagex Account to use.
    note

    If you omit --jagex-character, the first linked character is used automatically.

  • --jagex-totp <secret> The 2FA secret (TOTP key) of the Jagex Account.
    info

    This is the QR code secret shown only when registering your authenticator with Jagex.

Legacy Accounts​

  • --legacy-username <username> The username of a legacy RuneScape account.
  • --legacy-password <password> The password for the legacy account.

Script / Account settings​

  • --bank-pin <pin> The bank pin of the account (if applicable).
  • --world <id> The RuneScape world to log into.
  • --mouse-profile <name> The name of the mouse profile to use.

Scripts & Scheduling​

  • --script-name <name>The name of the script to start.

    • Prefix SDN- for scripts from SDN (e.g. SDN-Pro Zulrah).
    • Prefix LOCAL- for local scripts (e.g. LOCAL-TestScript).

  • --script-profile <path> The absolute file path to the script profile (settings JSON) to use when starting the script. Example:

    "C:\Users\<user>\EpicBot\Script Settings\Pro Zulrah\settings.json"

  • --schedule-id <id> The ID of a schedule to start.

Examples​

Start EpicBot with a Jagex Account, running Pro Zulrah from the SDN with a settings profile:

EpicBot-NXT.exe --heap 512 --max-heap 1024 --platform "Java21" --proxy "MyProxy" --jagex-email "[email protected]" --jagex-password "mypassword" --jagex-character "ZulrahKiller" --jagex-totp "ABC123XYZ..." --bank-pin 1234 --world 376 --script-name "SDN-Pro Zulrah" --script-profile "C:\Users\me\EpicBot\Script Settings\Pro Zulrah\settings.json"

Run a local test script with a legacy account:

EpicBot-NXT.exe --legacy-username "OldSchoolAcc" --legacy-password "secretpass" --script-name "LOCAL-MyTestScript"