Takomo
  • What is Takomo?
  • Getting started
    • Installation
    • Quick start
    • Tutorial
  • Configuration
    • AWS credentials
    • Directory structure
    • Stacks and stack groups
    • Project configuration
  • Stack properties
    • Name
    • Regions
    • Template
    • Template bucket
    • Command role
    • Account ids
    • Depends
    • Parameters
    • Tags
    • Inherit tags
    • Termination protection
    • Timeout
    • Capabilities
    • Stack policy
    • Ignore
    • Obsolete
    • Hooks
    • Data
    • Schemas
  • Variables and templating
    • Introduction
    • Handlebars syntax
    • Environment variables
    • Command-line variables
    • Partials
    • Helpers
    • Available variables
  • Parameter resolvers
    • Built-in parameter resolvers
      • Stack output resolver
      • External stack output resolver
      • Command resolver
      • File contents resolver
      • Hook output resolver
      • SSM parameter resolver
      • Secret resolver
    • Custom parameter resolvers
  • Hooks
    • Built-in hooks
    • Custom hooks
    • Sharing data between hooks
  • Validation schemas
    • Custom validation schemas
  • Command-line usage
    • Common options
    • Deploy stacks
    • Undeploy stacks
    • Prune stacks
    • List stacks
    • Detect drift
    • Generate IAM policies
    • Inspect stack configuration
    • Inspect stack dependencies
  • Support
    • Getting help
    • Troubleshooting
  • Development
    • Change log
Powered by GitBook
On this page
  • Assume yes to all questions
  • Display help
  • Display Takomo version
  • Enable confidential information logging
  • Enable statistics
  • Feature flags
  • Load AWS SDK config
  • Load environment variables from a file
  • Set logging level
  • Set project dir
  • Set variables
  • Show command to generate IAM policies
  • Suppress all but the final output
  • Use AWS profile

Was this helpful?

Export as PDF
  1. Command-line usage

Common options

PreviousCustom validation schemasNextDeploy stacks

Last updated 3 years ago

Was this helpful?

Here are the options available for all commands (unless stated otherwise).

Assume yes to all questions

Pass --yes or -y option to answer yes to all questions.

Display help

Pass --help option to display help. Command specific helps include also the minimum IAM permissions needed to run the command.

Display Takomo version

Pass --version option to print version information.

Enable confidential information logging

By default, environment variables and confidential parameter values are concealed from logs. Override this default by passing --log-confidential-info.

Enable statistics

Use --stats option to print statistics information of the executed command.

Feature flags

You can use --feature <feature>=<boolean value> option to enable and disable certain Takomo features.

Available feature flags:

Load AWS SDK config

Use --load-aws-sdk-config to prefer loading credentials from configuration file over the credentials file. Passing this option will enable loading the profile from ~/.aws/config file.

Load environment variables from a file

Use --env-file <path-to-environment-variables-file> to load environment variables from a file. The loaded variables override existing variables with the same name. This option can be used multiple times.

DB_HOST=localhost
DB_USER=root
DB_PASS=s1mpl3

Set logging level

Use --log <level> option to choose the logging level.

Supported values are:

  • trace

  • debug

  • info (default)

  • warn

  • error

  • none (suppress all logging)

Set project dir

Use --dir <directory> or -d <directory> option to define the directory from where Takomo loads configuration.

Set variables

Pass --var and --var-file options to provide variables that can be used in stack group and stack configuration files and stack templates. Both options can be used multiple times.

Show command to generate IAM policies

Use --show-generate-iam-policies option to print instructions how to generate IAM policies needed to run the command.

Suppress all but the final output

Use --quiet or -q to suppress all logging and all but the final output. Useful when you want to write the command output to a file.

Use AWS profile

Use --profile <profile> option to choose which AWS profile to use.

deploymentTargetsUndeploy - Set false to disable command

deploymentTargetsTearDown - Set false to disable command

The environment variables must be defined in a format accepted by , like so:

For more information, see .

For more information, see .

undeploy deployment targets
tear down deployment targets
dotenv
command-line variables
AWS credentials
Assume yes to all questions
Display help
Display Takomo version
Enable confidential information logging
Enable statistics
Feature flags
Load AWS SDK config
Load environment variables from a file
Set logging level
Set project dir
Set variables
Show command to generate IAM policies
Suppress all but the final output
Use AWS profile