login

Overview and basic usage

login

Configures your Stacktape API key for the current system.

All subsequent operations will be associated with the user and organization linked to this API key. You can get your API key from the Stacktape console. You can provide the key with the --apiKey option or enter it interactively.


stacktape login

API reference

Options
apiKey (--ak)

API Key

Type: string

Your Stacktape API key. You can get your key from the Stacktape console. If you don't provide a key, you will be prompted to enter it. Note that providing the key directly in the command line is insecure, as it will be saved in your terminal history.

awsAccount (--aa)

AWS Account

Type: string

The name of the AWS account to use for the operation. The account must first be connected in the Stacktape console.

help (--h)

Show Help

Type: string

If provided, the command will not execute and will instead print help information.

logFormat (--lf)

Log Format

Type: string

Possible values: basicfancyjsonnormal

The format of logs printed to the console.

  • fancy: Colorized and dynamically re-rendered logs.
  • normal: Colorized but not dynamically re-rendered logs.
  • basic: Simple text only.
  • json: Logs printed as JSON objects.
logLevel (--ll)

Log Level

Type: string

Possible values: debugerrorinfo

The level of logs to print to the console.

  • info: Basic information about the operation.
  • error: Only errors.
  • debug: Detailed information for debugging.
profile (--p)

AWS Profile

Type: string

The AWS profile to use for the command. You can manage profiles using the aws-profile:* commands and set a default profile with defaults:configure.