Skip to main content

πŸ“¦ Installation

Install the latest version via npm install:
Using bun? Install the latest version via bun install:

Authentication

Pass any supported credential as apiToken or token:

Starting a Single Bot

Get started with a single bot using your FNLB API token. Learn more:

Running Multiple Bots (Same Shard)

Run multiple bots in a single subprocess using the botsPerShard option:

Using Multiple Shards (Subprocesses)

Scale even more by spawning multiple shards (subprocesses) with multiple bots each:
Total bots: numberOfShards Γ— botsPerShard
In this example: 2 Γ— 10 = 20 bots max

Launching Bots Across Multiple Categories

Want to run bots from different FNLB categories? Just add them to the categories array:

Starting Specific Bots by ID

Run exact bots without filtering by category using the bots array. Get bot IDs from your bot’s page on app.fnlb.net/bots.
Multiple shards can share the same bots list β€” the gateway distributes IDs across shards with no duplicates. You can combine bots and categories to narrow selection further. Omit categories (or pass []) to allow bots from any category. When categories is set, bots without a category are still included.

Stopping All Bots

Shut everything down cleanly using the stop() method:

Naming Your Cluster

Customize your cluster with a unique name using the clusterName option:

Auto-Restart Every Hour (Optional)

Want to keep things fresh? Here’s how to restart your bots automatically every hour:

πŸ—¨οΈ Join the Community

Need help, support, or just want to chat with other developers? Come hang out with us on Discord! πŸ‘‡

Join Discord

Get help, support, or chat with other developers