https://github.com/cdk-patterns/cli

This is the cli tool to accompany cdkpatterns.com, you can now deploy any pattern from 0 code in just 3 commands
https://github.com/cdk-patterns/cli

Last synced: 9 months ago
JSON representation

This is the cli tool to accompany cdkpatterns.com, you can now deploy any pattern from 0 code in just 3 commands

• Host: GitHub
• URL: https://github.com/cdk-patterns/cli
• Owner: cdk-patterns
• Created: 2020-03-08T09:32:08.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-13T03:34:52.000Z (about 4 years ago)
• Last Synced: 2025-04-02T02:19:38.616Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 561 KB
• Stars: 34
• Watchers: 3
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
cdkp

====

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Downloads](https://img.shields.io/npm/dt/cdkp)](https://npmjs.org/package/cdkp)

CLI tool for cdkpatterns.com to make it as simple as one command to download and learn a new pattern. This tool will only download the one pattern you are interested in rather than the whole repo.

### Three Simple Commands To Deploy A pattern



## Requirements

You must have git installed on your system as this is what is used to download the pattern. This uses the code at cdkpatterns.com, there is no external api.

## Usage

### Downloading a pattern

`npx cdkp init {pattern-name}`

pattern-name is the string name of any of the existing patterns on cdkpatterns.com with - instead of spaces e.g.

* `npx cdkp init the-big-fan`

* `npx cdkp init the-simple-webservice`

* `npx cdkp init the-eventbridge-atm`

### Viewing Available Patterns

you can view all available patterns by using the list command:

* `npx cdkp list`

### Advanced Usage

If you want to download the python version of a pattern you just need to include the --lang=python flag in the command:

* `npx cdkp init the-big-fan --lang=python`

You can also only init a pattern into a directory once because the second time would wipe the contents of the folder. There is a -f flag if you really want to wipe the contents e.g.

* `npx cdkp init the-big-fan -f`

If a folder called the-big-fan already existed in the directory you ran the command because you added the force flag it will be wiped