From e08b0811e034913d152e04b16fd5f3c08a90cb39 Mon Sep 17 00:00:00 2001 From: ljacobsson Date: Thu, 6 Apr 2023 23:44:39 +0200 Subject: [PATCH] Adding new command: describe --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 6428763..4cd65ba 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,22 @@ Options: ``` ![Demo](images/demo-gpt.gif) +### sam-patterns describe +Describes a pattern using ChatGPT and gives suggestions on how to improve security. + +``` +Usage: sampat describe|d [options] + +Describes a SAM template using ChatGPT + +Options: + -t, --template [template] SAM template file (default: "template.yaml") + -r, --repository-path [repository] Github repository path, i.e "aws-samples/serverless-patterns/apigw-sfn" + -m, --model [model] OpenAI model to use. Valid values are 'gpt-3.5-turbo' and 'gpt-4'. Note that gpt-3.5-turbo is fine for most use cases and that gpt-4 is slower and more expensive (default: "gpt-3.5-turbo") + -h, --help display help for command +``` + + #### Examples * To generate SAM resources for a Lambda function that reads off a DynamoDB table: `sam-patterns generate -q "a lambda function that reads off a dynamodb table"` * To generate a CDK stack for the same: `sam-patterns generate -q "a lambda function that reads off a dynamodb table" --output CDK --output-file cdk-stack.ts`