init

Initialize a new Takomo project with standard project structure and minimal configuration files.

Usage

tkm init [--create-samples] [--project] [--regions]

Positional arguments

This command has no positional arguments.

Options

OptionRequiredDescription
--create-samplesno
Create sample configuration files.
--projectno
Name of the project. If this option is omitted, the project name will be prompted.
--regionsno
Regions of the project. This option can be used multiple times to set more than one region. If this option is omitted, the regions will be prompted.

Common Options

OptionRequiredDescription
--helpno
Show help.
--profile PROFILEno
Use a profile configured in ~/.aws/credentials file.
--log LEVELno
Set logging level. Allowed values are "trace", "debug", "info", "warn", "error". Defaults to "info".
--dir DIR
-d DIR
no
Set the project directory from where Takomo loads configuration.
--load-aws-sdk-configno
Instead of using profiles configured in ~/.aws/credentials, use profiles found from ~/.aws/config.
--var name=VALUEno
Set variable that can be referenced in configuration files. This option can be used multiple times to set multiple variables.
--var-file FILE
--var-file name=FILE
no
Load variables from a file. The variables can be referenced in configuration files. This option can be used multiple times to load variables from multiple files. If NAME is given, variables are loaded to a variable with that name.
--env-file FILEno
Load environment variables from a file. The variables can be referenced in configuration files. This option can be used multiple times to load variables from multiple files.
--log-confidential-infono
Allow printing of environment variables and confidential parameter values that are concealed from the logs by default.
--statsno
Print statistics information of the executed command.

Examples

Initialize a new project to the current directory:

tkm init

Initialize a new project to the current directory and create sample stacks:

tkm init --create-samples

Initialize a new project to /var/projects directory:

tkm init -d /var/projects