Function main

knockpy/cli.py:124–602

CLI entrypoint. This function is responsible for argument parsing, config layering (CLI > saved setup > built-in defaults), mode dispatch and result handling.

()

def main() -> None:
    """CLI entrypoint.

    This function is responsible for argument parsing, config layering
    (CLI > saved setup > built-in defaults), mode dispatch and result handling.
    """
    stdin_domain_sentinel = "__stdin_domain__"
    parser = argparse.ArgumentParser(
        prog="KNOCKPY",
        description=(
            f"knockpy v.{__version__} - Subdomain discovery and security checks\n"
            "CLI options > saved setup (--setup) > built-in defaults.\n"
            "https://github.com/guelfoweb/knockpy"
        ),
    )
    target_group = parser.add_argument_group("Target")
    target_group.add_argument(
        "-d",
        "--domain",
        nargs="?",
        const=stdin_domain_sentinel,
        help="Domain to analyze. If used without value, reads from stdin.",
    )
    target_group.add_argument("-f", "--file", help="File with domains, one per line.")

    mode_group = parser.add_argument_group("Scan Modes")
    mode_group.add_argument("--recon", help="Enable reconnaissance.", action="store_true")
    mode_group.add_argument("--bruteforce", "--brute", help="Enable bruteforce.", action="store_true")
    mode_group.add_argument("--wildcard", help="Test wildcard and exit.", action="store_true")
    mode_group.add_argument(
        "--exclude",
        nargs=2,
        action="append",
        metavar=("TYPE", "VALUE"),
        help="Exclude matches. TYPE=status, length/lenght (e.g. 275), or body. Repeatable.",
    )
    mode_group.add_argument(
        "--verbose",
        help="Verbose checks for single-domain scan only (without --recon/--bruteforce).",
        action="store_true",
    )
    mode_group.add_argument(
        "--test",
        help="With --recon, test each recon service and show which fails or returns data.",
        action="store_true",
    )

    setup_group = parser.add_argument_group("Setup and Reports")
    setup_group.add_argument(
        "--setup",
        help="Interactive setup: save runtime defaults and API keys in the local DB.",
        action="store_true",
    )
    setup_group.add_argument(
        "--report",
        nargs="?",
        const="choose",
        help="Report mode. In interactive terminals it opens the menu (show/delete/export/search/findings).",