Quick Start

Before diving deeper into the documentation, let's first see how to create a simple CloudFormation stack using Takomo.


Initialize a new NPM project and add Takomo as a development dependency:

npm init -y
npm install -D takomo


You need to have valid AWS credentials configured. Create a profile named takomo-example in your ~/.aws/credentials file:

aws_access_key_id = XXXXXXXXXXXXXXXXXXXX

You can also provide credentials using some other method described here, but rest of this quick start guide assumes that you are using the takomo-example profile.

Initializing a new Takomo project using CLI

The rest of this quick start guide describes how to create all the needed directories and files manually. If you just want to try out how to deploy infrastructure with Takomo, you can initialize a new project and create the files using the following command:

npx tkm init --create-samples

Stack Configuration

Our stack contains a VPC whose CIDR range can be parameterized. First, we need to create the stacks directory that will host all stack configurations. Create the directory and add a file named vpc.yml with the following contents:

regions: eu-west-1

Stack Template

Next, we need to provide a CloudFormation template for our stack. Create the templates directory next to the stacks directory, and add a file named vpc.yml with the following contents:

Description: My VPC
Type: String
Description: VPC CIDR block
Type: AWS::EC2::VPC
CidrBlock: !Ref CidrBlock

Directory Structure

Now, you should have the following files in place:

โ”œโ”€ stacks
โ”‚ โ””โ”€ vpc.yml
โ””โ”€ templates
โ””โ”€ vpc.yml

Stack Deployment

Alright, we are ready to deploy our stack. Change to the project root directory and run:

npx tkm stacks deploy --profile takomo-example

Review the changes and continue to deploy the stack.

Clean Up

You can delete the stack with this command:

npx tkm stacks undeploy --profile takomo-example

Next steps

Continue to the next section to learn the basics of how Takomo works.