sabrinalameiras / iac-devtools-cli-for-cdk

IaC Developer Tools CLI for CDK (IDT)

This command line interface tool automates many of the tedious tasks of building, adding to, documenting, and extending AWS CDK applications. It is an opinionated tool that integrates Well-Architected principals of cloud native software design by default.

What is does

1. Automates templated build of a basic multi-stack CDK application with integrated security, devops, and pre-formatted documentation.
2. Automates templated build of a starter CDK stack
3. Automates templated build of a starter CDK construct
4. Automates templated build of DevOps tooling for CDK deployment on Github or Gitlab

How to use it

1/ Install the repository globally

To install directly from the git source you can also use the command below. Coming soon this will be available via npm.

npm i -g https://github.com/aws-samples/iac-devtools-cli-for-cdk.git

2/ Check install

npm ls -g

You should see a version of iac-devtools-cli-for-cdk listed in your node packages.

3/ Navigate to the directory you want to work from

If you are creating a new app you will need to create a new directory to work from

mkdir your-directory-name
cd your-directory-name

If you are adding a construct or stack you will need to navigate to the directory to work from

cd path/of/your/directory

Run the tool!

idt

You should see some options that look like this:

Follow the prompts to:

• Create a whole application
• Create an application stack
• Create an application construct
• Create devops tools

4/ Review what you have created

You will now see a full populated template in your working directory.

🌅 How to update

Since this is not yet in a public npm registry the easiest update method right now is to remove and then reinstall 😢. We are working on making this a little easier.

🗑️ How to remove

npm uninstall  -g @aws-energy-solutions/iac-devtools-cli-for-cdk

🗺️ Planned Features

• Build projects from templates
• CDK Typescript template
• CDK Typescript construct template
• CDK Custom Resource Template
• Github and Gitlab DevOps tools templates
• Run security checks
• BYO template directory