Skip to content

DeepTeam is a framework to red team LLMs and AI agents.

updated docs for deepteam run command

A-Vamshie2b191799610
diff --git a/README.md b/README.md
index 1a3ebce4..9dd4cbd9 100644
--- a/README.md
+++ b/README.md
@@ -163,10 +163,10 @@ Use the CLI to run red teaming with YAML configs:
```bash
# Basic usage
-deepteam config.yaml
+deepteam run config.yaml
# With options
-deepteam config.yaml -c 20 -a 5 -o results
+deepteam run config.yaml -c 20 -a 5 -o results
```
**Options:**
@@ -246,7 +246,7 @@ The `-c` and `-a` and `-o` CLI options override YAML config values:
```bash
# Override max_concurrent, attacks_per_vuln, and output_folder from CLI
-deepteam config.yaml -c 20 -a 5 -o results
+deepteam run config.yaml -c 20 -a 5 -o results
```
**Target Configuration Options:**
diff --git a/docs/docs/red-teaming-yaml-cli.mdx b/docs/docs/red-teaming-yaml-cli.mdx
index 7301c814..afc999bc 100644
--- a/docs/docs/red-teaming-yaml-cli.mdx
+++ b/docs/docs/red-teaming-yaml-cli.mdx
@@ -56,7 +56,7 @@ attacks:
Then run the red teaming with a single command:
```bash
-deepteam config.yaml
+deepteam run config.yaml
```
:::tip DID YOU KNOW?
@@ -414,7 +414,7 @@ Once you have your YAML configuration file, you can start red teaming with the C
### Basic Usage
```bash
-deepteam config.yaml
+deepteam run config.yaml
```
### Command Line Overrides
@@ -423,13 +423,13 @@ You can override specific configuration values using command line flags:
```bash
# Override concurrency and output folder
-deepteam config.yaml -c 20 -o custom-results
+deepteam run config.yaml -c 20 -o custom-results
# Override attacks per vulnerability
-deepteam config.yaml -a 5
+deepteam run config.yaml -a 5
# Combine multiple overrides
-deepteam config.yaml -c 15 -a 3 -o production-results
+deepteam run config.yaml -c 15 -a 3 -o production-results
```
There are **THREE** optional command line flags: