Skip to content

docs(cli): unstable flag documentation #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 27, 2025
Merged

docs(cli): unstable flag documentation #159

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba2f5cd
docs(cli): unstable flag documentation
kaizencc Feb 26, 2025
cabb329
Merge branch 'main' into conroy/gc
rix0rrr Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/aws-cdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ The AWS CDK Toolkit provides the `cdk` command-line interface that can be used t

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

## Global Options

### `unstable`

The `--unstable` flag indicates that the scope and API of a feature might still change.
Otherwise the feature is generally production ready and fully supported. For example,
`cdk gc` is gated behind an `--unstable` flag:

```bash
cdk gc --unstable=gc
```

The command will fail if `--unstable=gc` is not passed in, which acknowledges that the user
is aware of the caveats in place for the feature.

## Commands

### `cdk docs`
Expand Down