Stacktape


script:run

Overview and basic usage

Executes the specified script.


  • To learn more about scripts, refer to script docs.
  • Optionally, you can add environment variables to the script using --env my_var=my_value

Copy

stacktape script:run --stage <<stage>> --scriptName <<scriptName>>

API reference

Options

region (--r)
Required

AWS region to use for the current operation.

Type: string ENUM

Possible values: af-south-1ap-east-1ap-northeast-1ap-northeast-2ap-northeast-3ap-south-1ap-southeast-1ap-southeast-2ca-central-1eu-central-1eu-north-1eu-south-1eu-west-1eu-west-2eu-west-3me-south-1sa-east-1us-east-1us-east-2us-west-1us-west-2

scriptName (--scn)
Required

Name of the script to run

Type: string

  • Must be defined in the scripts section of the configuration.
stage (--s)
Required

Stage used for the operation.

Type: string

  • Example stages are production, staging, 'testing' or 'dev-john'.
  • You can configure the default stage used with every Stacktape command using the defaults:configure command.
  • Maximum allowed length is 12 characters.
configPath (--cp)

Path to your stacktape configuration file.

Type: string

  • Relative to CWD (current working directory).
currentWorkingDirectory (--cwd)

Current working directory for the current operation.

Type: string

  • Every file path in your config will be resolved relatively to specified cwd.
  • By default, directory containing the configuration file is used.
env (--env)

List of environment variables for the script.

Type: array

  • Must be in the following format: name=value.
  • To add multiple variables, use this option multiple times.
  • Example: --env var1=val1 --env var2=val2 will result in the following environment: { var1: "val1", var2: "val2" }
help (--h)

Shows help for the command

Type: string

  • If specified, the command won't perform any action besides printing help.
logFormat (--lf)

Format of logs printed to your console.

Type: string ENUM

Possible values: basicfancyjsonnormal

Available options:

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

Level of logs that are being printed to the console.

Type: string ENUM

Possible values: debugerrorinfo

Available options:

  • info: Prints basic information about everything that's happening.
  • error: Prints only errors.
  • debug: Prints detailed information about everything that's happening.
profile (--p)

AWS profile to use with the command

Type: string

  • You can manage AWS profiles on your system using aws-profile:create, aws-profile:update or aws-profile:delete command.
  • You can configure the default profile used with every Stacktape command using the defaults:configure command.
Need help? Ask a question on SlackDiscord or info@stacktape.com.