ephervex instance

Operate on one client instance

Usage and options

Operate on one client instance

Usage: ephervex instance [OPTIONS] <COMMAND>

Commands:
  create      Create a client instance
  show        Show one client instance in full
  stop        Stop a running launch of this instance that a background process owns
  duplicate   Copy an instance, files and all, into a new one
  recipe      Show the pack recipe this instance retained when it was imported
  open        Open one of an instance's folders in the desktop's file manager
  runtime     Show or change this instance's own Java and JVM settings
  delete      Remove a client instance from the index
  persist     Keep a temporary instance for good, by moving it out of temporary storage
  favorite    Mark an instance as a favorite so it lists first
  unfavorite  Remove an instance's favorite mark
  group       Put an instance in a group, or take it out of its group with `--none`
  icon        Set an instance's icon from a PNG or JPEG file, or remove it with `--clear`
  issue       Show, set, or remove the issue link of an instance
  case        Show or change the case notes of an instance
  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 instance create

Create a client instance

Usage: ephervex instance create [OPTIONS] --minecraft <MINECRAFT> <NAME>

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

Options:
      --json
          Emit machine-readable JSON where the command supports it
      --minecraft <MINECRAFT>
          Minecraft version id, e.g. `1.20.1`
      --loader <LOADER>
          [default: vanilla] [possible values: vanilla, forge, neoforge]
      --loader-version <LOADER_VERSION>
          Exact loader build. Required for Forge and NeoForge
      --temporary
          Store under the OS temporary directory (the default)
      --persistent
          Store under the persistent instance root
  -h, --help
          Print help

ephervex instance show

Show one client instance in full

Usage: ephervex instance show [OPTIONS] <ID>

Arguments:
  <ID>

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

ephervex instance stop

Stop a running launch of this instance that a background process owns.

Works from any command after the launch started, including one started by `ephervex launch --detach` or by the desktop application. The game is ended at once unless --graceful asks its processes to terminate instead, which Minecraft may answer slowly or not at all. A launch whose background process is gone cannot be reached this way; the desktop application's force stop handles it.

Usage: ephervex instance stop [OPTIONS] <ID>

Arguments:
  <ID>


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

      --launch <HANDLE>
          Which launch, for an instance running more than one alongside

      --graceful
          Ask the game to terminate instead of ending it

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

ephervex instance duplicate

Copy an instance, files and all, into a new one

Usage: ephervex instance duplicate [OPTIONS] <ID>

Arguments:
  <ID>


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

      --name <NAME>
          The copy's name. Defaults to the original's plus " (copy)"

      --temporary
          Store the copy under the OS temporary directory

      --persistent
          Store the copy under the persistent instance root

      --drop-absent-mods
          Leave out mods the original records but no longer has in its mods folder.

          By default the copy records them too, so repairing it fetches them again. Use this when the original is mid-bisection and the copy should describe only what it actually has.

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

ephervex instance recipe

Show the pack recipe this instance retained when it was imported.

Read from the instance's own `.launcher/source/`, never from the original archive. Server creation uses this retained recipe.

Usage: ephervex instance recipe [OPTIONS] <ID>

Arguments:
  <ID>


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

      --side <SIDE>
          Which side to plan for. The server plan lists what "Create Server" installs by default, including mods the pack does not say belong on a server

          [default: client]
          [possible values: client, server]

      --all-optional
          Include the optional files that were not selected at import time

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

ephervex instance open

Open one of an instance's folders in the desktop's file manager

Usage: ephervex instance open [OPTIONS] <ID>

Arguments:
  <ID>

Options:
      --folder <FOLDER>  Which folder: root, minecraft, mods, config, logs, crash-reports, resourcepacks, shaderpacks, or saves [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 instance runtime

Show or change this instance'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 instance would run with, the Java its Minecraft and loader expect, and whether the two fit.

Usage: ephervex instance runtime [OPTIONS] <ID>

Arguments:
  <ID>


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 instance delete

Remove a client instance from the index.

Its linked servers are deleted with it, and so are their worlds unless `--keep-files` is given. A running one refuses the deletion unless `--stop-linked-servers` is given.

Unless `--keep-files` is given, this asks for confirmation first, naming the instance and every linked server that goes with it. Without a terminal to ask on, pass `--yes`. The servers that were deleted are listed afterwards.

Usage: ephervex instance delete [OPTIONS] <ID>

Arguments:
  <ID>


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

      --keep-files
          Leave the instance directory on disk

      --yes
          Delete the instance and its linked servers without asking

      --stop-linked-servers
          Stop running linked servers first instead of refusing. With `--keep-files` they are shut down cleanly where they allow it, and killed otherwise

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

ephervex instance persist

Keep a temporary instance for good, by moving it out of temporary storage.

The instance keeps its name, its mods, its saves, its logs and its linked servers. Only its location changes, from the system temporary directory, which the operating system clears whenever it likes, to your persistent instance folder. This is not the same as duplicating it into that folder, which would leave the original behind.

Every temporary server linked to the instance moves with it unless you say otherwise. This cannot be undone by running it in reverse: delete the instance when you no longer want to keep it.

The command exits with an error when the instance moved but a server you asked to keep could not be moved. It is still temporary then, and the output says why.

Usage: ephervex instance persist [OPTIONS] <ID>

Arguments:
  <ID>


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

      --server <SERVER>
          Move only this linked server. Repeatable, and naming any server at all leaves every server you did not name where it is

      --no-servers
          Move the instance alone and leave its linked servers temporary

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

ephervex instance favorite

Mark an instance as a favorite so it lists first

Usage: ephervex instance favorite [OPTIONS] <ID>

Arguments:
  <ID>

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

ephervex instance unfavorite

Remove an instance's favorite mark

Usage: ephervex instance unfavorite [OPTIONS] <ID>

Arguments:
  <ID>

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

ephervex instance group

Put an instance in a group, or take it out of its group with `--none`.

The group must already exist; see `ephervex groups create`. Grouping never moves the instance or changes its id.

Usage: ephervex instance group [OPTIONS] <ID> [NAME]

Arguments:
  <ID>


  [NAME]
          The group's name, without regard to case

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

      --none
          Leave the instance in no group

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

ephervex instance icon

Set an instance'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; the original file is not kept or referenced. Without an icon, the instance shows its loader's symbol. `--json` reports the stored file as `icon`.

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

Arguments:
  <ID>


  [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 instance issue

Show, set, or remove the issue link of an instance.

The link points at the bug report or issue the instance reproduces, and the desktop application shows it with the instance. With no options, prints the current link. A link is a full http:// or https:// address without a user name or password, at most 2048 bytes long. It is stored exactly as given. `--json` reports it as `issue_link`.

Usage: ephervex instance issue [OPTIONS] <ID> [URL]

Arguments:
  <ID>


  [URL]
          The issue address, such as https://github.com/owner/repo/issues/42

Options:
      --clear
          Remove the issue link

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

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

ephervex instance case

Show or change the case notes of an instance.

The case is what you write down while reproducing a bug: the steps, a note, and how often the bug showed up again. With no action, prints them. Steps are named by the number shown beside them. `--json` reports `steps` (each with `id`, `text` and `done`), `note` and `reproduced`.

Usage: ephervex instance case [OPTIONS] <ID> [COMMAND]

Commands:
  add-step     Add a step at the end of the list
  done         Mark a step as done
  undo         Mark a step as not done
  remove-step  Remove a step
  note         Replace the note, or remove it with `--clear`
  reproduced   Count one more time the bug showed up, or start over with `--reset`
  history      List what happened to the instance: when it was created, launched and stopped, and what its log complained about
  help         Print this message or the help of the given subcommand(s)

Arguments:
  <ID>


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

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

ephervex instance case add-step

Add a step at the end of the list

Usage: ephervex instance case <ID> add-step [OPTIONS] <TEXT>

Arguments:
  <TEXT>  What to do, such as "Place a belt and fill it"

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

ephervex instance case done

Mark a step as done

Usage: ephervex instance case <ID> done [OPTIONS] <STEP>

Arguments:
  <STEP>  The number shown beside the step

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

ephervex instance case undo

Mark a step as not done

Usage: ephervex instance case <ID> undo [OPTIONS] <STEP>

Arguments:
  <STEP>  The number shown beside the step

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

ephervex instance case remove-step

Remove a step

Usage: ephervex instance case <ID> remove-step [OPTIONS] <STEP>

Arguments:
  <STEP>  The number shown beside the step

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

ephervex instance case note

Replace the note, or remove it with `--clear`

Usage: ephervex instance case <ID> note [OPTIONS] [TEXT]

Arguments:
  [TEXT]  The new note

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

ephervex instance case reproduced

Count one more time the bug showed up, or start over with `--reset`

Usage: ephervex instance case <ID> reproduced [OPTIONS]

Options:
      --json   Emit machine-readable JSON where the command supports it
      --reset  Set the count back to zero
  -h, --help   Print help

ephervex instance case history

List what happened to the instance: when it was created, launched and stopped, and what its log complained about

Usage: ephervex instance case <ID> history [OPTIONS]

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