Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
misterjoshua authored Feb 18, 2022
1 parent 79bd3b0 commit 0f9df5d
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# AWS CDK Exec

Provides `cdk-exec`, a command to tighten up your AWS CDK development loop by
helping you find and execute the physical resources for your lambdas and state
machines, with or without input.
Provides `cdk-exec`, an AWS CDK dev tool to quickly find and execute your
Lambdas and State Machines in AWS.

```
$ cdk-exec integ-cdk-exec/Function --input '{"succeed":true}'
Expand All @@ -26,6 +25,9 @@ First, add `@wheatstalk/aws-cdk-exec` to your project's dev dependencies.
Then synthesize your app to a `cdk.out` directory. Once synthesized there, you
can execute one of your resources with `cdk-exec`.

> If you're using `cdk watch`, the CDK will keep your `cdk.out` up to date, so
> when you use watch mode, you can run `cdk-exec` (roughly) at will.
## Full Example

**app.ts**
Expand Down Expand Up @@ -70,9 +72,6 @@ directory), so the first step is to synthesize your app:
$ cdk synth --output cdk.out
```

> If you're using `cdk watch`, the CDK will keep your `cdk.out` up to date so
> that you can start watch mode and use `cdk-exec` (roughly) at will.
**Execute a state machine with input**

```
Expand Down Expand Up @@ -131,4 +130,4 @@ supported resource, you will receive an error message.

**Path metadata**

This tool requires path metadata to be enabled in your assembly.
This tool requires path metadata to be enabled in your assembly.

0 comments on commit 0f9df5d

Please sign in to comment.