Skip to content

Configuration documentation recommends a CLI executable that is not installed #3707

Closed

Description

@romanlutz

Describe the issue linked to the documentation

The configuration guide instructs users to run pyrit list initializers, but the installed package exposes pyrit_backend, pyrit_scan, and pyrit_shell, not a pyrit executable.

Reproduction: install the locked package and follow the documented command. It exits 127 because pyrit is absent; pyrit_scan list-initializers succeeds.

Suggest a potential alternative/fix

Replace it with pyrit_scan list-initializers, then check other documented pyrit invocations against the actual entry points. Verified entry points: pyproject.toml.

Tested commit d3446e0, PyRIT 1.2.0.dev0, offline install scope. Recovery evidence: files/evidence/round1/doc-cli-command.txt and list-initializers.txt; these local paths are not attachments.

Activity

  1. nabeleon94 commented on Nov 1, 2026

    @nabeleon94
    Contributor

    Opened #3791 for this: it switches the guide to pyrit_scan list-initializers, and also updates a couple of spots in the scanner notebook and the --target/--techniques help text that still pointed at the deprecated --list-* flags.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

help wantedExtra attention is needed

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions