Skip to content

Commit 5b3afbe

Browse files
kaizenccrix0rrr
andauthored
docs(cli): unstable flag documentation (#159)
document `--unstable` flag outside of `cdk gc`, since it is a global option available to additional use cases. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license Co-authored-by: Rico Hermans <[email protected]>
1 parent 47beb66 commit 5b3afbe

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

packages/aws-cdk/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,21 @@ The AWS CDK Toolkit provides the `cdk` command-line interface that can be used t
3939

4040
This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
4141

42+
## Global Options
43+
44+
### `unstable`
45+
46+
The `--unstable` flag indicates that the scope and API of a feature might still change.
47+
Otherwise the feature is generally production ready and fully supported. For example,
48+
`cdk gc` is gated behind an `--unstable` flag:
49+
50+
```bash
51+
cdk gc --unstable=gc
52+
```
53+
54+
The command will fail if `--unstable=gc` is not passed in, which acknowledges that the user
55+
is aware of the caveats in place for the feature.
56+
4257
## Commands
4358

4459
### `cdk docs`

0 commit comments

Comments
 (0)