Skip to main content

ephervex server

Operate on one server

Usage and options​

Operate on one server

Usage: ephervex server [OPTIONS] <COMMAND>

Commands:
  create      Create and fully install an exact server selection
  install     Install the exact base for an existing uninstalled server record
  show        Show canonical server metadata
  runtime     Show or change this server's own Java and JVM settings
  favorite    Mark a server as a favorite so it lists first in the interface
  unfavorite  Remove a server's favorite mark
  icon        Set a server's icon from a PNG or JPEG file, or remove it with `--clear`
  mods        List the mods a server has, and whether the loader will load each one
  crash       Explain the newest crash and name the mods it points at
  status      Show persistence, installation, runtime, and capture status
  properties  Read or change `server.properties` through managed services
  network     Change typed network settings
  eula        Inspect, explicitly accept, or revoke global Minecraft EULA consent
  start       Start in the foreground and stream server output
  stop        Request a graceful stop and wait up to 30 seconds
  restart     Gracefully stop and respawn through the live supervisor
  kill        Force termination through the live owner channel
  console     Send one line to the live server console
  output      Show retained combined launcher output
  recover     Inspect or conservatively clear runtime evidence
  open        Open one of a server's folders in the desktop's file manager
  delete      Delete a server and, unless requested, its files
  help        Print this message or the help of the given subcommand(s)

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server create​

Create and fully install an exact server selection

Usage: ephervex server create [OPTIONS] <NAME>

Arguments:
  <NAME>
          Display name. Never used to build a path

Options:
      --json
          Emit machine-readable JSON where the command supports it

      --minecraft <MINECRAFT>
          Exact Minecraft version for a standalone server

      --loader <LOADER>
          Loader for a standalone server

          [default: vanilla]
          [possible values: vanilla, forge, neoforge]

      --loader-version <LOADER_VERSION>
          Exact loader build. Required for Forge and NeoForge

      --client <CLIENT>
          Derive the exact Minecraft and loader selection from this client

      --java <JAVA>
          Use this Java executable for installation

      --include-unknown <PATH>
          Reconstruct only these files whose server applicability is undeclared.

          A linked server reconstructs every such file by default, because a pack format that declares no server side (CurseForge does not) would otherwise leave the server holding none of its pack. Naming paths here narrows that to the ones given. Repeatable, and matched against the retained recipe's logical paths.

      --skip-unknown
          Reconstruct none of the files whose server applicability is undeclared

      --server-pack <FILE>
          Install this published server archive as the server's content.

          Many packs publish server files of their own. Those files are what the author decided the server contains, so they are copied in as they are: nothing is looked up, no mod list is planned, and no optional file is decided. Works for a standalone server and for one built from a client.

          Ephervex still installs the loader and its libraries, for every server, even when the archive ships them. An archive's installer jar and start script are never run, and its `libraries` folder and `eula.txt` are left out. Everything else in the archive is installed.

          The Minecraft release and loader must match the ones the archive was made for. An archive with mods needs a loader, and one whose installer jar or libraries name a loader build is refused for any other release, loader, or build.

      --temporary
          Store under the OS temporary directory (the default)

      --persistent
          Store under the persistent instance root

  -h, --help
          Print help (see a summary with '-h')

ephervex server install​

Install the exact base for an existing uninstalled server record

Usage: ephervex server install [OPTIONS] <ID>

Arguments:
  <ID>
          The server to install

Options:
      --java <JAVA>


      --json
          Emit machine-readable JSON where the command supports it

      --server-pack <FILE>
          Install this published server archive as the server's content.

          See `ephervex server create --help` for what the archive decides and what Ephervex still installs itself.

  -h, --help
          Print help (see a summary with '-h')

ephervex server show​

Show canonical server metadata

Usage: ephervex server show [OPTIONS] <ID>

Arguments:
  <ID>  The server to show

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server runtime​

Show or change this server's own Java and JVM settings.

Each value falls back to the global setting until it is pinned here. An option changes only its own value and keeps the others as pinned. With no options, prints what is pinned, the Java runtime the server would run with, the Java its Minecraft and loader expect, and whether the two fit. A change needs the server to be stopped.

Usage: ephervex server runtime [OPTIONS] <ID>

Arguments:
  <ID>
          The server to show or change

Options:
      --java <PATH>
          Use this Java executable instead of the selected one

      --json
          Emit machine-readable JSON where the command supports it

      --min-memory <MIB>
          Minimum heap size in MiB

      --max-memory <MIB>
          Maximum heap size in MiB

      --jvm-arg <ARG>
          One extra JVM argument. Repeatable, and replaces the pinned list

      --clear
          Remove every override and follow the global settings again

  -h, --help
          Print help (see a summary with '-h')

ephervex server favorite​

Mark a server as a favorite so it lists first in the interface

Usage: ephervex server favorite [OPTIONS] <ID>

Arguments:
  <ID>  The server to mark as a favorite

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server unfavorite​

Remove a server's favorite mark

Usage: ephervex server unfavorite [OPTIONS] <ID>

Arguments:
  <ID>  The server to remove the mark from

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server icon​

Set a server's icon from a PNG or JPEG file, or remove it with `--clear`.

The image is checked, scaled down to at most 256 pixels and stored by content. `--json` reports the stored file as `icon`.

Usage: ephervex server icon [OPTIONS] <ID> [PATH]

Arguments:
  <ID>
          The server whose icon to set

  [PATH]
          The image file to use

Options:
      --clear
          Remove the icon

      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server mods​

List the mods a server has, and whether the loader will load each one.

A server reconstructed from a client pack carries whatever the pack declared, including mods that only ever run on a client. Use `ephervex mod disable --server` to leave one out without removing it.

Usage: ephervex server mods [OPTIONS] <ID>

Arguments:
  <ID>
          The server whose mods to list

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server crash​

Explain the newest crash and name the mods it points at.

Reads the server's most recent crash report, and the tail of its log, and lists the mods they attribute the failure to, most confident first. Nothing is changed: use `ephervex mod disable --server` to act on it.

Usage: ephervex server crash [OPTIONS] <ID>

Arguments:
  <ID>
          The server whose newest crash to explain

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server status​

Show persistence, installation, runtime, and capture status

Usage: ephervex server status [OPTIONS] <ID>

Arguments:
  <ID>  The server to show

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server properties​

Read or change `server.properties` through managed services

Usage: ephervex server properties [OPTIONS] <COMMAND>

Commands:
  show  Show the line-preserving properties document
  set   Set an untyped property; managed network and EULA keys are refused
  help  Print this message or the help of the given subcommand(s)

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server properties show​

Show the line-preserving properties document

Usage: ephervex server properties show [OPTIONS] <ID>

Arguments:
  <ID>  The server whose properties to show

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server properties set​

Set an untyped property; managed network and EULA keys are refused.

A stopped server reads the value when it next starts. A server running under Ephervex keeps running and reads it once restarted; use `ephervex server restart` when you want that.

Usage: ephervex server properties set [OPTIONS] <ID> <KEY> <VALUE>

Arguments:
  <ID>
          The server whose property to set

  <KEY>
          The property key, as written in `server.properties`

  <VALUE>
          The value to store

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server network​

Change typed network settings

Usage: ephervex server network [OPTIONS] <--online-mode[=<BOOL>]|--access <ACCESS>|--port <PORT>|--address <ADDRESS>> <ID>

Arguments:
  <ID>  The server to change

Options:
      --json                  Emit machine-readable JSON where the command supports it
      --online-mode[=<BOOL>]  Require authenticated Minecraft accounts. Pass `--online-mode=false` to turn it off [possible values: true, false]
      --access <ACCESS>       Network exposure for the server listener [possible values: localhost, lan, custom]
      --port <PORT>           TCP port; zero is invalid
      --address <ADDRESS>     IP address for `--access custom`; the stored address is kept when omitted
  -h, --help                  Print help

ephervex server eula​

Inspect, explicitly accept, or revoke global Minecraft EULA consent

Usage: ephervex server eula [OPTIONS] <COMMAND>

Commands:
  status  Show global Minecraft EULA consent status
  accept  Review and explicitly accept in an interactive terminal
  revoke  Revoke current global consent
  help    Print this message or the help of the given subcommand(s)

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server eula status​

Show global Minecraft EULA consent status

Usage: ephervex server eula status [OPTIONS]

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server eula accept​

Review and explicitly accept in an interactive terminal

Usage: ephervex server eula accept [OPTIONS]

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server eula revoke​

Revoke current global consent

Usage: ephervex server eula revoke [OPTIONS]

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server start​

Start in the foreground and stream server output.

Ctrl-C, a terminal hangup, a termination signal, or output that is no longer being read stops the server gracefully; Ctrl-C or a signal again kills the server. Exits with a non-zero status when the server exits before it finished starting or ends with an error without having been asked to stop.

With --detach the server is supervised by a background process instead: the command returns once the server is running, and the server keeps running after this command, its terminal, and any Ephervex window have ended. Stop, restart, kill, console, status, and output work on it from any later command.

Usage: ephervex server start [OPTIONS] <ID>

Arguments:
  <ID>
          The server to start

Options:
      --java <JAVA>


      --json
          Emit machine-readable JSON where the command supports it

      --detach
          Run the server in the background and return once it is running

  -h, --help
          Print help (see a summary with '-h')

ephervex server stop​

Request a graceful stop and wait up to 30 seconds.

Exits with a non-zero status when the running server refused the request.

Usage: ephervex server stop [OPTIONS] <ID>

Arguments:
  <ID>
          The server to stop

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server restart​

Gracefully stop and respawn through the live supervisor.

Exits with a non-zero status when the request was refused or the server stopped but could not be started again.

Usage: ephervex server restart [OPTIONS] <ID>

Arguments:
  <ID>
          The server to restart

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server kill​

Force termination through the live owner channel.

Exits with a non-zero status when the running server refused the request.

Usage: ephervex server kill [OPTIONS] <ID>

Arguments:
  <ID>
          The server to kill

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server console​

Send one line to the live server console.

Exits with a non-zero status when the server did not accept the line.

Usage: ephervex server console [OPTIONS] <ID> <COMMAND>

Arguments:
  <ID>
          The server to send the line to

  <COMMAND>
          The console line, as typed into the server console

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex server output​

Show retained combined launcher output

Usage: ephervex server output [OPTIONS] <ID>

Arguments:
  <ID>  The server whose output to show

Options:
      --json           Emit machine-readable JSON where the command supports it
      --lines <LINES>  [default: 200]
  -h, --help           Print help

ephervex server recover​

Inspect or conservatively clear runtime evidence

Usage: ephervex server recover [OPTIONS] <COMMAND>

Commands:
  status  Classify recorded supervisor and Java-child identities
  clear   Clear runtime evidence only after every recorded process is proven dead
  help    Print this message or the help of the given subcommand(s)

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server recover status​

Classify recorded supervisor and Java-child identities

Usage: ephervex server recover status [OPTIONS] <ID>

Arguments:
  <ID>  The server to inspect

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server recover clear​

Clear runtime evidence only after every recorded process is proven dead

Usage: ephervex server recover clear [OPTIONS] <ID>

Arguments:
  <ID>  The server whose runtime evidence to clear

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex server open​

Open one of a server's folders in the desktop's file manager

Usage: ephervex server open [OPTIONS] <ID>

Arguments:
  <ID>  The server whose folder to open

Options:
      --folder <FOLDER>  Which folder: root, server, mods, config, logs, crash-reports, or world [default: root]
      --json             Emit machine-readable JSON where the command supports it
      --print            Print the path without handing it to a file manager
  -h, --help             Print help

ephervex server delete​

Delete a server and, unless requested, its files

Usage: ephervex server delete [OPTIONS] <ID>

Arguments:
  <ID>  The server to delete

Options:
      --json        Emit machine-readable JSON where the command supports it
      --keep-files  Leave the server directory on disk
  -h, --help        Print help