Command-line client

The orchard CLI lets you create and remove Docker hosts and talk to them via the official Docker CLI.

For installation instructions, see the Getting Started guide.

Note: Orchard runs Docker 1.1.1. Different versions of the Docker CLI may be incompatible.

orchard hosts

List all hosts.

$ orchard hosts
NAME                SIZE                IP
default             512M                234.56.78.9
otherhost           512M                43.2.12.34

orchard hosts create [-m MEMORY] [NAME]

Create a host.

You can optionally specify a name for the host—if not, it will be named default, and orchard docker commands will use it automatically.

You can also specify the amount of RAM with -m. Valid sizes, as per the pricing page, are 512M, 1G, 2G, 4G and 8G. The default is 512M.

$ orchard hosts create
Default host running at 234.56.78.9

$ orchard hosts create -m 4G otherhost
Host 'otherhost' running at 43.2.12.34

orchard hosts rm [-f] [NAME]

Remove a host.

You can optionally specify which host to remove—if you don’t, the default host (named default) will be removed.

Set -f to bypass the confirmation step, at your peril.

$ orchard hosts rm
Going to remove default host. All data on it will be lost.
Are you sure you're ready? [yN] y
Removed default host.

$ orchard hosts rm -f otherhost
Removed 'otherhost'.

orchard docker [-H HOST] [COMMAND...]

Run a Docker command against a host. Wraps the docker command-line tool—see the Docker website for reference.

You can optionally specify a host by name—if you don’t, the default host will be used.

$ orchard docker run ubuntu echo hello world
hello world

$ orchard docker -H otherhost run ubuntu echo hello world
hello world

orchard proxy [-H HOST] [LISTEN_URL]

Starts a local proxy to a host’s Docker daemon.

By default, listens on a Unix socket at a random path, e.g.

$ orchard proxy
Started proxy at unix:///tmp/orchard-12345/orchard.sock

$ docker -H unix:///tmp/orchard-12345/orchard.sock run ubuntu echo hello world
hello world

Instead, you can specify a URL to listen on, which can be a socket or TCP address:

$ orchard proxy unix:///path/to/socket
$ orchard proxy tcp://localhost:1234

orchard ip [HOST]

Print a host’s IP address to stdout.

$ orchard ip
123.456.78.9

$ orchard ip otherhost
98.76.54.32