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 = Noir::CLI::Catalog::NAMES

Commands recognised by noir help <cmd>. The same verbs the router dispatches — .route_for below maps each to its help printer, and a catalog entry with no branch there is a compile error rather than a verb that quietly has no help page.

Class Method Summary

Class Method Detail

def self.print_top_level(io : IO = STDOUT, banner_io : IO = STDERR) #

[View source]
def self.route_for(argv : Array(String)) : Route #

[View source]
def self.run(argv : Array(String)) #

[View source]