Skip to content
SwisserAI LogoSwisserAI
Server Reports HelpSwisserAI HelpOpen app

Manage

Agent and updates

The agent is the small program on your machine. Here is how to update it, check on it and use its commands.

What the agent does

  • It finds your FiveM installation, txAdmin and the database connection by itself.
  • It reads your game data and never changes it. The first read covers everything, after that only the changes.
  • It slows down when your server is busy, so players do not notice it.
  • It checks in regularly. That is how the page knows it is online.
  • It only does what the dashboard allows. You change its settings in the browser, not in a config file.

Updating the agent

When a new version is out, the server settings show Update available under Agent and updates. Open What's new to see the changes, then press Update now.

The update shows its progress: downloading, verifying, installing, restarting, checking, done. It usually takes under a minute. If the new version does not check in within 10 minutes, the agent switches back to the old one by itself.

  • Security updates install automatically. You can also start them yourself.
  • The agent must be online to update.
  • Very old versions are no longer supported. Collection then pauses until the agent is updated. It keeps checking in, so nothing is lost.

Reinstalling once

Agents installed before updates from the dashboard existed need one reinstall. The Agent and updates tab then says Reinstall once to enable one-click updates and shows what to do. Your settings and data stay as they are, and no new code is needed.

  • Linux: run the reinstall command shown in the tab, as root.
  • Windows: download the agent from the tab and double-click it. It asks you to press Enter to install over the current version.

Commands

You rarely need these. They help when something does not work. Open a terminal on the server machine: on Windows a Command Prompt as administrator, on Linux a shell as root.

  • status

    Shows whether the agent is installed and running, and which server it belongs to.

  • doctor

    Checks FiveM, the database and the network, without changing anything.

  • uninstall

    Removes the service and the program. Add --purge to also delete its local data.

  • version

    Prints the version.

With the background service:

sudo swisser-agent doctor

Replace doctor with the command you need.

Where it lives

  • Windows

    Program:C:\Program Files\SwisserAgent
    Local data and logs:C:\ProgramData\SwisserAgent

  • Linux, as root

    Program:/usr/local/lib/swisser-agent
    Local data and logs:/var/lib/swisser-agent

  • Linux, without root

    Program:~/.local/share/swisser-agent
    Local data and logs:~/.local/state/swisser-agent

The service is called SwisserAI Server Reports Agent in the Windows service list, and swisser-agent on Linux.