Command Line
The CLI and desktop app use the same Ephervex accounts, instances, servers,
and settings. Package installations provide the ephervex command. With an
AppImage, run its file with the same arguments, for example
./Ephervex-x86_64.AppImage doctor. Use the aarch64 file name on ARM.
Find a command
Start with the command list, then ask for help at the path you need:
ephervex --help
ephervex help instance
ephervex help instance recipe
The CLI Reference contains the help output for
every top-level command and its subcommands. The task guides explain how to
use those commands in context. An AppImage accepts help in the same way.
For scripting, see CLI JSON and Exit Status for result shapes, foreground streams, and failure handling.
Check this installation
ephervex doctor
ephervex paths
doctor checks local directories, configuration, credential storage, bundled
data, and Java. It does not contact a network service or reveal credentials.
It prints the full report and exits unsuccessfully if it finds a fault, so a
script can use its exit status. paths prints the directories Ephervex uses
in the current environment. See Files and Privacy
before moving or removing data.
Enable shell completions
completions writes a script to standard output. Choose a shell from bash,
elvish, fish, powershell, or zsh. For the current Bash session:
source <(ephervex completions bash)
That does not change future shell sessions. To keep completions, save the
generated output where your shell loads completion scripts. For other shells,
replace bash with the name shown by ephervex help completions and use that
shell's installation instructions.
Work with command-only features
| Task | Command | Guide |
|---|---|---|
| Inspect an imported pack's retained file plan | ephervex instance recipe INSTANCE_ID | Instances |
| List the resource, shader, and data packs a modpack placed | ephervex packs --instance INSTANCE_ID | Interface tour |
| Attach the issue an instance reproduces | ephervex instance issue INSTANCE_ID URL | Instances |
| Keep steps, a note, and a reproduced count for an instance | ephervex instance case INSTANCE_ID | Instances |
| Check which Java runtime a version or host would use | ephervex java select --instance INSTANCE_ID | Settings |
| Install the Java a host expects | ephervex java install --instance INSTANCE_ID | Instances |
| Check or clear interrupted server runtime state | ephervex server recover status SERVER_ID | Servers |
Register an AppImage for ephervex:// links | ephervex url-handler register | Import Modpacks |
Some commands ask for confirmation before changing files. instance delete
asks before deleting files; a noninteractive run needs --yes for that choice.
snapshot restore and snapshot delete require --yes. server eula accept
requires an interactive terminal. Read the affected task guide before using
these commands in a script.
launch and server start stay in the foreground while the game or server
runs. Ctrl-C ends the supervised run. A failed launch reports a failure
status; mod verify also exits unsuccessfully when it finds a recorded-file
fault. See Diagnostics to inspect the result before
changing files.