install-client.rst

title:	Install the Deis Client on your Workstation
description:	First steps for developers using Deis to deploy and scale applications.

Install the Client

The Deis command-line interface (CLI), or client, allows you to interact with a Deis :ref:`Controller`. You must install the client to use Deis.

Install the Deis Client

Install the latest deis client for Linux or Mac OS X with:

$ curl -sSL http://deis.io/deis-cli/install.sh | sh

The installer puts deis in your current directory, but you should move it somewhere in your $PATH:

$ sudo ln -fs $PWD/deis /usr/local/bin/deis

Proxy Support

Set the http_proxy or https_proxy environment variable to enable proxy support:

$ export http_proxy="http://proxyip:port"
$ export https_proxy="http://proxyip:port"

Integrated Help

The Deis client comes with comprehensive documentation for every command. Use deis help to explore the commands available to you:

$ deis help
The Deis command-line client issues API calls to a Deis controller.

Usage: deis <command> [<args>...]

Auth commands::

  register      register a new user with a controller
  login         login to a controller
  logout        logout from the current controller

Subcommands, use ``deis help [subcommand]`` to learn more::
...

To get help on subcommands, use deis help [subcommand]:

$ deis help apps
Valid commands for apps:

apps:create        create a new application
apps:list          list accessible applications
apps:info          view info about an application
apps:open          open the application in a browser
apps:logs          view aggregated application logs
apps:run           run a command in an ephemeral app container
apps:destroy       destroy an application

Use `deis help [command]` to learn more