github.com/rvaralda/deis@v1.4.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.4.1
    22  
    23  This installs ``deisctl`` version 1.4.1 to the current directory, and downloads the matching
    24  Deis systemd unit files used to schedule the components. Link ``deisctl`` into /usr/local/bin, so
    25  it will be in your ``$PATH``:
    26  
    27  .. code-block:: console
    28  
    29      $ sudo ln -fs $PWD/deisctl /usr/local/bin/deisctl
    30  
    31  To change installation options, save the installer directly:
    32  
    33  .. image:: download-linux-brightgreen.svg
    34     :target: https://s3-us-west-2.amazonaws.com/opdemand/deisctl-1.4.1-linux-amd64.run
    35  
    36  .. image:: download-osx-brightgreen.svg
    37     :target: https://s3-us-west-2.amazonaws.com/opdemand/deisctl-1.4.1-darwin-amd64.run
    38  
    39  Then run the downloaded file as a shell script. Append ``--help`` to see what options
    40  are available.
    41  
    42  .. important::
    43  
    44      Always use a version of ``deisctl`` that matches the Deis release.
    45      Verify this with ``deisctl --version``.
    46  
    47  
    48  Building from Source
    49  --------------------
    50  
    51  To build ``deisctl`` locally, first :ref:`get the source <get_the_source>`, ensure
    52  you have `godep`_ installed, and run:
    53  
    54  .. code-block:: console
    55  
    56  	$ make -C deisctl build
    57  
    58  You can then move or link the client so it will be in your path:
    59  
    60  .. code-block:: console
    61  
    62  	$ sudo ln -fs $PWD/deisctl/deisctl /usr/local/bin/deisctl
    63  
    64  .. note::
    65  
    66      Remember to run ``deisctl refresh-units`` or to set ``$DEISCTL_UNITS`` to an appropriate
    67      directory if you do not use the ``deisctl`` installer. Run the command
    68      ``deisctl help refresh-units`` for more information.
    69  
    70  
    71  .. _`godep`: https://github.com/tools/godep