Choose Your Setup
Decide whether you should start with 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 setup | GUI Mode | Best first-run path and easiest to explore |
| Run long-lived sessions on a VPS or shared machine | Dedicated Server | Keeps the backend running even when the GUI is closed |
| Automate from a terminal or run headless | CLI Mode | Good for scripts, SSH sessions, and keyboard-only workflows |
| Share one backend with multiple users or clients | Dedicated Server | GUI and CLI clients can connect to the same remote server |
What each part means
GUI client
The GUI is the desktop app. It is the best place to create instances, change settings, inspect state, and work with plugins or scripts.
CLI client
The CLI is the terminal client. It is useful when you want automation, SSH-based workflows, or a headless environment.
Integrated server
The GUI and CLI both ship with an integrated SoulFire server. This lets you run sessions locally on your own machine without deploying anything else.
Dedicated server
A dedicated server is a separate SoulFire backend that runs on its own machine or as its own process. GUI and CLI clients can connect to it remotely.
Recommended paths
New user
- Install SoulFire
- Run your first session in GUI mode
- Use How-to Guides for accounts, proxies, plugins, and integrations
Remote operator
- Deploy a dedicated server
- Connect from the GUI with the server URL and access token
- Use How-to Guides for ongoing administration tasks
Automation-heavy user
- Decide whether the CLI should run locally or against a remote server
- Read CLI Mode
- Keep CLI Flags open as your reference
Learn more
For the deeper architectural explanation, see Operation Modes.
How is this page?
Last updated on