OUTRIDER docs
v1.1.0
Live demo Get help
● Start · No experience needed

Getting started
from the zip to your first paper day.

A plain-language walkthrough for your first hour. You will install one program, type a few commands, create your console account and watch the desk trade on paper. No keys and no money are needed for any of it.

About 30 minutesPaper modeNo keys needed

01Before you start

  • A computer with macOS, Linux or Windows, and an internet connection.
  • About 2 GB of free disk space for the program and its first recordings.
  • A terminal: the app where you type commands. On macOS it is called Terminal (in Applications → Utilities). On Linux, your usual terminal. On Windows, install WSL (Windows Subsystem for Linux, with Ubuntu) or Git Bash and type the commands there: they are written for macOS and Linux shells, and a few of them (cp, openssl, multi-line curl) do not work as written in PowerShell.

Whenever you see a dark box below, press Copy, paste it into the terminal and press Enter. Grey text after # is only an explanation.

02Ten steps

  1. Unzip the downloadUnzip the file from CodeCanyon into a folder without spaces in its name, for example outrider in your home folder.
  2. Install Node.js 22Download the LTS installer for your system from nodejs.org and run it (version 22 or newer). Then close and reopen the terminal and check:
    node --version   # must print v22 or higher
  3. Open the folder in the terminalType cd and a space, drag the unzipped folder onto the terminal window, and press Enter. Everything from now on runs in this folder.
  4. Install and buildThe first command downloads the exact package versions listed in package-lock.json and takes a minute or two. The second compiles the operator console once (you repeat it only after an update).
    npm ci
    npm run build
    npm ci should end with found 0 vulnerabilities or a similar summary, not with ERR!. npm run build prints its command (tsc -p tsconfig.json) and no error lines when it succeeds. If either fails, see Troubleshooting.
  5. Open the console without tradingThis starts only the dashboard and the operator console; nothing trades yet.
    npm run dash
    On your own computer you do not need a .env yet: without ADMIN_SETUP_TOKEN, the terminal prints a block like this, and the 16-character code is your one-time setup code:
    [admin] No owner account yet. Open /admin and create it with this one-time setup code:
    
        <setup code>
    
    [admin] The code is shown once, here only. Each start before the owner exists adds a new code; any printed code works until the owner is created.
    [admin] To choose the secret yourself instead, set ADMIN_SETUP_TOKEN in the environment and restart.
    Admin console http://127.0.0.1:8790/admin — create the owner with ADMIN_SETUP_TOKEN (or the setup code printed above)
    On a server, set ADMIN_SETUP_TOKEN in .env instead and use that value (how).
  6. Create your owner accountOpen http://127.0.0.1:8790/admin in your browser. Paste the setup code (or your ADMIN_SETUP_TOKEN), enter your email and a password of at least 12 characters. The console then walks you through a few setup fields (mode, product name, accent colour); leave Mode on Paper trading. Details: Create the owner.
  7. Start your first paper dayGo back to the terminal, press Ctrl+C once to stop, then start the full desk:
    npm start
    Every 20 seconds it prints one line with equity, open positions, news, candidates and pump.fun events. Leave the terminal open: closing it stops the desk.
  8. Read the dashboardOpen http://127.0.0.1:8790 and sign in. Start with three things: the mode chip in the header (it should say PAPER), Desk control (what is blocking new entries, if anything) and the pump.fun panel (coins being watched and why each was accepted or refused). Most candidates are refused; that is normal (why). Every figure is paper money, not earnings. Full tour: The dashboard.
  9. Optional: Telegram alertsCreate a bot with @BotFather, put the token in the console (Integrations) and your chat id in .env, then restart (Telegram bot).
  10. Optional, much later: live mode with a dry runOnly after you have watched paper results for a while and read What it is not. Live mode starts with Dry run on: orders are signed and simulated, never sent (Live trading). Live trading uses your own money and can lose it.

03Is everything working?

Run the built-in check in a second terminal window, in the same folder:

node src/cli.mjs doctor

Each line starts with ✅ (works), ❌ (failed, followed by what it breaks) or · (optional, not set up). Services of the optional modules (for example Polymarket) are shown with · while their module is off, and do not count as failures. The console's Status page (Monitor → Status) runs the main checks too.

Console Status page: Solana RPC, Hyperliquid API, trade journal, pump.fun stream, Telegram (optional) and liquidation map checks, each with its severity
Monitor → Status with the public Solana endpoint and no keys set. The info check on liquidation-map freshness fails until the running desk has refreshed the map.

04Day to day

  • Stop: press Ctrl+C once and wait; the desk saves its state first.
  • Start again: npm start. It continues where it stopped.
  • Pause buying without stopping: the kill switch on the dashboard, or /stop in Telegram.
  • Keep it running for days: a laptop that sleeps leaves gaps. Use a small server (Deployment).
  • Back up the data/ folder and keep the secret key separately (what to back up).

05Where to go next