Skip to main content

ephervex instances

Operate on the set of client instances

Usage and options​

Operate on the set of client instances

Usage: ephervex instances [OPTIONS] <COMMAND>

Commands:
  list  List client instances, optionally narrowed and ordered
  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 instances list​

List client instances, optionally narrowed and ordered.

Every filter that is given must match. Favorites come first unless `--sort` or the interface's chosen order says otherwise. Equal values are ordered newest first, then by id, so the order is stable.

Usage: ephervex instances list [OPTIONS]

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

      --search <TEXT>
          Only instances whose name, Minecraft version, loader, source or group contains this text, without regard to case

      --favorite
          Only favorites

      --group <NAME>
          Only instances in this group

      --ungrouped
          Only instances that are in no group

      --minecraft <VERSION>
          Only instances on this exact Minecraft version

      --loader <LOADER>
          Only instances using this loader

          [possible values: vanilla, forge, neoforge]

      --running
          Only instances that are launching or running

      --stopped
          Only instances that are neither launching nor running

      --linking <LINKING>
          Only instances with this relation to linked servers: `paired` has a paired server, `servers` has linked servers but none paired, `none` has no linked server

          [possible values: paired, servers, none]

      --sort <SORT>
          Order the list by this key. Defaults to the order chosen in the interface, which starts as `favorite`.

          `favorite` puts favorites first, `name` ignores case and orders numbers by value ("test 2" before "test 10"), `minecraft` puts the newest release first, and `loader` orders by loader and then by newest loader version.

          [possible values: favorite, name, minecraft, loader]

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