Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including fivem-docker-cli with all npm packages installed. Try it out:

var fivemDockerCli = require("fivem-docker-cli")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

fivem-docker-cli v0.1.10

Command-line tool to create and administer FiveM Servers running in Docker.

fivem-docker-cli

oclif Version Downloads/week License

** Under Development - Use at your own risk. **

Command-line tool to create and administer FiveM Servers running in Docker.

* [Prerequisites](#prerequisites) * [Usage](#usage) * [Commands](#commands)

Prerequisites

* Linux-based OS (preferably CentOS) * Docker (tested on v1.13) * Node/NPM

Usage

```sh-session $ npm install -g fivem-docker-cli $ fivem COMMAND running command... $ fivem (-v|--version|version) fivem-docker-cli/0.1.10 win32-x64 node-v8.11.3 $ fivem --help [COMMAND] USAGE $ fivem COMMAND ... ```

Commands

* [`fivem delete`](#fivem-delete) * [`fivem help [COMMAND]`](#fivem-help-command) * [`fivem init`](#fivem-init) * [`fivem restart`](#fivem-restart) * [`fivem start`](#fivem-start) * [`fivem status`](#fivem-status) * [`fivem stop`](#fivem-stop)

fivem delete

Deletes a FiveM server Docker container.

USAGE
  $ fivem delete

OPTIONS
  -i, --serverid=serverid      ID of the FiveM Docker container.
  -s, --servername=servername  Name of the FiveM Docker container.

See code: src\commands\delete.js

fivem help [COMMAND]

display help for fivem

USAGE
  $ fivem help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

fivem init

Creates a new FiveM server running in Docker.

USAGE
  $ fivem init

OPTIONS
  -k, --licensekey=licensekey  Server license key - This can be obtained from https://keymaster.fivem.net.
  -p, --rconpass=rconpass      Password for RCON access.
  -s, --servername=servername  Name of the FiveM Docker container.

See code: src\commands\init.js

fivem restart

Restarts a FiveM server Docker container.

USAGE
  $ fivem restart

OPTIONS
  -i, --serverid=serverid      ID of the FiveM Docker container.
  -s, --servername=servername  Name of the FiveM Docker container.

See code: src\commands\restart.js

fivem start

Starts a FiveM server Docker container.

USAGE
  $ fivem start

OPTIONS
  -i, --serverid=serverid      ID of the FiveM Docker container.
  -s, --servername=servername  Name of the FiveM Docker container.

See code: src\commands\start.js

fivem status

Display status of all FiveM server Docker containers.

USAGE
  $ fivem status

See code: src\commands\status.js

fivem stop

Stops a FiveM server Docker container.

USAGE
  $ fivem stop

OPTIONS
  -i, --serverid=serverid      ID of the FiveM Docker container.
  -s, --servername=servername  Name of the FiveM Docker container.

See code: src\commands\stop.js

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free