Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/getting_started/pyrit_conf.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ initializers:
- scorer
```

Use `pyrit list initializers` in the CLI to see all registered initializers. See the [initializer documentation notebook](../code/setup/pyrit_initializer.ipynb) for reference.
Run `pyrit_scan list-initializers` (or `list-initializers` inside `pyrit_shell`) to see all registered initializers. See the [initializer documentation notebook](../code/setup/pyrit_initializer.ipynb) for reference.

#### Recommended Defaults

Expand Down
6 changes: 3 additions & 3 deletions doc/scanner/1_pyrit_scan.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -933,9 +933,9 @@
"\n",
"PyRITInitializers are how you can configure the CLI scanner. PyRIT includes several built-in initializers you can use with the `--initializers` flag.\n",
"\n",
"The `--list-initializers` command shows all available initializers. Initializers are referenced by their filename (e.g., `target`, `scorer`) regardless of which subdirectory they're in.\n",
"The `list-initializers` command shows all available initializers. Initializers are referenced by their filename (e.g., `target`, `scorer`) regardless of which subdirectory they're in.\n",
"\n",
"List the available initializers using the --list-initializers flag."
"List the available initializers using the `list-initializers` command."
]
},
{
Expand Down Expand Up @@ -1031,7 +1031,7 @@
"\n",
"1. A Scenario. Many are defined in `pyrit.scenario.scenarios`. But you can also define your own in initialization_scripts.\n",
"2. Initializers (which can be supplied via the `--initializers` flag on `run`, or the `initializers` / `initialization_scripts` sections of a config file (see [here](../getting_started/pyrit_conf.md))). Scenarios often don't need many arguments, but they can be configured in different ways. And at the very least, most need an `objective_target` (the thing you're running a scan against) which you can configure by using the `--target` flag if your initializer registers targets (e.g. `target` initializer)\n",
"3. Scenario Techniques (optional). These are supplied by the `--techniques` flag and tell the scenario what to test, but they are always optional. Also note you can obtain these by running `--list-scenarios`\n",
"3. Scenario Techniques (optional). These are supplied by the `--techniques` flag and tell the scenario what to test, but they are always optional. Also note you can obtain these by running `list-scenarios`\n",
"\n",
"Basic usage will look something like:\n",
"\n",
Expand Down
6 changes: 3 additions & 3 deletions doc/scanner/1_pyrit_scan.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@
#
# PyRITInitializers are how you can configure the CLI scanner. PyRIT includes several built-in initializers you can use with the `--initializers` flag.
#
# The `--list-initializers` command shows all available initializers. Initializers are referenced by their filename (e.g., `target`, `scorer`) regardless of which subdirectory they're in.
# The `list-initializers` command shows all available initializers. Initializers are referenced by their filename (e.g., `target`, `scorer`) regardless of which subdirectory they're in.
#
# List the available initializers using the --list-initializers flag.
# List the available initializers using the `list-initializers` command.

# %%
# !pyrit_scan list-initializers
Expand All @@ -86,7 +86,7 @@
#
# 1. A Scenario. Many are defined in `pyrit.scenario.scenarios`. But you can also define your own in initialization_scripts.
# 2. Initializers (which can be supplied via the `--initializers` flag on `run`, or the `initializers` / `initialization_scripts` sections of a config file (see [here](../getting_started/pyrit_conf.md))). Scenarios often don't need many arguments, but they can be configured in different ways. And at the very least, most need an `objective_target` (the thing you're running a scan against) which you can configure by using the `--target` flag if your initializer registers targets (e.g. `target` initializer)
# 3. Scenario Techniques (optional). These are supplied by the `--techniques` flag and tell the scenario what to test, but they are always optional. Also note you can obtain these by running `--list-scenarios`
# 3. Scenario Techniques (optional). These are supplied by the `--techniques` flag and tell the scenario what to test, but they are always optional. Also note you can obtain these by running `list-scenarios`
#
# Basic usage will look something like:
#
Expand Down
4 changes: 2 additions & 2 deletions pyrit/cli/_cli_args.py
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ def _coerce_filter_values(value: str) -> list[str]:
"scenario_techniques": "List of technique names to run (e.g., base64 rot13). Append one or more "
"registered converters to a technique with ':converter.<name>' (repeatable), e.g. "
"role_play_movie_script:converter.translation_spanish:converter.leetspeak. The converter is appended on top of "
"the technique's built-in converters. Use --list-converters to see registered converter names",
"the technique's built-in converters. Use the list-converters command to see registered converter names",
"max_concurrency": "Maximum number of concurrent attack executions (must be >= 1)",
"max_retries": "Maximum number of automatic retries on exception (must be >= 0)",
"memory_labels": 'Additional labels as JSON string (e.g., \'{"experiment": "test1"}\')',
Expand All @@ -529,7 +529,7 @@ def _coerce_filter_values(value: str) -> list[str]:
+ ".",
"target": "Name of a registered target from the TargetRegistry to use as the objective target. "
"Targets are registered by initializers (e.g., 'target' initializer). "
"Use --list-targets to see available target names after initializers have run",
"Use the list-targets command to see available target names after initializers have run",
}


Expand Down
Loading