Commands and Syntax¶
Commands and syntax available for Wilfred. Documentation is automatically generated from source code using sphinx-click
wilfred¶
Wilfred - A CLI for managing game servers using Docker.
Website - https://wilfredproject.org
Official documentation - https://docs.wilfredproject.org
Source code - https://github.com/wilfred-dev/wilfred
Discord server for support - https://wilfredproject.org/discord
wilfred [OPTIONS] COMMAND [ARGS]...
Options
-
--version
¶
Print version and exit
-
--path
¶
Print paths for configurations and server data
command¶
Send command to STDIN of server
wilfred command [OPTIONS] NAME COMMAND
Arguments
-
NAME
¶
Required argument
-
COMMAND
¶
Required argument
config¶
Manage server configuration (for supported filetypes)
wilfred config [OPTIONS] NAME [VARIABLE] [VALUE]
Arguments
-
NAME
¶
Required argument
-
VARIABLE
¶
Optional argument
-
VALUE
¶
Optional argument
console¶
Attach to server console, view log and run commands
NAME is the name of the server
wilfred console [OPTIONS] NAME
Arguments
-
NAME
¶
Required argument
create¶
Create a new server.
wilfred create [OPTIONS]
Options
-
--console
¶
Attach to server console immediately after creation.
-
--detach
¶
Immediately detach during install.
delete¶
Delete existing server.
NAME is the name of the server
wilfred delete [OPTIONS] NAME
Options
-
-f
,
--force
¶
Force action without confirmation
Arguments
-
NAME
¶
Required argument
edit¶
Edit server (name, memory, port, environment variables)
NAME is the name of the server
wilfred edit [OPTIONS] NAME
Arguments
-
NAME
¶
Required argument
images¶
List images available on file.
wilfred images [OPTIONS]
Options
-
--refresh
¶
Download the default images from GitHub
-
--repo
<repo>
¶ Specify repo to fetch images from during image refresh
- Default
wilfred-dev/images
-
--branch
<branch>
¶ Specify branch to fetch images from during image refresh
- Default
master
kill¶
Forcefully kill running server
NAME is the name of the server
wilfred kill [OPTIONS] NAME
Options
-
-f
,
--force
¶
Force action without confirmation
Arguments
-
NAME
¶
Required argument
restart¶
Restart server
NAME is the name of the server
wilfred restart [OPTIONS] NAME
Options
-
--console
¶
Attach to server console immediately after start.
Arguments
-
NAME
¶
Required argument
start¶
Start server
NAME is the name of the server
wilfred start [OPTIONS] NAME
Options
-
--console
¶
Attach to server console immediately after start.
Arguments
-
NAME
¶
Required argument