Client usage

After installing the tsuru client, you must set the target with the tsuru server URL, something like:

Setting a target

$ tsuru target-add default
$ tsuru target-set default


After that, all you need is to create a user and authenticate to start creating apps and pushing code to them. Use create-user and login:

$ tsuru user-create
$ tsuru login

tsuru users have a API key that enables authentication that don’t required interaction. The key never expires, to regenerate the API key you should use the command token-regenerate.

$ tsuru token-regenerate

To view the current key just use the command token-show.

$ tsuru token-show


Associating your user to a team

You need to be member of a team to create an app. To create a new team, use create-team:

$ tsuru team-create teamname

Creating an app

To create an app, use app-create:

$ tsuru app-create myblog <platform> [--plan/-p plan_name] [--team/-t team_owner]

The platform parameter is the name of the platform to be used when creating the app. This will definer how tsuru understands and executes your app. The list of available platforms can be found running tsuru platform-list.

The --plan parameter defines the plan to be used. The plan specifies how computational resources are allocated to your application. Typically this means limits for memory and swap usage, and how much cpu share is allocated. The list of available plans can be found running tsuru plan-list.

If this parameter is not informed, tsuru will choose the plan with the default flag set to true.

The team parameter describes which team is responsible for the created app, this is only needed if the current user belongs to more than one team, in which case this parameter will be mandatory.

After running successfully the command will return your app’s remote url, you should add it to your git repository:

$ git remote add tsuru

Listing your apps

When your app is ready, you can push to it. To check whether it is ready or not, you can use app-list:

$ tsuru app-list

This will return something like:

| Application | Units State Summary     | Ip                                        |
| myblog      | 1 of 1 units in-service | |

Showing app info

You can also use the app-info command to view information of an app. Including the status of the app:

$ tsuru app-info

This will return something like:

Application: myblog
Platform: gunicorn
Teams: team1, team2
| Unit     | State   |
| myblog/0 | started |
| myblog/1 | started |

tsuru uses information from git configuration to guess the name of the app, for more details, see “Guessing app names” section of tsuru command documentation.

Public Keys

You can try to push now, but you’ll get a permission error, because you haven’t pushed your key yet.

$ tsuru key-add

This will search for a file in ~/.ssh/, if you don’t have a generated key yet, you should generate one before running this command.

If you have a public key in other format (for example, DSA), you can also give the public key file to key-add:

$ tsuru key-add $HOME/.ssh/

After your key is added, you can push your application to your cloud:

$ git push tsuru master

Running commands

After that, you can check your app’s url in the browser and see your app there. You’ll probably need to run migrations or other deploy related commands. To run a single command, you should use the command run:

$ tsuru run "python syncdb && python migrate"

Further instructions

For a complete reference, check the documentation for tsuru command: