CLI Arguments
Paper provides CLI arguments you can set to configure certain behavior. CLI arguments are always added directly after the server file name when starting the server. For example:
java -jar server.jar --nogui--nogui is referred to as a CLI argument (more specifically, as it has no value, a flag).
This page acts as a reference to all arguments Paper provides.
Some of these options are direct counterparts to settings you can modify in the server.properties file.
The CLI arguments always override those set in the server.properties file.
-?, --help
Section titled “-?, --help”Prints a help message with all CLI arguments you may pass. Using this flag will not start the server.
-C, --commands-settings <commands yml file>
Section titled “-C, --commands-settings <commands yml file>”The path towards the command settings file. Defaults to commands.yml.
-P, --plugins <plugin directory>
Section titled “-P, --plugins <plugin directory>”The directory to look in for plugin JARs. Defaults to plugins.
-S, --spigot-settings <yml file>
Section titled “-S, --spigot-settings <yml file>”The path towards the Spigot configuration file. Defaults to spigot.yml.
-W, --universe, --world-container, --world-dir <world directory>
Section titled “-W, --universe, --world-container, --world-dir <world directory>”The folder to put other world folders into. Defaults to . (this folder).
--add-extra-plugin-dir, --add-plugin-dir <directory>
Section titled “--add-extra-plugin-dir, --add-plugin-dir <directory>”Additional directory to look for plugin files in. May be specified multiple times for more than one extra plugin directory.
--add-extra-plugin-jar, --add-plugin <jar file>
Section titled “--add-extra-plugin-jar, --add-plugin <jar file>”Additional plugin JAR file to load. May be specified multiple times for multiple plugin JARs.
-b, --bukkit-settings <yml file>
Section titled “-b, --bukkit-settings <yml file>”The path towards the Bukkit configuration file. Defaults to bukkit.yml.
-c, --config <properties file>
Section titled “-c, --config <properties file>”The path towards the Minecraft server properties file. Defaults to server.properties.
--demo
Section titled “--demo”Whether to load the server in demo mode. This results in always the same world being generated and additional demo reminders and help messages being sent.
--eraseCache
Section titled “--eraseCache”Whether to force cache erase during world upgrades. This removes data such as heightmap and light data, which may be useful if you want to force recalculate those.
--forceUpgrade
Section titled “--forceUpgrade”Whether to force a full world upgrade on server start.
-h, --host, --server-ip <hostname or ip>
Section titled “-h, --host, --server-ip <hostname or ip>”The host to listen on.
--initSettings
Section titled “--initSettings”Whether to only create setting files and then shut down the server before creating any worlds. This is useful if you want to first set some configuration values, which may be relevant during world creation.
--jfrProfile
Section titled “--jfrProfile”Whether to enable JFR (Java Flight Recorder) profiling.
--noconsole
Section titled “--noconsole”Disables the console.
--nogui
Section titled “--nogui”Disables the graphical interface.
--nojline
Section titled “--nojline”Disables JLine and emulates the Vanilla console.
-o, --online-mode <true|false>
Section titled “-o, --online-mode <true|false>”Whether to use online authentication.
-p, --port, --server-port <port>
Section titled “-p, --port, --server-port <port>”The port to listen on.
--paper, --paper-settings <yml file>
Section titled “--paper, --paper-settings <yml file>”The legacy Paper settings file path. Defaults to paper.yml.
--paper-dir, --paper-settings-directory <config directory>
Section titled “--paper-dir, --paper-settings-directory <config directory>”Path to the Paper settings directory. Defaults to config.
--pidFile <path>
Section titled “--pidFile <path>”Path to the PID file.
--recreateRegionFiles
Section titled “--recreateRegionFiles”Whether to recreate region files during world upgrades.
-s, --max-players, --size <value>
Section titled “-s, --max-players, --size <value>”The maximum amount of players.
--safeMode
Section titled “--safeMode”Loads worlds only with the Vanilla datapack enabled.
--server-name <name>
Section titled “--server-name <name>”The name of the server. Defaults to Unknown Server.
--serverId <string>
Section titled “--serverId <string>”Sets the server identifier, which is used in crash files.
-v, --version
Section titled “-v, --version”Prints the CraftBukkit version. This option prevents the server from starting.
-w, --level-name, --world <name>
Section titled “-w, --level-name, --world <name>”Sets the world name.