.. Copyright 2015 tsuru authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file. .. meta:: :description: Install guide for tsuru clients :keywords: paas, cloud computing, tsuru ++++++++++++++++++++++++ Installing tsuru clients ++++++++++++++++++++++++ tsuru contains three clients: ``tsuru``, ``tsuru-admin`` and ``crane``. * **tsuru** is the command line utility used by application developers, that will allow users to create, list, bind and manage apps. For more details, check :doc:`tsuru usage `; * **crane** is used by service administrators. * **tsuru-admin** is used by cloud administrators. Whoever is allowed to use it has gotten super powers :-) This document describes how you can install those clients, using pre-compiled binaries, packages or building them from source. - `Downloading binaries (Mac OS X, Linux and Windows)`_ - `Using homebrew (Mac OS X only)`_ - `Using the PPA (Ubuntu only)`_ - `Build from source (Linux, Mac OS X and Windows)`_ Downloading binaries (Mac OS X, Linux and Windows) ================================================== We provide pre-built binaries for OS X and Linux, only for the amd64 architecture. You can download these binaries directly from the releases page of the project: * crane: https://github.com/tsuru/crane/releases * tsuru: https://github.com/tsuru/tsuru-client/releases * tsuru-admin: https://github.com/tsuru/tsuru-admin/releases Using homebrew (Mac OS X only) ============================== If you use Mac OS X and `homebrew `_, you may use a custom tap to install ``tsuru``, ``crane`` and ``tsuru-admin``. First you need to add the tap: .. highlight:: bash :: $ brew tap tsuru/homebrew-tsuru Now you can install tsuru, tsuru-admin and crane: .. highlight:: bash :: $ brew install tsuru $ brew install tsuru-admin $ brew install crane Whenever a new version of any of tsuru's clients is out, you can just run: .. highlight:: bash :: $ brew update $ brew upgrade # tsuru/tsuru-admin/crane For more details on taps, check `homebrew documentation `_. **NOTE:** tsuru clients require Go 1.4 or higher. Make sure you have the last version of Go installed in your system. Using the PPA (Ubuntu only) =========================== Ubuntu users can install tsuru clients using ``apt-get`` and the `tsuru PPA `_. You'll need to add the PPA repository locally and run an ``apt-get update``: .. highlight:: bash :: $ sudo apt-add-repository ppa:tsuru/ppa $ sudo apt-get update Now you can install tsuru's clients: .. highlight:: bash :: $ sudo apt-get install tsuru-client $ sudo apt-get install crane $ sudo apt-get install tsuru-admin Build from source (Linux, Mac OS X and Windows) =============================================== .. note:: If you're feeling adventurous, you can try it on other platforms, like FreeBSD and OpenBSD. Please let us know about your progress! `tsuru's source `_ is written in `Go `_, so before installing tsuru from source, please make sure you have `installed and configured Go `_. With Go installed and configured, you can use ``go get`` to install any of tsuru's clients: .. highlight:: bash :: $ go get github.com/tsuru/tsuru-client/tsuru $ go get github.com/tsuru/tsuru-admin $ go get github.com/tsuru/crane