github.com/greenboxal/deis@v1.12.1/docs/installing_deis/install-deisctl.rst (about) 1 :title: Installing the Deis Control Utility 2 :description: Learn how to install the Deis Control Utility 3 4 .. _install_deisctl: 5 6 Install deisctl 7 =============== 8 9 The Deis Control Utility, or ``deisctl`` for short, is a command-line client used to configure and 10 manage the Deis Platform. 11 12 Run the Installer 13 ----------------- 14 15 Change to the directory where you would like the ``deisctl`` binary to be installed, then download 16 and run the latest installer: 17 18 .. code-block:: console 19 20 $ cd ~/bin 21 $ curl -sSL http://deis.io/deisctl/install.sh | sh -s 1.12.1 22 $ # on CoreOS, add "sudo" to install to /opt/bin/deisctl 23 $ curl -sSL http://deis.io/deisctl/install.sh | sudo sh -s 1.12.1 24 25 This installs ``deisctl`` version 1.12.1 to the current directory, and downloads the matching 26 Deis systemd unit files used to schedule the components. Link ``deisctl`` into /usr/local/bin, so 27 it will be in your ``$PATH``: 28 29 .. code-block:: console 30 31 $ sudo ln -fs $PWD/deisctl /usr/local/bin/deisctl 32 33 To change installation options, save the installer directly: 34 35 .. image:: download-linux-brightgreen.svg 36 :target: https://s3-us-west-2.amazonaws.com/get-deis/deisctl-1.12.1-linux-amd64.run 37 38 .. image:: download-osx-brightgreen.svg 39 :target: https://s3-us-west-2.amazonaws.com/get-deis/deisctl-1.12.1-darwin-amd64.run 40 41 Then run the downloaded file as a shell script. Append ``--help`` to see what options 42 are available. 43 44 .. important:: 45 46 Always use a version of ``deisctl`` that matches the Deis release. 47 Verify this with ``deisctl --version``. 48 49 50 Building from Source 51 -------------------- 52 53 To build ``deisctl`` locally, first :ref:`get the source <get_the_source>`, ensure 54 you have `godep`_ installed, and run: 55 56 .. code-block:: console 57 58 $ make -C deisctl build 59 60 You can then move or link the client so it will be in your path: 61 62 .. code-block:: console 63 64 $ sudo ln -fs $PWD/deisctl/deisctl /usr/local/bin/deisctl 65 66 .. note:: 67 68 Remember to run ``deisctl refresh-units`` or to set ``$DEISCTL_UNITS`` to an appropriate 69 directory if you do not use the ``deisctl`` installer. Run the command 70 ``deisctl help refresh-units`` for more information. 71 72 73 .. _`godep`: https://github.com/tools/godep