Close

Using CLI

Basic usage

Every command should have the following form:

stacktape <<command>> --option1 <<option1>> --option2 <<option2>> ...more options...

Aliases

For convenience, you can use aliases for stacktape binary itself and for CLI options.


For example following command:
stacktape deploy --stage production --region eu-west-1 --configPath path/to/my/config.yml --preserveTempFiles

Can be shortened into:

stp deploy --s production --r eu-west-1 --cp path/to/my/config.yml --ptf

Log level

Stacktape prints information about what it's doing to the console. You can customize what's being printed.

You can set log level using:

stacktape <<command>> --logLevel << info | error | debug >>

ValueDescription
info (default)Prints basic information about everything that's happening.
errorPrints only errors.
debugPrints detailed information about everything that's happening. Prints every remote call to AWS services.

Log format

Adjusts the way logs are printed to the console.

You can set log format using:

stacktape <<command>> --logFormat << fancy | normal | json | basic >>

ValueDescription
fancy (default)Logs are colorized and dynamically re-rendered.
normalLogs are colorized but not dynamically re-rendered.
basicSimple text only
jsonLogs are printed as JSON objects
🚀 Getting Started — Previous
Quick Start
Next — 💻 CLI
deploy