Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

CLI for Tutum

Project Description
tutum
=====

CLI for Tutum. Full documentation available at `https://docs.tutum.co/v2/api/?shell# <https://docs.tutum.co/v2/api/?shell#>`_


Installing the CLI
------------------

In order to install the Tutum CLI, you can use ``pip install``:

.. sourcecode:: bash

pip install tutum

For Mac OS users, you can use ``brew install``:

.. sourcecode:: bash

brew install tutum

Now you can start using it:

.. sourcecode:: none

$ tutum

usage: tutum [-h] [-v]
{build,container,event,exec,image,login,node,nodecluster,push,run,service,stack,tag,volume,volumegroup,trigger,up}
...

Tutum's CLI

optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit

Tutum's CLI commands:
{build,container,event,exec,image,login,node,nodecluster,push,run,service,stack,tag,volume,volumegroup,trigger,up}
build Build an image using tutum/builder
container Container-related operations
event Get real time tutum events
exec Run a command in a running container
image Image-related operations
login Login into Tutum
node Node-related operations
nodecluster NodeCluster-related operations
push Push a local image to Tutum private registry
run Create and run a new service
service Service-related operations
stack Stack-related operations
tag Tag-related operations
volume Volume-related operations
volumegroup VolumeGroup-related operations
trigger Trigger-related operations
up Create and deploy a stack



Docker image
^^^^^^^^^^^^

You can also install the CLI via Docker:

.. sourcecode:: bash

docker run tutum/cli -h

You will have to pass your username and API key as environment variables, as the credentials stored via ``tutum login``
will not persist by default:

.. sourcecode:: bash

docker run -it -e TUTUM_USER=username -e TUTUM_APIKEY=apikey tutum/cli

To make things easier, you might want to use an ``alias`` for it:

.. sourcecode:: bash

alias tutum="docker run -it -v /usr/bin/docker:/usr/bin/docker -v /var/run/docker.sock:/var/run/docker.sock -e TUTUM_USER=username -e TUTUM_APIKEY=apikey --rm tutum/cli"

Then, you can run commands like:

.. sourcecode:: bash

tutum service
tutum exec


Authentication
--------------

In order to manage your apps and containers running on Tutum, you need to log into Tutum in any of the following ways
(will be used in this order):

* Login using Tutum CLI or storing it directly in a configuration file in ``~/.tutum``:

.. sourcecode:: bash

$ tutum login
Username: admin
Password:
Login succeeded!

Your login credentials will be stored in ``~/.tutum``:

.. sourcecode:: ini

[auth]
user = "username"
apikey = "apikey"

* Set the environment variables ``TUTUM_USER``, ``TUTUM_APIKEY``, or ``TUTUM_USER``, ``TUTUM_PASS``:

.. sourcecode:: bash

export TUTUM_USER=<username>
export TUTUM_APIKEY=<apikey>

or

.. sourcecode:: bash

export TUTUM_USER=<username>
export TUTUM_PASS=<password>

* Set the environment variables ``TUTUM_AUTH``:

.. sourcecode:: bash
export TUTUM_AUTH=tutumauth

``TUTUM_AUTH`` is the environment variable injected via API roles

Note: ``tutum-cli`` and ``python-tutum`` will pick up the auth in the following order:
* ``TUTUM_AUTH``
* ``TUTUM_USER``, ``TUTUM_PASS`` or ``TUTUM_USER``, ``TUTUM_APIKEY``
* ``~/.tutum``
Release History

Release History

This version
History Node

0.21.1

History Node

0.21.0

History Node

0.20.2

History Node

0.20.1

History Node

0.20.0

History Node

0.16.21

History Node

0.16.0.1

History Node

0.16.0

History Node

0.15.1.1

History Node

0.15.1

History Node

0.15.0.1

History Node

0.14.1

History Node

0.14.0

History Node

0.13.1

History Node

0.13.0

History Node

0.12.6.1

History Node

0.12.6

History Node

0.11.5.1

History Node

0.11.5

History Node

0.11.3

History Node

0.11.2

History Node

0.11.1

History Node

0.11.0.1

History Node

0.11.0

History Node

0.10.5

History Node

0.10.1

History Node

0.10.0

History Node

0.9.8.1

History Node

0.9.8

History Node

0.9.1.4pre

History Node

0.9.1.3pre

History Node

0.9.1.2pre

History Node

0.9.1.1pre

History Node

0.9.1pre

History Node

0.9.0pre

History Node

0.8.0pre

History Node

0.7.5.1

History Node

0.7.5

History Node

0.7.4.1

History Node

0.7.4

History Node

0.7.3.5

History Node

0.7.3.4

History Node

0.7.3.3

History Node

0.7.3.2

History Node

0.7.3.1

History Node

0.7.3

History Node

0.7.2

History Node

0.7.1

History Node

0.7.0

History Node

0.6.6

History Node

0.6.5

History Node

0.6.3.5

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
tutum-0.21.1.tar.gz (44.1 kB) Copy SHA256 Checksum SHA256 Source Dec 11, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting