📝 Add README to producer/semgrep

smithy-security · Jul 8, 2024 · 04b4e89 · 04b4e89
1 parent 53d6708
commit 04b4e89
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/components/producers/semgrep/README.md b/components/producers/semgrep/README.md
@@ -0,0 +1,12 @@
+# Producer: Semgrep
+
+This producer runs [the Semgrep CLI](https://semgrep.dev/docs/cli-reference) to produce SAST findings.
+
+## Parameters
+
+All parameters are optional. The producer works with the default configuration and uses the `"auto"` ruleset.
+
+| Name                            | Type     | Default       | Description                                                                            |
+| ------------------------------- | -------- | ------------- | -------------------------------------------------------------------------------------- |
+| `producer-semgrep-config-value` | `string` | `"auto"`      | The config for the Semgrep producer. Passed directly to the CLI via `--config`         |
+| `producer-semgrep-rules-yaml`   | `string` | `"rules: []"` | Additional rules passed to Semgrep https://semgrep.dev/docs/writing-rules/rule-syntax. |