beefproject / beef

The Browser Exploitation Framework Project
https://beefproject.com
9.88k stars 2.18k forks source link

Update ./beef launch flags in wiki and --help menu #2174

Open DeezyE opened 3 years ago

DeezyE commented 3 years ago

New flag options are not clearly communicated.

Wiki: https://github.com/beefproject/beef/wiki/Configuration and -- help menu when running ./beef --help

https://github.com/beefproject/beef/blob/1ae320c3bc9db748dff7e53fe919cdef80089062/core/main/console/commandline.rb#L31-L67

bcoles commented 2 years ago

While you're at it...

Only heathens use underscores in command line arguments.

            opts.on('-ud', '--update_disabled', 'Skips update') do
              @options[:update_disabled] = true
            end

            opts.on('-ua', '--update_auto', 'Automatic update with no prompt') do
              @options[:update_auto] = true
            end

This command line help is more confusing than it is helpful:

            opts.on('-c', '--config FILE', "Load a different configuration file: if it's called custom-config.yaml, git automatically ignores it.") do |f|
              @options[:ext_config] = f
            end
DeezyE commented 2 years ago
> Only heathens use underscores in command line arguments.

Ha, this is poetry :) and I am pretty sure I am to blame. Are we good with dashes for multi-word arguments if no suitable single word will suffice?

And yes agreed on the -c flag description