Skip to content
On this page

Docs / Getting started

Install the CLI

The fivedock CLI runs on the machine your servers live on. It pairs that machine with your workspace, reads your server.cfg, and starts backups from the terminal.

Install

Windows, in PowerShell:

PowerShell
irm https://fivedock.dev/install.ps1 | iex

Linux x86_64, in a shell:

bash
curl -fsSL https://fivedock.dev/install.sh | sh

Anywhere with Node.js 24 or newer:

npm
npm i -g fivedock

A minimal Linux install may also need libatomic: apt-get install -y libatomic1. The install script tells you when it is missing.

Rather download it yourself? fivedock-windows-x64.exe · fivedock-linux-x64 · SHA256SUMS

Pair this machine

It prints six characters. An owner or admin types them in under Machines in the panel, and the CLI collects its credential on its own.

shell
fivedock login

Add a server

Point it at a server.cfg. It reads the key, the database and the folders to back up, and claims the server for your workspace.

shell
fivedock servers add /home/fivem/server-data/server.cfg

Back it up

Pick db, files or full. The agent on that server does the work, and you can watch it in the panel under Time Machine.

shell
fivedock backup my-city full

Find what lags

Records the server’s profiler for 10 seconds and asks the players for their FPS, then names the heaviest resources down to the file and line.

shell
fivedock perf my-city
Next: install the agent