github.com/technosophos/deis@v1.7.1-0.20150915173815-f9005256004b/docs/using_deis/install-client.rst (about) 1 :title: Install the Deis Client on your Workstation 2 :description: First steps for developers using Deis to deploy and scale applications. 3 4 .. _install-client: 5 6 Install the Client 7 ================== 8 The Deis command-line interface (CLI), or client, allows you to interact 9 with a Deis :ref:`Controller`. You must install the client to use Deis. 10 11 Install the Deis Client 12 ----------------------- 13 14 Install the latest ``deis`` client for Linux or Mac OS X with: 15 16 .. code-block:: console 17 18 $ curl -sSL http://deis.io/deis-cli/install.sh | sh 19 20 The installer puts ``deis`` in your current directory, but you should move it 21 somewhere in your $PATH: 22 23 .. code-block:: console 24 25 $ ln -fs $PWD/deis /usr/local/bin/deis 26 27 Proxy Support 28 ------------- 29 If your workstation uses a proxy to reach the network where the cluster lies, 30 set the ``http_proxy`` or ``https_proxy`` environment variable to enable proxy support: 31 32 .. code-block:: console 33 34 $ export http_proxy="http://proxyip:port" 35 $ export https_proxy="http://proxyip:port" 36 37 .. note:: 38 39 Configuring a proxy is generally not necessary for local Vagrant clusters. 40 41 Integrated Help 42 --------------- 43 The Deis client comes with comprehensive documentation for every command. 44 Use ``deis help`` to explore the commands available to you: 45 46 .. code-block:: console 47 48 $ deis help 49 The Deis command-line client issues API calls to a Deis controller. 50 51 Usage: deis <command> [<args>...] 52 53 Auth commands:: 54 55 register register a new user with a controller 56 login login to a controller 57 logout logout from the current controller 58 59 Subcommands, use ``deis help [subcommand]`` to learn more:: 60 ... 61 62 To get help on subcommands, use ``deis help [subcommand]``: 63 64 .. code-block:: console 65 66 $ deis help apps 67 Valid commands for apps: 68 69 apps:create create a new application 70 apps:list list accessible applications 71 apps:info view info about an application 72 apps:open open the application in a browser 73 apps:logs view aggregated application logs 74 apps:run run a command in an ephemeral app container 75 apps:destroy destroy an application 76 77 Use `deis help [command]` to learn more 78 79 .. _pip: http://www.pip-installer.org/en/latest/installing.html 80 .. _Python: https://www.python.org/ 81 82 Multiple Profile Support 83 ------------------------ 84 85 The Deis client supports running commands against multiple installations 86 and/or accounts by setting the ``$DEIS_PROFILE`` environment variable 87 before logging in and running any subsequent commands. If not set, all 88 commands will default to the ``client`` profile which maps to 89 a configuration file at ``$HOME/.deis/client.json``. Here's an example 90 of running the ps command against an app with the same name from two profiles: 91 92 93 .. code-block:: console 94 95 $ DEIS_PROFILE=production deis ps -a helloworld 96 $ DEIS_PROFILE=staging deis ps -a helloworld 97 98