# Quick Start

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

# Installation

Install Takomo globally:

npm i -g takomo

Verify installation:

tkm --version

# AWS Credentials

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


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 manually create all the needed directories and files. If you just want to try out how to deploy infra with Takomo, you can use initialize a new project command to create the files:

tkm init --create-samples

# Stack Configuration

Our stack contains a VPC whose CIDR range can be parameterized. First, we need to create a stacks directory that will host all stack configurations. Create the directory and add there 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 templates directory next to the stacks directory, and add there 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:

tkm stacks deploy --profile takomo-example

You will be prompted if you want to continue the deployment. You also need to review and approve the changes. If you answer yes to both questions, then the deploy will proceed, and given your AWS credentials had all the needed IAM permissions, it should also succeed.

# Clean Up

You can delete the stack with command:

tkm stacks undeploy --profile takomo-example

# Next steps

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

Last Updated: 6/14/2020, 6:13:01 PM