Skip to Content
Server OpsServer Commands
Report an error
Open in ChatGPTOpen in Claude

Server Commands

FXServer accepts commands typed directly into its console — whether that’s the terminal running run.sh/run.cmd, or the live console tab in txAdmin. This is a reference for the commands you’ll use day to day.

Resource Lifecycle Commands

These control individual resources while the server is running.

CommandEffect
start <resource>Starts a resource that isn’t currently running. No-op if it’s already started.
stop <resource>Stops a running resource.
restart <resource>Stops and starts a resource in one step. Use after updating a resource’s files.
ensure <resource>Starts the resource if stopped, or restarts it if already running. This is the command most server.cfg files use to load resources at boot, since it’s idempotent.
refreshRescans the resources/ directory and updates the server’s resource list. Run this after adding or removing a resource folder, before you can start/ensure it.
# typical server.cfg pattern ensure spawnmanager ensure mapmanager ensure basic-gamemode ensure qb-core

Server Process Commands

CommandEffect
quitShuts down the FXServer process.
quit <reason>Shuts down the server and broadcasts <reason> to connected clients before disconnecting them.

In a txAdmin-managed setup, prefer txAdmin’s own restart/stop controls in the web UI over calling quit directly from the console — txAdmin tracks process state and will otherwise treat an unexpected exit as a crash and try to auto-restart it.

Configuration Commands

These are used inside server.cfg (or interactively) to set convars and load config files.

CommandEffect
set <convar> <value>Sets a convar for this server process only.
setr <convar> <value>Sets a convar and replicates it to connected clients (used for client-visible settings, e.g. setr voice_useNativeAudio true).
sets <convar> <value>Publishes a server-info convar (e.g. sets docs_region "Europe"); it does not replace Portal editing of the managed listing fields.
exec <file>Loads and runs another .cfg file, useful for splitting config into multiple files (permissions, resources, secrets).

The Cfx metadata announcement  keeps existing server.cfg listing metadata working during the transition until 21 October 2026. From that date, edit public names, tagline, description, tags, language, banner and icon in the Cfx Portal . Resource lifecycle commands and custom convars remain part of the server setup. See the migration checklist.

Permission Commands (ACE)

FiveM’s permission system is built on ACE (Access Control Entries) and principals. Full details, including how principal inheritance and identifiers work, are covered in Security / Permissions — this is just the command syntax:

CommandEffect
add_ace <principal> <object> allow / denyGrants or denies a principal (player, identifier, or group) access to a command or resource object.
remove_ace <principal> <object> allow / denyRemoves a previously added ACE entry.
add_principal <principal> <group>Adds a principal to a group (e.g. adds a player identifier to group.admin).
remove_principal <principal> <group>Removes a principal from a group.
# example: grant a player admin-level command access add_principal identifier.license:abcdef1234567890 group.admin add_ace group.admin command allow

Diagnostic / Logging Commands

CommandEffect
con_miniconChannels <channels>Filters which console channels are shown in the in-game F8 developer console, useful for cutting log noise while debugging.

For broader logging setup (log files, log levels, external log shipping), see Logging.

Notes

  • Commands typed into the txAdmin console are equivalent to typing them into the raw server terminal — txAdmin just proxies stdin/stdout.
  • Custom resources can register their own console commands (via the RegisterCommand client/server native), so your server may expose additional commands beyond this list depending on what’s installed.