Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
DeezyE opened this issue Sep 29, 2021 · 2 comments
Open

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

DeezyE opened this issue Sep 29, 2021 · 2 comments

Comments

@DeezyE
Copy link
Collaborator

DeezyE commented Sep 29, 2021

New flag options are not clearly communicated.

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

def self.parse
return @options if @already_parsed
begin
optparse = OptionParser.new do |opts|
opts.on('-x', '--reset', 'Reset the database') do
@options[:resetdb] = true
end
opts.on('-v', '--verbose', 'Display debug information') do
@options[:verbose] = true
end
opts.on('-a', '--ascii_art', 'Prints BeEF ascii art') do
@options[:ascii_art] = true
end
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
opts.on('-p', '--port PORT', 'Change the default BeEF listening port') do |p|
@options[:port] = p
end
opts.on('-w', '--wsport WS_PORT', 'Change the default BeEF WebSocket listening port') do |ws_port|
@options[:ws_port] = ws_port
end
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

@bcoles
Copy link
Collaborator

bcoles commented Jan 24, 2022

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
Copy link
Collaborator Author

DeezyE commented Jan 24, 2022

> 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

@DeezyE DeezyE removed their assignment Jan 25, 2022
This was referenced Mar 8, 2023
@nzqo nzqo mentioned this issue May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants