From 421d146a9662bf459f06ff24ef495a5dff16421a Mon Sep 17 00:00:00 2001 From: jsong468 Date: Thu, 19 Mar 2026 16:52:10 -0700 Subject: [PATCH] small edits to CLI docs and objective target initializer --- .pyrit_conf_example | 4 ++-- doc/setup/pyrit_conf.md | 2 +- pyrit/cli/pyrit_scan.py | 2 +- pyrit/setup/initializers/scenarios/openai_objective_target.py | 1 - 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.pyrit_conf_example b/.pyrit_conf_example index 8bc95546eb..1d800ead86 100644 --- a/.pyrit_conf_example +++ b/.pyrit_conf_example @@ -45,8 +45,8 @@ memory_db_type: sqlite # - scorer initializers: - name: simple - - name: scorer - - name: target + - name: scorers + - name: targets args: tags: - default diff --git a/doc/setup/pyrit_conf.md b/doc/setup/pyrit_conf.md index c464ce5e6c..995b0c31ef 100644 --- a/doc/setup/pyrit_conf.md +++ b/doc/setup/pyrit_conf.md @@ -132,7 +132,7 @@ Because initializers run last, they can modify anything set up in earlier steps The CLI and shell automatically load `~/.pyrit/.pyrit_conf`. You can also point to a different config file: ```bash -pyrit scan run --config-file ./my_project_config.yaml --database InMemory +pyrit_scan run --config-file ./my_project_config.yaml --database InMemory ``` Individual CLI arguments (like `--database`) override values from the config file. diff --git a/pyrit/cli/pyrit_scan.py b/pyrit/cli/pyrit_scan.py index c4dcb971da..e85fa56e4f 100644 --- a/pyrit/cli/pyrit_scan.py +++ b/pyrit/cli/pyrit_scan.py @@ -43,7 +43,7 @@ def parse_args(args: Optional[list[str]] = None) -> Namespace: pyrit_scan garak.encoding --initialization-scripts ./my_config.py # Run specific strategies or options - pyrit scan foundry --strategies base64 rot13 --initializers openai_objective_target + pyrit_scan foundry --strategies base64 rot13 --initializers openai_objective_target pyrit_scan foundry --initializers openai_objective_target --max-concurrency 10 --max-retries 3 pyrit_scan garak.encoding --initializers openai_objective_target --memory-labels '{"run_id":"test123"}' """, diff --git a/pyrit/setup/initializers/scenarios/openai_objective_target.py b/pyrit/setup/initializers/scenarios/openai_objective_target.py index 6fc6ae4315..d27fc60c08 100644 --- a/pyrit/setup/initializers/scenarios/openai_objective_target.py +++ b/pyrit/setup/initializers/scenarios/openai_objective_target.py @@ -45,7 +45,6 @@ def required_env_vars(self) -> list[str]: """Get list of required environment variables.""" return [ "DEFAULT_OPENAI_FRONTEND_ENDPOINT", - "DEFAULT_OPENAI_FRONTEND_KEY", ] async def initialize_async(self) -> None: