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)

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

Step 2: Import Your First Account

Method A: Quick Text Import

1. Click the Import button in the Accounts page
2. Select Text Format
3. Enter your account details in the one of the following formats:

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

Step 3: Create Your First Agent

Agents are the workers that run your bots. Let's create one:

1. Navigate to Agents
2. Click Create Agent
3. Fill in the agent details:

Name: my-first-agent
Description: Primary agent on main PC
Client Type Options: {JAR File path, username/password for dreambot}

4. Click Create Agent to create the 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. Click New Instance
3. Configure your preferred client
4. Click Create Instance

Step 5: Create a script activity

1. Navigate to Script Activities
2. Click New Activity
3. Configure your script activity:

Activity Name: Friendly name used in the UI
Client Instance: Select the client instance you created (this specifies the client that the script runs on)
Script Name: This is the arg that is passed to the client, generally its the fully script name or script id
Script Argument (optional): arguments that will be passed to the script, sometimes used for config files or other settings

4. Click Submit

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:

• Check the Troubleshooting Guide
• Visit our Discord for community support
• Review FAQ for common questions

Ready to dive deeper? Continue to the Initial Setup Guide for detailed configuration options.