Repository navigation
DOC: replace nonexistent pyrit CLI command and deprecated --list-* flags with pyrit_scan subcommands - #3791
Open
nabeleon94 wants to merge 1 commit into
Open
DOC: replace nonexistent pyrit CLI command and deprecated --list-* flags with pyrit_scan subcommands#3791nabeleon94 wants to merge 1 commit into
nabeleon94 wants to merge 1 commit into
Conversation
…ags with pyrit_scan subcommands
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #3707.
The configuration guide tells users to run
pyrit list initializers, but the package only installspyrit_backend,pyrit_scanandpyrit_shell(see[project.scripts]inpyproject.toml), so the command fails with exit code 127.While checking the other documented CLI invocations as the issue suggests, I found a few places that still point users at the flag-style
--list-*commands. Those are now a deprecated back-compat shim (_LEGACY_COMMAND_FLAGSinpyrit/cli/pyrit_scan.py, slated for removal in 1.3.0) and print a deprecation note when used:doc/getting_started/pyrit_conf.md:pyrit list initializersbecomespyrit_scan list-initializers(orlist-initializersinsidepyrit_shell).doc/scanner/1_pyrit_scan.py/.ipynb: the prose around the initializers cell and the techniques note now saylist-initializers/list-scenariosinstead of--list-initializers/--list-scenarios(the code cell already usedpyrit_scan list-initializers). Both paired files have the same edit; no outputs changed.pyrit/cli/_cli_args.py: the--techniquesand--targethelp text said "Use --list-converters/--list-targets"; it now says "Use the list-converters/list-targets command", which reads correctly for bothpyrit_scanandpyrit_shell.No other
pyrit <verb>invocations turned up indoc/orREADME.md.Tests and Documentation
pyrit list initializersin the project venv: exit 127 (no such executable).pyrit_scan list-initializers --helpparses fine;pyrit_scan --list-initializersprints the deprecation note.pyrit_scan run --helpshows the updated--target/--techniqueshelp text.tests/unit/cli: 668 passed, 1 skipped.ruff checkandruff format --checkclean on the touched Python files; the.ipynbstill loads as valid JSON.