CloudCrafter CLI

CloudCrafter CLI is a command-line interface tool that provides templates for common cloud resources to help you get started quickly. It also includes additional scripts to configure project environments easily.

Installation

You can install CloudCrafter CLI globally using npm:

npm install -g cloud-crafter-cli

Alternatively, you can use npx to run the CLI without installing it globally:

npx cloud-crafter-cli create <template-name> <project-name>

Usage

Creating a New Project

To create a new project using a template, run the following command:

cloud-crafter-cli create <template-name> <project-name>

or use the alias ccc:

ccc create <template-name> <project-name>

For example, to create a new Serverless Framework HTTP service, you can run:

ccc create serverless/http my-new-project

Running a Script

To run a script that sets up additional configurations for your project, use the following command:

cloud-crafter-cli run <script-name>

or using the alias ccc:

ccc run <script-name>

For example, to quickly configure a JavaScript development environment with ESLint and Git hooks, you can run:

ccc run quickstart-js

Available Templates

AWS SAM

• sam/sqs (Standard Queues)
• sam/http (API Gateway V2)
• sam/http-express (API Gateway V2 + express setup)
• sam/http-express-esbuild (API Gateway V2 + express + esbuild setup)

Serverless Framework

• serverless/http (API Gateway V2)
• serverless/rest (API Gateway V1)
• serverless/s3 (S3 trigger)

CloudFormation

• cloudformation/dynamodb-table
• cloudformation/s3-public-read
• cloudformation/s3-static-website
• cloudformation/s3-static-website-v2

Utils

• utils/openai

Available Scripts

• quickstart-js (setup ESLint + Husky + lint-staged)

Contributing

If you'd like to contribute to CloudCrafter CLI, please fork the repository and create a pull request.

License

This repository is licensed under the MIT License. See the LICENSE file for more information.