Skip to content

cdk-dev/create-cdk-app

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

create-cdk-app

Create CDK apps from templates.

View templates here.

Usage

NPM

$ npx create-cdk-app <options> <project-dir>

Yarn

$ yarn create cdk-app <options> <project-dir>

If you choose a default template, you will be prompted to choose a language. This is then passed to a child-process that runs cdk init. This requires aws-cdk to be installed and available in the context of the shell.

A template from templates

$ yarn create cdk-app -t default my-new-app

This will scaffold the default template into the my-new-app directory.

Authentication

It is highly recommended that you set the following to environment variables:

GITHUB_USERNAME=<your username>
GITHUB_TOKEN=<personal access|oauth token>

These will be pulled in and used for all github-related requests.

Github will rate-limit you to 5000 calls per hour if you're not using authentication. This limit is easily reached if you use a lot of other tools that are making these types of requests, or if you share an internet connection with many other people interacting with github.

Using authentication also comes with the added benefit of being able to use private repos as template sources.

Adding a template

Please review the template contributing documentation.

Contributing

Please review the contributing documentation.

About

Create CDK Apps from Templates

Topics

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published