Skip to content

Docs core dispatcher v2Docs: Add technical YARD documentation for Core command dispatcher #21283

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.

Sign up for GitHub

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

Closed
Ganesh-abc wants to merge 2 commits into from
Closed

Docs core dispatcher v2Docs: Add technical YARD documentation for Core command dispatcher #21283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9dd1ade
docs(core): add YARD documentation for help-related commands
Ganesh-abc Apr 3, 2026
04e7878
docs(core): add technical YARD tags for core dispatcher methods
Ganesh-abc Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions lib/msf/ui/console/command_dispatcher/core.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,10 @@ def name
"Core"
end


#
# Displays help for the color command.
#
# @return [void]
def cmd_color_help
print_line "Usage: color <'true'|'false'|'auto'>"
print_line
Expand All @@ -225,13 +228,14 @@ def cmd_color(*args)
#
# @param str [String] the string currently being typed before tab was hit
# @param words [Array<String>] the previously completed words on the command line. words is always
# at least 1 when tab completion has reached this stage since the command itself has been completed
#
# @return [Array<String>] List of possible completions (auto, true, false).
def cmd_color_tabs(str, words)
return [] if words.length > 1
%w[auto true false]
end

#
# Displays help for the cd command.
#
def cmd_cd_help
print_line "Usage: cd <directory>"
print_line
Expand All @@ -242,6 +246,8 @@ def cmd_cd_help
#
# Change the current working directory
#
# @param args [Array<String>] The directory path to change to.
# @return [void]
def cmd_cd(*args)
if(args.length == 0)
print_error("No path specified")
Expand Down Expand Up @@ -313,7 +319,9 @@ def cmd_tips_tabs(str, words)

[]
end

#
# Displays useful Metasploit tips and tricks.
#
def cmd_tips_help
print_line "Usage: tips [options]"
print_line
Expand Down
Loading