Looking for Stackato 2.10 docs?

Stackato Client

The stackato client is the command-line interface to Stackato. You can use it to push application code up to the server, start and stop applications, create data services and link them to applications, and a number of other application management operations.

The Command Reference has full descriptions of all client commands and options. These details are also available at the command line via the stackato help command.

Stackato Client Setup

  1. Download the client for your platform (Windows, OS X, Linux x86, Linux x64)
  2. Unzip the archive in a convenient directory.
  3. Add the the executable to your system/shell $PATH by:
  • moving it to a directory in your $PATH,
  • creating a symlink from a directory in your $PATH, or
  • creating a shell alias for the executable.
  1. Confirm that the client is installed correctly by running stackato help.

Note

Using the Windows stackato client with Cygwin is not supported.

Getting Help

To get a list of available commands or help on a particular command:

$ stackato help [COMMAND]

See also the Command Reference for a full list of commands.

Targeting the API Endpoint

Before you can use the client, you must set the target URL (also known as the API Endpoint). This tells the client where it will be pushing applications. For example:

$ stackato target api.stackato.example.com

For a micro cloud VM, it might be something like:

$ stackato target api.stackato-xxxx.local

HTTP Proxies

If there is an HTTP/HTTPS proxy on your network between your client and the Stackato API endpoint, set the following environment variables in your shell as appropriate for your proxy:

  • https_proxy (e.g. "https://yourproxy.example.com:443/")
  • http_proxy (e.g. "http://yourproxy.example.com:8080/")
  • http_proxy_user
  • http_proxy_pass

With these set, the client will recognize these settings and route appropriately. On Windows the client queries the Internet Settings values so this step should not be necessary.

Removing the Client

To uninstall the client, simply delete the executable and remove any aliases or $PATH modifications you have made for it.