module Noir::CLI::HelpCommand

Overview

noir help [command]

noir help (no args) prints the top-level overview. This is also what noir with no arguments and noir -h resolve to. noir help scan (etc.) defers to the matching command's help.

Defined in:

cli/commands/help.cr

Constant Summary

KNOWN_HELP_TARGETS = ["scan", "list", "cache", "config", "rules", "completion", "version", "help"] of ::String

Commands recognised by noir help <cmd>. Kept here (rather than via KNOWN_COMMANDS) because each entry maps to a specific help printer, and adding a new subcommand needs a deliberate edit to both routes.

Class Method Summary

• .print_top_level(io : IO = STDOUT, banner_io : IO = STDERR)
• .route_for(argv : Array(String)) : Route
• .run(argv : Array(String))

Class Method Detail