tsuru-client

README

tsuru-client

tsuru is a command line for application developers on tsuru.

reporting issues

Please report issues to the tsuru/tsuru repository.

Environment variables

The following environment variables can be used to configure the client:

API configuration

• TSURU_TARGET: the tsuru API endpoint.
• TSURU_TOKEN: the tsuru API token.

Other configuration

• TSURU_CLIENT_FORCE_CHECK_UPDATES: boolean on whether to force checking for updates. When true, it hangs if no response from remote server! (default: unset)
• TSURU_CLIENT_LOCAL_TIMEOUT: timeout for performing local non-critical operations (eg: writing preferences to ~/.tsuru/config.json). (default: 1s)
• TSURU_CLIENT_SELF_UPDATE_SNOOZE_DURATION: snooze the self-updating process for the given duration. (default: 0s)

Tsuru plugins

Tsuru plugins are the standard way to extend tsuru-client functionality transparently. Installing and using a plugin is done with:

tsuru plugin install <plugin-name> <plugin-url>
tsuru <plugin-name> <any_sub_commands_or_flags...>

For developing a custom plugin, read about Developing Tsuru Plugins.