@@ -5,51 +5,70 @@ for defining cloud infrastructure in code.
55
66## Getting Started
77
8- ### Installation
8+ ### Prerequisites
9+
10+ Make sure you have the following prerequisites installed:
911
10- Make sure you have the required dependencies installed:
1112* [ Node.js 8.11.0] ( https://nodejs.org/download/release/v8.11.0/ )
12- * The SDK for the language you intend to use (Java, .Net, Ruby, ...)
13+ * [ AWS CLI] ( https://aws.amazon.com/cli/ ) (only needed if you intend to download the release from S3).
14+ * The development toolchain of the language you intend to use (TypeScript,
15+ Python, Java, .NET, Ruby...)
16+
17+ ### Downloading the bits
18+
19+ The CDK is distributed as a single zip file which contains:
20+
21+ 1 . The CDK command-line toolkit
22+ 2 . Documentation HTML
23+ 2 . JavaScript/TypeScript Framework and AWS Constructs
24+ 3 . Java Framework and AWS Constructs
25+
26+ You can either download the zip file from the
27+ [ Releases] ( http://github.com/awslabs/aws-cdk/releases ) page on GitHub or if you
28+ prefer, download them bits from S3 using the URL provided by our team.
29+
30+ To download from S3:
1331
14- Download the current release bundle from S3, and install it to ` ~/.cdk ` :
1532``` shell
16- tmpdir=/tmp/aws-cdk-install
17- mkdir ${tmpdir}
18- aws s3 cp s3://< bucket> /< key> ${tmpdir} /aws-cdk.zip
19- unzip -o ${tmpdir} /aws-cdk.zip -d ~ /.cdk
33+ aws s3 cp < s3-url> ~ /aws-cdk.zip
2034```
2135
22- Then add the CDK to your ` $PATH ` :
36+ ### Install to ~ /.cdk
37+
38+ Once you've downloaded the bits, install them into ` ~/.cdk ` :
39+
2340``` shell
24- # At the end of your ~/.bashrc or ~/.zshrc file
25- export PATH=${PATH: +${PATH} : }${HOME} /.cdk/bin
41+ rm -fr ~ /.cdk
42+ mkdir ~ /.cdk
43+ unzip < path-to-zip-file> -d ~ /.cdk
2644```
2745
28- ### Creating a new project
46+ Make sure the ~ /.cdk/bin is in your ` PATH `
2947
30- New projects can be initialized using ` cdk init ` .
3148``` shell
32- mkdir ${PROJECT_NAME}
33- cd ${PROJECT_NAME}
34- cdk init
49+ # at the end of your ~/.bashrc or ~/.zshrc file
50+ export PATH=$PATH :$HOME /.cdk/bin
3551```
3652
37- ### Useful commands
53+ To check which CDK version you have installed:
3854
3955``` shell
40- # Initialize a new CDK project
41- cdk init
56+ cdk --version
57+ ```
4258
43- # Open the documentation in a web browser
44- cdk docs
59+ ### Viewing Documentation
4560
46- # List available commands
47- cdk help
61+ To view CDK documentation bundled with the release, run:
4862
49- # Get help on a particular command (e.g: synth)
50- cdk help synth
63+ ``` shell
64+ cdk docs
5165```
5266
67+ ### Next steps?
68+
69+ Follow the "Getting Started" guide in CDK docs to initialize your first CDK
70+ project and deploy it to an AWS account.
71+
5372## Development Environment
5473
5574This is a monorepo which uses [ lerna] ( https://github.com/lerna/lerna ) .
0 commit comments