redcanaryco / surveyor

A cross-platform baselining, threat hunting, and attack surface analysis tool for security teams.
MIT License
166 stars 62 forks source link

[FR] Enable Surveyor Usage from Command Line and Common Development Environments (e.g., Jupyter Notebooks) #127

Open TreWilkinsRC opened 12 months ago

TreWilkinsRC commented 12 months ago

Which category is the feature part of?

Which product is the feature part of?

Use Cases

Enabling Surveyor usage from both the command line and environments such as Jupyter notebooks with in-script arguments offers greater flexibility and convenience. Benefits include seamless integration into existing workflows, automated analysis, customizable assessments, easier collaboration, streamlined workflow, and increased adoption.

This enhancement enhances Surveyor's versatility, empowering users to perform efficient security assessments and promote collaborative, automated analysis workflows.

Proposal

Refactor Surveyor by introducing a class-based structure and replacing the click library with argparse. The goal is to enhance organization and streamline user argument handling. The CLI functionality will be maintained, with arguments passed seamlessly to the new Surveyor class for processing.