SoulFire LogoSoulFire

Choose Your Setup

Choose the local GUI, CLI automation, or a remote dedicated server.

If you are unsure, choose GUI + integrated server (local). It is the recommended default for first-time users.

The short version

If you want to...Start with...Why
Learn SoulFire with the least setupGUI ModeRequires the fewest setup steps
Keep bots running on a VPS or shared machineDedicated ServerKeeps the backend running even when the GUI is closed
Automate from a terminal or use a system without a desktopCLI ModeWorks well for scripts and SSH sessions
Share one backend with multiple users or clientsDedicated ServerGUI and CLI clients can connect to the same remote server

What each part means

GUI client

The GUI is the desktop app. Use it to create instances, change settings, view bot state, and manage plugins or scripts.

CLI client

The CLI is the terminal client. Use it for automation, SSH sessions, or systems without a desktop.

Integrated server

The GUI and CLI include a SoulFire server. You can run bots on your computer without a separate server.

Dedicated server

A dedicated server runs SoulFire separately, usually on another computer. GUI and CLI clients connect to it over the network.

New user

  1. Install SoulFire
  2. Run your first bots in GUI mode
  3. Use How-to Guides for accounts, proxies, plugins, and integrations

Remote operator

  1. Deploy a dedicated server
  2. Connect from the GUI with the server URL and access token
  3. Use How-to Guides for ongoing administration tasks

Automation user

  1. Decide whether the CLI will use a local or remote server
  2. Read CLI Mode
  3. Read Automation and choose an automation method
  4. Keep CLI Flags open as your reference

Learn more

For the deeper architectural explanation, see Operation Modes.

How is this page?

Last updated on

On this page