Skip to content

Commit 484b943

Browse files
committed
Document new CLI features
1 parent 1336b2e commit 484b943

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,37 @@ In addition to the library, the project provides the `chaosmonkey` command-line
3636
go get github.com/mlafeldt/chaosmonkey/cmd/chaosmonkey
3737
```
3838

39-
Use the tool to trigger a new chaos event:
39+
Use the tool to:
4040

41-
```bash
42-
chaosmonkey -endpoint http://chaosmonkey.example.com:8080 \
43-
-strategy ShutdownInstance -group ExampleAutoScalingGroup
44-
```
41+
* Trigger a new chaos event:
4542

46-
Or to get a list of past chaos events:
43+
```bash
44+
chaosmonkey -endpoint http://chaosmonkey.example.com:8080 \
45+
-strategy ShutdownInstance -group ExampleAutoScalingGroup
46+
```
4747

48-
```bash
49-
chaosmonkey -endpoint http://chaosmonkey.example.com:8080
50-
```
48+
* Get a list of past chaos events:
49+
50+
```bash
51+
chaosmonkey -endpoint http://chaosmonkey.example.com:8080
52+
```
53+
54+
* List all auto scaling groups for a given AWS account, which you may then pass to `-group`:
55+
56+
```bash
57+
export AWS_ACCESS_KEY_ID...
58+
export AWS_SECRET_ACCESS_KEY=...
59+
export AWS_REGION=...
60+
chaosmonkey -list-groups
61+
```
62+
63+
* List available chaos strategies, which you may pass to `-strategy`:
64+
65+
```bash
66+
chaosmonkey -list-strategies
67+
```
5168

52-
Run `chaosmonkey -h` for a list of all available options.
69+
As always, invoke `chaosmonkey -h` for a list of all available options.
5370

5471
## Use with Docker
5572

0 commit comments

Comments
 (0)