Skip to content

Commit

Permalink
Add install instructions for CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
christophetd authored Nov 21, 2022
1 parent 59fc743 commit 0ea8cb2
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![unit tests](https://github.com/DataDog/threatest/actions/workflows/test.yml/badge.svg)
![static analysis](https://github.com/DataDog/threatest/actions/workflows/static-analysis.yml/badge.svg)

Threatest is a Go framework for testing threat detection end-to-end.
Threatest is a CLI and Go framework for testing threat detection end-to-end.

Threatest allows you to **detonate** an attack technique, and verify that the alert you expect was generated in your favorite security platform.

Expand Down Expand Up @@ -40,6 +40,13 @@ The way this is done depends on the detonator; for instance, Stratus Red Team an

Threatest comes with a CLI that you can use to run test scenarios described as YAML, following a specific [schema](./schemas/threatest.schema.json). You can configure this schema in your editor to benefit from in-IDE linting and autocompletion (see [documentation for VSCode](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml#associating-a-schema-to-a-glob-pattern-via-yaml.schemas) using the [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension).

Install the CLI by downloading a [binary release](https://github.com/DataDog/threatest/releases) or with Homebrew:

```
brew tap datadog/threatest https://github.com/datadog/threatest
brew install datadog/threatest/threatest
```

Sample usage:

```bash
Expand Down

0 comments on commit 0ea8cb2

Please sign in to comment.