Helion Stackato Client Command Reference

Usage

stackato [options] command [arguments] [command-options]

Try stackato help, stackato help [command], and stackato options for more information.

Many of the informational commands take a --json option if you wish to generate machine-parseable output. In some cases the --json option reveals additional details.

Note

Administrative privileges are required for some commands.

Getting Started

stackato login <email>

Log in to the current or specified target with the named user.

+ options
stackato logout <target>

Log out of the current, specified, or all targets.

+ options
stackato target <url>

Set the target API endpoint for the client, or report the current target.

+ options

Applications

stackato apps

List the applications deployed to the target.

+ options
stackato app <application>

Show the information of the specified application.

+ options
stackato list

List the applications deployed to the target.

+ options
stackato releases <application>

Show the list of versions for the specified application. This is a Helion Stackato 3.4 specific command.

+ options
stackato versions <application>

Show the list of versions for the specified application. This is a Helion Stackato 3.4 specific command.

+ options

Control

stackato migrate <application> <destination>

Move the application to a different space. This is a Helion Stackato 3.4.2 command.

+ options
stackato restage <application>

Restage an application, regenerate its droplet. This is a Helion Stackato 3.4.2 command.

+ options

Information

stackato crashes <application>

List recent application crashes.

+ options
stackato crashlogs <application>

Display log information for the application. An alias of 'logs'.

+ options
stackato disk <application>

Show the disk reservation for a deployed application.

+ options
stackato drain list <application>

Show the list of drains attached to the application.

+ options
stackato drains <application>

Show the list of drains attached to the application.

+ options
stackato env <application>

List the application's environment variables.

+ options
stackato events <application>

Show recorded application events, for application or space. Without an application given the current or specified space is used, otherwise that application. This is a Helion Stackato 3 specific command.

+ options
stackato files <application> <apath>

Display directory listing or file. Relative paths are interpreted relative to $STACKATO_APP_ROOT on the target. Without path it defaults to $STACKATO_APP_ROOT on the target.

+ options
stackato file <application> <apath>

Display directory listing or file. Relative paths are interpreted relative to $STACKATO_APP_ROOT on the target. Without path it defaults to $STACKATO_APP_ROOT on the target.

+ options
stackato health <application>

Report the health of the specified applications.

+ options
stackato instances <application>

List application instances for a deployed application.

+ options
stackato logs <application>

Display the application log stream.

+ options
stackato mem <application>

Show the memory reservation for a deployed application.

+ options
stackato stats <application>

Display the resource usage for a deployed application.

+ options
stackato tail <application> <apath>

Monitor file for changes and stream them.

+ options

Management

stackato create-app <application>

Create an empty application with the specified configuration.

+ options
stackato dbshell <application> <service>

Invoke interactive db shell for a bound service.

+ options
stackato delete <application>

Delete the specified applications.

+ options
stackato drain add <application> <drain> <uri>

Attach a new named drain to the application.

+ options
stackato drain delete <application> <drain>

Remove the named drain from the application.

+ options
stackato env-add <application> <varname> <value>

Add the specified environment variable to the named application.

+ options
stackato env-del <application> <varname>

Remove the specified environment variable from the named application.

+ options
stackato map <application> <url>

Make the application accessible through the specified URL (a route consisting of host and domain)

+ options
stackato open <application>

Open the url of the specified application in the default web browser. If 'api' is specified as the app name, the Management Console is opened. With no arguments, the 'name' value from the manifest.yml/manifest.yml in the current directory is used (if present).

+ options
stackato push <application>

Configure, create, push, map, and start a new application.

Important

The minimum value for --disk is 512MB; the maximum value is 2GB. This is a per-instance limit.

+ options
stackato rename <application> <name>

Rename the specified application. This is a Helion Stackato 3 specific command.

+ options
stackato restart-instance <application> <theinstance>

Stop and restart a specific instance of a deployed application. This is a Helion Stackato 3.4.2 command.

+ options
stackato restart <application>

Stop and restart a deployed application.

+ options
stackato rollback <application> <appversion>

Switch to a different version of the application. This is a Helion Stackato 3.4 specific command.

+ options
stackato run <command>

Run an arbitrary command on a running instance.

+ options
stackato scale <application>

Update the number of instances, memory, disk reservation and/or autoscaling settings for a deployed application.

+ options
stackato scp <paths>

Copy files and directories to and from application containers. The colon ":" character preceding a specified source or destination indicates a remote file or path. Sources and destinations can be file names, directory names, or full paths.

+ options
stackato set-env <application> <varname> <value>

Add the specified environment variable to the named application.

+ options
stackato ssh <command>

SSH to a running instance (or target), or run an arbitrary command.

+ options
stackato start <application>

Start a deployed application.

+ options
stackato stop <application>

Stop a deployed application.

+ options
stackato switch-version <application> <appversion>

Switch to a different version of the application. This is a Helion Stackato 3.4 specific command.

+ options
stackato unmap <application> <url>

Unregister the application from a URL.

+ options
stackato unset-env <application> <varname>

Remove the specified environment variable from the named application.

+ options

Placement

stackato placement-zones

Show the available placement zones. This is a Helion Stackato 3.2+ specific command.

+ options
stackato placement-zone <zone>

Show the list of DEAs associated with the specified placement zone. This is a Helion Stackato 3.2+ specific command.

+ options
stackato set-placement-zone <application> <zone>

Associate the application with a specific placement zone. This is a Helion Stackato 3.2+ specific command.

+ options
stackato unset-placement-zone <application>

Remove the association between application and its current placement zone. This is a Helion Stackato 3.2+ specific command.

+ options

Environment Variable Groups

stackato environment-variable-group

Show the details of the specified environment variable group. This is a Helion Stackato 3.6 command.

+ options
stackato set-environment-variable-group

Set the contents of the specified environment variable group. This is a Helion Stackato 3.6 command.

+ options

Feature Flags

stackato disable-feature-flag <name>

Deactivate the specified feature. This is a Helion Stackato 3.4.2 command.

+ options
stackato enable-feature-flag <name>

Activate the specified feature. This is a Helion Stackato 3.4.2 command.

+ options
stackato feature-flags

Show all known feature flags and their status. This is a Helion Stackato 3.4.2 command.

+ options
stackato feature-flag <name>

Show the details of the specified feature flag. This is a Helion Stackato 3.4.2 command.

+ options

Services

stackato marketplace

List the supported service plans of the target, for the current or specified space. This is a Helion Stackato 3.4+ specific command.

+ options
stackato purge-service-offerings <service>

Purge all offerings of the service type from the system. Danger. Do this only for services whose brokers are known to be killed, leaving behind orphans. This is a Helion Stackato 3.4+ specific command.

+ options
stackato services

List the supported and provisioned services of the target.

+ options
stackato service <name>

Show the information about the named service.

+ options

Authentication Tokens

stackato create-service-auth-token <label> <provider>

Create a new service authentication token. This is a Helion Stackato 3 specific command.

+ options
stackato delete-service-auth-token <label>

Delete the specified service authentication token. This is a Helion Stackato 3 specific command.

+ options
stackato service-auth-tokens

Show all service authentication tokens knowns to the target. This is a Helion Stackato 3 specific command.

+ options
stackato update-service-auth-token <label>

Update the specified service authentication token. This is a Helion Stackato 3 specific command.

+ options

Brokers

stackato add-service-broker <name>

Make the named service broker known. This is a Helion Stackato 3 specific command.

+ options
stackato create-service-broker <name>

Make the named service broker known. This is a Helion Stackato 3 specific command.

+ options
stackato delete-service-broker <name>

Remove the named service broker from the target. This is a Helion Stackato 3 specific command.

+ options
stackato remove-service-broker <name>

Remove the named service broker from the target. This is a Helion Stackato 3 specific command.

+ options
stackato service-brokers

Show the list of known service brokers. This is a Helion Stackato 3 specific command.

+ options
stackato show-service-broker <name>

Show the information of the named service broker from the target. This is a Helion Stackato 3 specific command.

+ options
stackato update-service-broker <name> <newname>

Update the target's knowledge of the named service broker. This is a Helion Stackato 3 specific command.

+ options

Management

stackato bind-service <service> <application>

Bind the named service to the specified application.

+ options
stackato clone-services <source> <application>

Copy the service bindings of the source application to the destination application.

+ options
stackato create-service <vendor> <name> <application>

Create a new provisioned service, and optionally bind it to an application.

+ options
stackato delete-service <service>

Delete the named provisioned service.

+ options
stackato rename-service <service> <name>

Rename the specified service instance. This is a Helion Stackato 3 specific command.

+ options
stackato tunnel <service> <tunnelclient>

Create a local tunnel to a service, optionally start a local client as well.

+ options
stackato unbind-service <service> <application>

Disconnect the named service from the specified application.

+ options
stackato update-user-provided-service <service>

Update the credentials of a user provided service. This is a Helion Stackato 3 specific command.

+ options

Plans

stackato hide-service-plan <name> <organization>

Hide the specified service-plan from the named organization. This is a Helion Stackato 3 specific command.

+ options
stackato service-plans

List all available plans of the supported services. This is a Helion Stackato 3 specific command.

+ options
stackato service-plan <name>

Show the details of the specified service plan. This is a Helion Stackato 3 specific command.

+ options
stackato show-service-plan <name> <organization>

Make the specified service-plan visible to the named organization. This is a Helion Stackato 3 specific command.

+ options
stackato update-service-plan <name> <newname>

Update the target's knowledge of the named service plan. This is a Helion Stackato 3 specific command.

+ options

Introspection

Command history

stackato history clear

Clear the saved history.

stackato history limit <n>

Limit the size of the history. If no limit is specified the current limit is displayed.

stackato history list <n>

Show the saved history of commands.

organizations

stackato create-org <name>

Create a new organization. This is a Helion Stackato 3 specific command.

+ options
stackato delete-org <name>

Delete the named organization. This is a Helion Stackato 3 specific command.

+ options
stackato org-users <org>

Show the users for the organization, by role.

+ options
stackato orgs

List the available organizations. This is a Helion Stackato 3 specific command.

+ options
stackato org <name>

Show the named organization's information. This is a Helion Stackato 3 specific command.

+ options
stackato quota-org <name> <quota>

Set the quotas for the current or named organization. This is a Helion Stackato 3 specific command.

+ options
stackato rename-org <name> <newname>

Rename the named organization. This is a Helion Stackato 3 specific command.

+ options
stackato switch-org <name>

Switch the current organization to the named organization. This invalidates the current space. This is a Helion Stackato 3 specific command.

+ options
stackato update-org <name>

Change one or more attributes of an organization in a single call.

+ options

Security Groups

stackato bind-security-group <security_group>

Bind the named security group to either the current or specified space, or the running and staging phases. This is a Helion Stackato 3.4.2 command.

+ options
stackato create-security-group <security_group> <rules>

Create a new security group. This is a Helion Stackato 3.4.2 command.

+ options
stackato delete-security-group <security_group>

Delete the named security group. This is a Helion Stackato 3.4.2 command.

+ options
stackato security-groups

Show the known security groups, either all, or just those assigned to the running and staging phases. This is a Helion Stackato 3.4.2 command.

+ options
stackato security-group <security_group>

Show the details of the named security group. This is a Helion Stackato 3.4.2 command.

+ options
stackato unbind-security-group <security_group>

Drop the named security group from either the current or specified space, or the running and staging phases. This is a Helion Stackato 3.4.2 command.

+ options
stackato update-security-group <security_group> <rules>

Modify the named security group (replace the set of rules with a new set). This is a Helion Stackato 3.4.2 command.

+ options

Spaces

stackato create-space <name>

Create a new space. This is a Helion Stackato 3 specific command.

+ options
stackato delete-space <name>

Delete the named space. This is a Helion Stackato 3 specific command.

+ options
stackato rename-space <name> <newname>

Rename the named space. This is a Helion Stackato 3 specific command.

+ options
stackato space-users <space>

Show the users for the space, by role.

+ options
stackato spaces

List the available spaces in the specified organization. See --organization for details This is a Helion Stackato 3 specific command.

+ options
stackato space <name>

Show the named space's information. This is a Helion Stackato 3 specific command.

+ options
stackato switch-space <name>

Switch from the current space to the named space. This may switch the organization as well. This is a Helion Stackato 3 specific command.

+ options
stackato update-space <name>

Change one or more attributes of a space in a single call.

+ options

Routes

stackato delete-route <name>

Delete the named route. This is a Helion Stackato 3 specific command.

+ options
stackato routes

List all available routes in the specified space, or all. This is a Helion Stackato 3 specific command.

+ options

Domains

stackato create-domain <name>

Create a new domain. This is a Helion Stackato 3.2+ specific command.

+ options
stackato delete-domain <name>

Delete the named domain. This is a Helion Stackato 3.2+ specific command.

+ options
stackato domains

List the available domains in the specified space, or all. This is a Helion Stackato 3 specific command.

+ options
stackato map-domain <name>

Add the named domain to an organization or space. This is a Helion Stackato 3 specific command. This command is not supported by Helion Stackato 3.2 or higher.

+ options
stackato unmap-domain <name>

Remove the named domain from an organization or space. This is a Helion Stackato 3 specific command. This command is not supported by Helion Stackato 3.2 or higher.

+ options

Administration

stackato admin grant <email>

Grant the named user administrator privileges for the current or specified target.

stackato admin list

Show a list of the administrators for the current or specified target.

+ options
stackato admin report <destination>

Retrieve a report containing the logs of the current or specified target. This is a stackato-specific command.

+ options
stackato admin revoke <email>

Revoke administrator privileges for the named user at the current or specified target.

stackato frameworks

List the supported frameworks of the target. This is a Stackato 2 specific command.

+ options
stackato info

Show the basic system and account information.

+ options
stackato runtimes

List the supported runtimes of the target. This is a Stackato 2 specific command.

+ options
stackato show-token

Print the current target's token.

+ options
stackato stacks

List the supported stacks of the target. This is a Helion Stackato 3 specific command.

+ options
stackato targets

List the available targets, and their authorization tokens, if any.

+ options
stackato tokens

List the available targets, and their authorization tokens, if any.

+ options
stackato usage <userOrGroup>

Show the current memory allocation and usage of the active or specified user/group (Stackato 2), or the specified or current space (Helion Stackato 3).

+ options
stackato user-info <name>

Shows the information of a user in the current or specified target. Defaults to the current user. Naming a specific user requires a Helion Stackato 3 target.

+ options
stackato user

Show the name of the current user in the current or specified target.

+ options
stackato version

Print the version number of the client.

Buildpacks

stackato buildpacks

Show all buildpacks known to the target, in the order they are checked in during auto-detection.

+ options
stackato create-buildpack <name> <zip>

Add a buildpack to the target.

+ options
stackato delete-buildpack <name>

Remove the specified buildpack from the target.

+ options
stackato rename-buildpack <name> <newname>

Change the name of the specified buildpack.

+ options
stackato update-buildpack <name>

Change the information known about the specified buildpack.

+ options

Colors

stackato color list

Show the current color settings.

stackato color set <color> <specification>

(Re)define a color.

stackato color test <specification> <string>

Test a color specification.

stackato color unset <color>

Remove a color redefinition.

stackato colors

Show the current color settings.

Groups (Stackato 2)

stackato groups add-user <group> <user>

Add the named user to the specified group. This is a Stackato 2 specific command.

+ options
stackato groups create <name>

Create a new group with the specified name. This is a Stackato 2 specific command.

+ options
stackato groups delete-user <group> <user>

Remove the named user from the specified group. This is a Stackato 2 specific command.

+ options
stackato groups delete <name>

Delete the named group. This is a Stackato 2 specific command.

+ options
stackato groups limits <group>

Show and/or modify the limits applying to applications in the named group. This is a Stackato 2 specific command.

+ options
stackato groups show

Show the list of groups known to the target. This is a Stackato 2 specific command.

+ options
stackato groups users <group>

Show the list of users in the named group. This is a Stackato 2 specific command.

+ options
stackato group <name>

Report the current group, or unset it. This is a Stackato 2 specific command.

+ options
stackato limits <group>

Show and/or modify the limits applying to applications in the named group. This is a Stackato 2 specific command.

+ options

Quotas

stackato quota configure <name>

Reconfigure the named quota plan. This is a Helion Stackato 3 specific command.

+ options
stackato quota create <name>

Create a new quota plan. This is a Helion Stackato 3 specific command.

+ options
stackato quota delete <name>

Delete the named quota plan. This is a Helion Stackato 3 specific command.

+ options
stackato quota list

List the available quota plans. This is a Helion Stackato 3 specific command.

+ options
stackato quota rename <name> <newname>

Rename the named quota plan. This is a Helion Stackato 3 specific command.

+ options
stackato quota show <name>

Show the details of the named quota plan. If not specified it will be asked for interactively (menu). This is a Helion Stackato 3 specific command.

+ options
stackato quotas

List the available quota plans. This is a Helion Stackato 3 specific command.

+ options

Space Quotas

stackato create-space-quota <name>

Create a new space quota. It will be owned by the current or specified organization. This is a Helion Stackato 3.4.2 command.

+ options
stackato delete-space-quota <name>

Delete the named space quota. This is a Helion Stackato 3.4.2 command.

+ options
stackato rename-space-quota <name> <newname>

Rename the named space quota. This is a Helion Stackato 3.4.2 command.

+ options
stackato set-space-quota <name>

Assign the specified space quota to the current or specified space. This is a Helion Stackato 3.4.2 command.

+ options
stackato space-quotas

List the space quotas owned by the current or specified organization, or all. This is a Helion Stackato 3.4.2 command.

+ options
stackato space-quota <name>

Show the details of the named space quota. If not specified it will be asked for interactively (menu). This is a Helion Stackato 3.4.2 command.

+ options
stackato unset-space-quota

Drop the space quota from the current or specified space. This is a Helion Stackato 3.4.2 command.

+ options
stackato update-space-quota <name>

Modify the named space quota. This is a Helion Stackato 3.4.2 command.

+ options

User Management

stackato add-user <name>

Register a new user in the current or specified target. This operation requires administrator privileges, except if "allow_registration" is set server-side. This exception is specific to Stackato 2.

+ options
stackato delete-user <email>

Delete the named user, and the user's applications and services from the current or specified target. This operation requires administrator privileges.

+ options
stackato login-fields

Show the names of the credential fields needed for a login. This is a Helion Stackato 3 specific command.

+ options
stackato passwd

Change the password of the current user in the current or specified target.

+ options
stackato register <name>

Register a new user in the current or specified target. This operation requires administrator privileges, except if "allow_registration" is set server-side. This exception is specific to Stackato 2.

+ options
stackato token

Interactively set authentication token.

+ options
stackato unregister <email>

Delete the named user, and the user's applications and services from the current or specified target. This operation requires administrator privileges.

+ options
stackato users

Show the list of users known to the current or specified target.

+ options

Convenience

stackato aliases

List the known aliases (shortcuts).

+ options
stackato alias <name> <command>

Create a shortcut for a command (prefix).

stackato unalias <name>

Remove a shortcut by name.

Miscellaneous

stackato admin

A set of administrative tasks.

stackato color

Management of terminal colors

stackato curl <operation> <path> <header>

Run a raw rest request against the chosen target.

+ options
stackato drain

Commands for the management of drains attached to applications.

stackato groups

A collection of commands to manage groups and the users in them.

stackato guid <type> <name>

Map the specified name into a uuid, given the type. This is a Helion Stackato 3 specific command.

+ options
stackato history

Display the command history.

stackato named-entities

List the entity types usable for 'guid' (the types of the named entities known to the client).

+ options
stackato quota

Management of quota plans.

stackato trace

Print the saved REST trace for the last client command to stdout.

+ options