View on GitHub

voxel-dockerclient

An experimental minecraft-like docker client, built using voxel.js. Inspired by dockercraft.

How to use voxel-dockerclient

This is the opening screen of voxel-dockerclient.

Opening screen

Press the ` key to close the dialog. The same key can be used to open and close the command console, and to close any dialog.

At this point, you should see all your containers, arranged left to right from the oldest to the newest. Running or stopped is indicated by lights on the container.

Look around with your mouse. Move the player around with the WASD keys. The space bar makes the player jump. Double-tapping the space bar makes the player fly.

While flying, the space bar takes the player higher, and the shift key lower. Once the player hits the ground, running will start again.

Open the command console, and try the commands. Currently, the following commands are available:

Command Description
help Shows all available commands
inspect Inspects a container
top Shows processes running in a container
start Starts a container
stop Stops a container
logs Shows a container’s logs
attach Attaches a terminal to an interactive container
go Takes player to a container, or to the first or last container. Type go home if you get lost.
remove Deletes a container
create Creates a container
welcome Shows the welcome message
refresh Re-fetches container list
restart Restarts voxel-dockerclient. Use as a last resort.

Of these, the container-related commands like start, stop, top, remove and inspect can be invoked in two ways: either by using the <command> <containername> syntax, or by positioning the player exactly next to a container, and using just <command>.

When the command console is closed, pressing the I key will invoke the inspect command. If the player is exactly next to a container, that container will be inspected.

The create command allows you to create new containers. Currently, you can only use images already on your docker host. Image pulling will be added in a later release.

Activity performed in other clients, such as the official docker client, will not reflect automatically in voxel-dockerclient. Use the refresh command periodically.

The go command can be used to teleport the player to a particular container, using the syntax go <containername>. go home will teleport to the first (oldest) container. go nextslot will teleport to the spot where the next new container will appear.

The logs command shows a container’s logs, if available.

The attach command opens a terminal attached to the main process of a container. You can press Ctrl+L to refresh the terminal, and Ctrl+P, Ctrl+Q to detach the terminal.