Skip to main content

CLI Reference

Use the task guides for workflows. These pages contain the CLI help for this build of Ephervex. Run ephervex help COMMAND for the same information in your terminal.

Commands​

CommandDescription
completionsGenerate a shell completion script on standard output
infoShow build information
pathsShow the resolved application directories
doctorCheck this installation and report what is wrong with it
configShow or change the effective configuration
preferencesInspect and change global Minecraft preferences
instancesOperate on the set of client instances
instanceOperate on one client instance
groupsManage the groups instances are sorted into
serversOperate on the set of servers
serverOperate on one server
minecraftInspect Mojang's Minecraft release metadata
javaInspect and manage Java runtimes
accountSign in, inspect, and sign out of the Microsoft account
apiInspect and change provider API settings
modManage and troubleshoot mods in client instances and local servers
packsList the resource packs, shader packs, and data packs a modpack placed
snapshotCapture and restore local client or server state
logsInspect launcher, client, and server logs and crash reports
url-handlerMake Ephervex open ephervex:// links from your browser, or stop it
importImport a modpack into a client instance, from a file or an address
launchInstall and launch a client instance, streaming its log to the terminal
runningList everything Ephervex is currently running
reconcileReconcile the index against what is actually on disk
licensesShow the open-source software Ephervex is built on, and its licenses

Usage and global options​

Disposable Minecraft instances for mod development and bug reproduction

Usage: ephervex [OPTIONS] <COMMAND>

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