Quick Start Guide

Prerequisites

Before starting, ensure you have:

• A Pitchfork account (register at getpitchfork.com)
• At least one OSRS account to manage
• A computer with Java Runtime Environment 8 (or 11 for runelite) installed
• Google Chrome installed (required for agent functionality)

The registration form looks like this — pick a strong password (12+ chars, a number, a special character) and accept the terms of service:

Step 1: Initial Login

1. Navigate to the dashboard
2. Click Login in the top navigation
3. Enter your credentials:

Email: your-email@example.com
Password: your-secure-password

4. If you have 2FA enabled, enter your authentication code
5. You'll be redirected to the main dashboard

On first login, the inline Getting Started checklist explains the setup flow without blocking the page. Follow the agent → client instance → script activity → account sequence from its links, and reopen it anytime with Getting Started in the sidebar. After all four required steps are complete, the open guide keeps a short next-step: run or connect your agent, then go to Accounts to select accounts and launch a script. Importing proxies is optional; you can pair them during account import or later from Accounts.

Step 2: Import Your First Account

Method A: Quick Text Import

1. Click Import Accounts on the Accounts page
2. Use the account import page's text import form.
3. Enter your account details in the one of the following formats:

The import form looks like this — paste accounts into the textarea, one per line:

4. Click Import to add the accounts
5. You'll see your accounts appear in the main table:

For the full reference of supported fields and formats, see Importing.

Step 3: Create Your First Agent

Agents are the workers that run your bots — small binaries that connect to Pitchfork over WebSocket and launch bot clients on your machine.

1. Navigate to Agents

2. Click Create Your First Agent (or Create Agent if you already have one)

3. Fill in the details — only Name is required; the rest have sane defaults:

   • Name — e.g. home-pc-agent
   • Memory Limit (MB) — heap cap; bump to 1024–2048 if you'll run multiple clients
   • Custom JVM Arguments (optional) — applies to every client this agent runs (timezone, encoding, etc.). See Configuration for the difference vs Client Instance args.

   

4. Click Create Agent.

Download and Run the Agent

1. Click Download Agent icon
2. Select the appropriate binary for your platform
3. Run the agent binary
4. You should see a window with the following:

[INFO] Agent connected successfully
[INFO] Waiting for commands...

Step 4: Configure a Bot Client

1. Navigate to Clients

2. On the Client Types tab, click Create Instance on the tile for your client (RuneLite or MicroBot)

3. Set:

   • Instance Name — e.g. runelite-default
   • Memory (MB) — usually fine at 512; bump for memory-hungry scripts
   • Custom JVM / Custom Client Arguments (Advanced) — see Configuration for what goes where
   • JAR Path — required for RuneLite and Custom clients only

   

4. Click Create Instance.

Step 5: Create a script activity

A Script Activity ties together a script (by name), a client instance to run it on, and any arguments. You'll reference it later when launching a bot.

1. Navigate to Scripts

2. Click New Activity

3. Fill in the form:

   • Activity Name — display name in the Pitchfork UI (e.g. Woodcutting Main)
   • Client Instance — pick the one you created in Step 4
   • Script Name — the script identifier passed to the client (e.g. a script ID or class name for your client)
   • World Selection (optional) — pin to a specific world, or leave on Default (Auto)
   • Exit Behavior — what to do when the script finishes (Exit on finish is the safe default)
   • Script Arguments (optional) — key/value pairs passed to your script

   

4. Click Create Activity.

Step 6: Launch Your First Bot

Now let's put it all together:

1. Return to Accounts (/protected/accounts)
2. Select the account you want to bot with (checkbox)
3. Click Launch Script button
4. In the modal, configure:

Script: Select your script
Client: Select the client instance you created
Agent: Select your running agent
World: 302 (or leave blank for random)
Arguments: Script-specific parameters

5. Click Launch
6. Monitor the status - it should change to Running within 30 seconds

Monitoring Bot Status

Watch your bot's progress in real-time:

• Status Badge: Shows current state (Running/Idle/Stopped)
• Runtime: Displays how long the bot has been running
• Last Activity: Shows when the bot last reported status
• WebSocket Icon: Indicates real-time connection status

Verification Checklist

✅ Account Imported: Visible in Accounts table
✅ Script Activity Created: Script Activity created and visible
✅ Agent Running: Shows "Connected" status in Agents page
✅ Client Configured: Client instance saved and ready
✅ Bot Launched: Account status shows "Running"
✅ Real-time Updates: WebSocket indicator is green

Getting Help

If you encounter issues:

• Review the FAQ for common questions
• Visit our Discord for community support
• Confused about JAR Path or Custom Args? See Configuration

Ready to dive deeper? See Triggers for automation, Account Tools for batch workflows, or the Public API for programmatic access.