Overview and basic usage
script:run
Executes a script defined in your configuration.
You can pass environment variables to the script using the --env option (e.g., --env MY_VAR=my_value).
To learn more, refer to the scripts documentation.
API reference
region (--r)Required
AWS Region
Type: string
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
The AWS region for the operation. For a list of available regions, see the AWS documentation.
scriptName (--scn)Required
Script Name
Type: string
The name of the script to run, which must be defined in the scripts section of your configuration.
stage (--s)Required
Stage
Type: string
The stage for the operation (e.g., production, staging, dev-john). You can set a default stage using the defaults:configure command. The maximum length is 12 characters.
assumeRoleOfResource (--aror)
Assume Role of Resource
Type: string
The name of the deployed resource whose IAM role should be assumed during script execution.
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.
configPath (--cp)
Config File Path
Type: string
The path to your Stacktape configuration file, relative to the current working directory.
currentWorkingDirectory (--cwd)
Current Working Directory
Type: string
The working directory for the operation. All file paths in your configuration will be resolved relative to this directory. By default, this is the directory containing the configuration file.
env (--env)
Environment Variables
Type: array
A list of environment variables for the script, in the format name=value. To add multiple variables, use this option multiple times (e.g., --env VAR1=val1 --env VAR2=val2).
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.
projectName (--prj)
Project Name
Type: string
The name of the Stacktape project for this operation.
templateId (--ti)
Template ID
Type: string
The ID of the template to download. You can find a list of available templates on the Config Builder page.