Skip to content

Commit 96fafff

Browse files
committed
master
moving out the CLI stuff
1 parent ad37f86 commit 96fafff

21 files changed

+192
-2701
lines changed

README.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,11 @@
22

33
In alpha mode. Maybe pre-alpha. Docs coming soon.
44

5-
6-
## CLI
7-
8-
### Installation
9-
10-
`npm install -g nest-aws-serverless-tools`
11-
12-
### Basic Use
13-
14-
#### Initialization
15-
16-
In the same folder as package.json, run the following command:
17-
18-
`nest-aws-serverless-tools init --type=nest-express-api`
19-
20-
This script does the following:
21-
22-
1. Obtains required details about your API and CloudFormation app.
23-
2. Scaffolds a `cfn` directory with the CloudFormation template, a bare-bones OpenApi file, a parameters file, a tags file, and a deployment script for local use (CI/CD support & documentation coming). Also generates a `src/lambda-entry-point.ts` file for the Lambda bootstrapping.
24-
3. Installs required packages to support AWS and OpenApi tooling.
25-
4. Configures the `deploy` and `openapi` NPM scripts.
26-
5. Adds configuration for the `CloudFormationLambdaParametersConfig` tool and the OpenAPI generation tool.
27-
28-
## Nest Module & Tools
29-
305
#### Installation
316

32-
If you did not use the `init` process from the CLI, the tools package can be installed directly:
7+
If you did not use the `init` process from the `@aws-serverless-tools/cli` package, the tools package can be installed directly:
338

34-
`npm install --save nest-aws-serverless-tools`
9+
`npm install --save @aws-serverless-tools/cli`
3510

3611
### AwsServerlessToolsModule
3712

bin/run

Lines changed: 0 additions & 3 deletions
This file was deleted.

bin/run.cmd

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)