cdk-app-cli 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,24 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
The operator CLI for CDK apps. Experimental.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
cdk-app [construct] [subcommand]
|
|
5
|
+
`cdk-app` lets you associate commands with CDK constructs so that you can quickly invoke functions, redrive queues, visit resources in the AWS console, and more by just referencing the construct name.
|
|
7
6
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
Positionals:
|
|
11
|
-
construct [string] [required]
|
|
12
|
-
subcommand [string]
|
|
7
|
+
### Examples:
|
|
13
8
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
Extra configuration options available via environment variables:
|
|
19
|
-
|
|
20
|
-
- CDK_APP_DIR - Path to cdk.out.
|
|
21
|
-
- AWS_REGION - AWS region to run commands in.
|
|
22
|
-
```
|
|
9
|
+
* `cdk-app MyLambda tail-logs` - stream logs in real time from the Lambda's log group
|
|
10
|
+
* `cdk-app TransactionTable visit-console` - open the AWS console page for your table
|
|
11
|
+
* `cdk-app OrderQueue redrive-queue` - retry messages that failed to get processed
|
|
23
12
|
|
|
24
13
|
## 🚀 Getting Started
|
|
25
14
|
|
|
@@ -105,14 +94,37 @@ done
|
|
|
105
94
|
|
|
106
95
|
## 📖 Documentation
|
|
107
96
|
|
|
108
|
-
### Command
|
|
97
|
+
### Command line options
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
cdk-app [construct] [subcommand]
|
|
101
|
+
|
|
102
|
+
Run an operator command on your CDK app's constructs.
|
|
103
|
+
|
|
104
|
+
Positionals:
|
|
105
|
+
construct [string] [required]
|
|
106
|
+
subcommand [string]
|
|
107
|
+
|
|
108
|
+
Options:
|
|
109
|
+
--version Show version number [boolean]
|
|
110
|
+
--help Show help [boolean]
|
|
111
|
+
|
|
112
|
+
Extra configuration options available via environment variables:
|
|
113
|
+
|
|
114
|
+
- CDK_APP_DIR - Path to cdk.out.
|
|
115
|
+
- AWS_REGION - AWS region to run commands in.
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### construct-commands.json
|
|
119
|
+
|
|
120
|
+
#### Command types
|
|
109
121
|
|
|
110
122
|
| Type | Description |
|
|
111
123
|
| ----------- | ----------- |
|
|
112
124
|
| open | Specify a URL or file to open. |
|
|
113
125
|
| exec | Specify a command to run in your shell. |
|
|
114
126
|
|
|
115
|
-
|
|
127
|
+
#### Command substitutions
|
|
116
128
|
|
|
117
129
|
| Syntax | Description |
|
|
118
130
|
| ----------- | ----------- |
|