Full Command-Line Interface Documentation
Summary
usage: enderchest [-h] [-v] action [arguments ...]
v0.1.6
syncing and linking for all your Minecraft instances
positional arguments:
action The action to perform. Options are:
craft
to create and configure a new EnderChest installation
craft shulker_box
to create and configure a new shulker box
place
to link (or update the links) from your instances to your EnderChest
gather instance
to register (or update the registry of) a Minecraft installation
gather server
to register (or update the registry of) a Minecraft server installation
gather enderchests
to register (or update the registry of) a remote EnderChest
inventory
to list the shulker boxes inside your Enderchest
inventory instances
to list the minecraft instances registered with your Enderchest
inventory instance
to list the shulker boxes that the specified instance links into
inventory shulker_box
to list the minecraft instances that match the specified shulker box
inventory enderchests
to list the other EnderChest installations registered with this EnderChest
open
to pull changes from other EnderChests
close
to push changes to other EnderChests
break
to uninstall EnderChest by copying linked resources into some or all of the registered instances
test
to run the EnderChest test suite
arguments Any additional arguments for the specific action. To learn more, try: enderchest {action} -h
options:
-h, --help show this help message and exit
-v, -V, --version show program's version number and exit
enderchest craft
usage: enderchest craft [-h] [--root ROOT_FLAG] [--verbose] [--quiet]
[--from COPY_FROM] [-r REMOTES]
[-i INSTANCE_SEARCH_PATHS] [--overwrite]
[root]
create and configure a new EnderChest installation
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--from COPY_FROM provide the URI (e.g. rsync://deck@my-steam-
deck/home/deck/) of a remote EnderChest installation
that can be used to boostrap the creation of this one.
-r REMOTES, --remote REMOTES
provide the URI (e.g. rsync://deck@my-steam-
deck/home/deck/) of a remote EnderChest installation
to register with this one
-i INSTANCE_SEARCH_PATHS, --instance INSTANCE_SEARCH_PATHS
specify a folder to search for Minecraft installations
in
--overwrite if there's already an EnderChest installation in this
location, overwrite its configuration
enderchest craft shulker_box
usage: enderchest craft shulker_box [-h] [--root ROOT_FLAG] [--verbose]
[--quiet] [--priority PRIORITY]
[-i INSTANCES] [-t TAGS] [-e HOSTS]
[-l LINK_FOLDERS] [--overwrite]
[root] name
create and configure a new shulker box
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
name specify the name for this shulker box
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--priority PRIORITY, -p PRIORITY
specify the link priority for this shulker box (higher
= linked later)
-i INSTANCES, --instance INSTANCES
only link instances with one of the provided names to
this shulker box
-t TAGS, --tag TAGS only link instances with one of the provided tags to
this shulker box
-e HOSTS, --enderchest HOSTS
only link instances registered to one of the provided
EnderChest installations with this shulker box
-l LINK_FOLDERS, --folder LINK_FOLDERS
specify the name of a folder inside this shulker box
that should be linked completely
--overwrite if there's already a shulker box with the specified
name, overwrite its configuration
enderchest place
usage: enderchest place [-h] [--root ROOT_FLAG] [--verbose] [--quiet]
[--keep-broken-links] [--keep-stale-links] [-k]
[--stop-at-first-failure | --ignore-errors | --errors {prompt,ignore,skip,skip-instance,skip-shulker-box,abort}]
[--absolute | --relative]
[root]
link (or update the links) from your instances to your EnderChest
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--absolute, -a use absolute paths for all link targets
--relative, -r use relative paths for all link targets
--keep-broken-links do not remove broken links from instances
--keep-stale-links do not remove existing links into the EnderChest, even
if the shulker box or instance spec has changed
-k shorthand for the above cleanup options: -k will
--keep-stale-links, and -kk will --keep-broken-links
as well
error handling:
--stop-at-first-failure, -x
stop linking at the first issue
--ignore-errors ignore any linking errors
--errors {prompt,ignore,skip,skip-instance,skip-shulker-box,abort}, -e {prompt,ignore,skip,skip-instance,skip-shulker-box,abort}
specify how to handle linking errors (default behavior
is to prompt after every error)
enderchest gather instance
usage: enderchest gather instance [-h] [--root ROOT_FLAG] [--verbose]
[--quiet] [--official | --mmc]
[root] search_paths [search_paths ...]
register (or update the registry of) a Minecraft installation
positional arguments:
root optionally specify your root minecraft directory. If no
path is given, the current working directory will be used.
search_paths specify a folder or folders to search for Minecraft
installations
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--official, -o specify that these are instances managed by the official
launcher
--mmc, -m specify that these are MultiMC-like instances
enderchest gather server
usage: enderchest gather server [-h] [--root ROOT_FLAG] [--verbose] [--quiet]
[--jar JAR] [--name NAME]
[--tags TAGS [TAGS ...]]
[root] server_home
register (or update the registry of) a Minecraft server installation
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
server_home the working directory of the Minecraft server
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--jar JAR, -j JAR explicitly specify the path to the server JAR (in case
it's outside of the server's working directory of if
there are multiple server JAR files inside that
folder)
--name NAME, -n NAME specify the name (alias) for the server
--tags TAGS [TAGS ...], -t TAGS [TAGS ...]
specify any tags you want to apply to the server
enderchest gather enderchests
usage: enderchest gather enderchests [-h] [--root ROOT_FLAG] [--verbose]
[--quiet]
[root] remotes [remotes ...]
register (or update the registry of) a remote EnderChest
positional arguments:
root optionally specify your root minecraft directory. If no
path is given, the current working directory will be used.
remotes Provide URIs (e.g. rsync://deck@my-steam-deck/home/deck/)
of any remote EnderChest installation to register with
this one. Note: you should not use this method if the
alias (name) of the remote does not match the remote's
hostname (in this example, "my-steam-deck").
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
enderchest inventory
usage: enderchest inventory [-h] [--root ROOT_FLAG] [--verbose] [--quiet]
[--instance INSTANCE_NAME] [--path PATH]
[root]
list the shulker boxes inside your Enderchest
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--instance INSTANCE_NAME, -i INSTANCE_NAME
The name of the minecraft instance to query
--path PATH, -p PATH optionally, specify a specific path (absolute,
relative, filename or glob pattern to get a report of
the shulker box(es) that provide that resource
enderchest inventory instances
usage: enderchest inventory instances [-h] [--root ROOT_FLAG] [--verbose]
[--quiet]
[root]
list the minecraft instances registered with your Enderchest
positional arguments:
root optionally specify your root minecraft directory. If no
path is given, the current working directory will be used.
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
enderchest inventory instance
usage: enderchest inventory instance [-h] [--root ROOT_FLAG] [--verbose]
[--quiet] [--path PATH]
[root] instance_name
list the shulker boxes that the specified instance links into
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
instance_name The name of the minecraft instance to query
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--path PATH, -p PATH optionally, specify a specific path (absolute,
relative, filename or glob pattern to get a report of
the shulker box(es) that provide that resource
enderchest inventory shulker_box
usage: enderchest inventory shulker_box [-h] [--root ROOT_FLAG] [--verbose]
[--quiet]
[root] shulker_box_name
list the minecraft instances that match the specified shulker box
positional arguments:
root optionally specify your root minecraft directory. If no
path is given, the current working directory will be used.
shulker_box_name the name of the shulker box to query
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
enderchest inventory enderchests
usage: enderchest inventory enderchests [-h] [--root ROOT_FLAG] [--verbose]
[--quiet]
[root]
list the other EnderChest installations registered with this EnderChest
positional arguments:
root optionally specify your root minecraft directory. If no
path is given, the current working directory will be used.
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
enderchest open
usage: enderchest open [-h] [--root ROOT_FLAG] [--verbose] [--quiet]
[--dry-run] [--exclude EXCLUDE [EXCLUDE ...]]
[--timeout TIMEOUT]
[--wait SYNC_CONFIRM_WAIT | --confirm]
[root]
pull changes from other EnderChests
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--dry-run perform a dry run of the sync operation, reporting the
operations that will be performed but not actually
carrying them out
--exclude EXCLUDE [EXCLUDE ...], -e EXCLUDE [EXCLUDE ...]
Provide any file patterns you would like to skip
syncing
--timeout TIMEOUT, -t TIMEOUT
set a maximum number of seconds to try to sync to a
remote chest before giving up and going on to the next
one
sync confirmation control:
The default behavior when syncing EnderChests is to first perform a dry
run of every sync operation and then wait 5 seconds before proceeding with
the real sync. The idea is to give you time to interrupt the sync if the
dry run looks wrong. You can raise or lower that wait time through these
flags. You can also modify it by editing the enderchest.cfg file.
--wait SYNC_CONFIRM_WAIT, -w SYNC_CONFIRM_WAIT
set the time in seconds to wait after performing a dry
run before the real sync is performed
--confirm, -c after performing the dry run, explicitly ask for
confirmation before performing the real sync
enderchest close
usage: enderchest close [-h] [--root ROOT_FLAG] [--verbose] [--quiet]
[--dry-run] [--exclude EXCLUDE [EXCLUDE ...]]
[--timeout TIMEOUT]
[--wait SYNC_CONFIRM_WAIT | --confirm]
[root]
push changes to other EnderChests
positional arguments:
root optionally specify your root minecraft directory. If
no path is given, the current working directory will
be used.
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
--dry-run perform a dry run of the sync operation, reporting the
operations that will be performed but not actually
carrying them out
--exclude EXCLUDE [EXCLUDE ...], -e EXCLUDE [EXCLUDE ...]
Provide any file patterns you would like to skip
syncing
--timeout TIMEOUT, -t TIMEOUT
set a maximum number of seconds to try to sync to a
remote chest before giving up and going on to the next
one
sync confirmation control:
The default behavior when syncing EnderChests is to first perform a dry
run of every sync operation and then wait 5 seconds before proceeding with
the real sync. The idea is to give you time to interrupt the sync if the
dry run looks wrong. You can raise or lower that wait time through these
flags. You can also modify it by editing the enderchest.cfg file.
--wait SYNC_CONFIRM_WAIT, -w SYNC_CONFIRM_WAIT
set the time in seconds to wait after performing a dry
run before the real sync is performed
--confirm, -c after performing the dry run, explicitly ask for
confirmation before performing the real sync
enderchest break
usage: enderchest break [-h] [--root ROOT_FLAG] [--verbose] [--quiet]
[instances ...]
uninstall EnderChest by copying linked resources into some or all of the
registered instances
positional arguments:
instances instead of breaking your entire EnderChest, just
deregister and copy linked resources into the specified
instances (by name)
options:
-h, --help show this help message and exit
--root ROOT_FLAG specify your root minecraft directory
--verbose, -v increase the amount of information that's printed
--quiet, -q decrease the amount of information that's printed
enderchest test
usage: enderchest test [-h] [--use-local-ssh] ...
run the EnderChest test suite
positional arguments:
pytest_args any additional arguments to pass through to py.test
options:
-h, --help show this help message and exit
--use-local-ssh By default, tests of SSH functionality will be run against
a mock SSH server. If you are running EnderChest on a
machine you can SSH into locally (by running `ssh
localhost`) without requiring a password, running the tests
with this flag will produce more accurate results.