docs fixup

aws · Jan 18, 2023 · 281d1d9 · 281d1d9
1 parent 8925a32
commit 281d1d9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/packages/@aws-cdk/cli-lib/README.md b/packages/@aws-cdk/cli-lib/README.md
@@ -15,11 +15,22 @@
 
 <!--END STABILITY BANNER-->
 
-## Overview
+## ⚠️ Experimental module
+
+This package is highly experimental. Expect frequent API changes and incomplete features.
+Known issues include:
 
-This package provides a library to interact with the AWS CDK CLI programmatically.
+- **JavaScript/TypeScript only**\
+  The jsii packages are currently not in a working state.
+- **No useful return values**\
+  All output is currently printed to stdout/stderr
+- **Missing or Broken options**\
+  Some CLI options might not be available in this package or broken
+
+## Overview
 
-Currently the package has implementations for:
+Provides a library to interact with the AWS CDK CLI programmatically from jsii supported languages.
+Currently the package includes implementations for:
 
 - `cdk deploy`
 - `cdk synth`

diff --git a/packages/@aws-cdk/cli-lib/lib/cli.ts b/packages/@aws-cdk/cli-lib/lib/cli.ts
@@ -292,4 +292,4 @@ async function withEnv(block: () => Promise<any>, env: Record<string, string> =
   } finally {
     process.env = originalEnv;
   }
-}
+}