cisagov / gophish-tools

Helpful tools for interacting with a GoPhish phishing instance
Creative Commons Zero v1.0 Universal
42 stars 6 forks source link

Clean the structure of `gophish-complete` #2

Closed bjb28 closed 4 years ago

bjb28 commented 4 years ago

🚀 Feature Proposal

Improve the clarity of the gophish-complete tool by modifying the options --auto and --complete into a single option with an optional CAMPAIGN_ID. The difference between these flags is minimal and can be combined.

Motivation

This will make it easier to understand the function of the commands and simplify the code.

Example

Get rid of the --auto option Support an optional CAMPAIGN_ID for both --complete and --summary So the docopt line would look something like:

gophish-complete (--complete [CAMPAIGN_ID] | --summary [CAMPAIGN_ID]) [--log-level=LEVEL] SERVER API_KEY

Pitch

This is based on a suggestion/feedback from @dav3r