abstract class Cmds::Cmd

• Cmds::Cmd
• Reference
• Object

Included Modules

• Cmds::Getopt

Defined in:

cmds/cmd.cr

Constant Summary

ARGS_HINTS = Hash(String, String | ::Nil).new

NAME = "(name not found)"

Class Method Summary

• .cmd_name
• .desc(task : String, text : String)
• .descs : Hash(String, Array(Desc))
• .pretty_usage(prefix : String = "", delimiter : String = " ")

  should be overriden in inherited macro

• .run(args : Array(String))
• .task_names : Array(String)
• .usage(text : String)
• .usages : Array(Usage)

Instance Method Summary

• #args : Array(String)
• #args=(v : Array(String)) : Array(String)
• #args=(v : Nil)

  nil assignments are always ignored

• #args? : Array(String) | Nil
• #error : Exception
• #error=(v : Exception) : Exception
• #error=(v : Nil)

  nil assignments are always ignored

• #error? : Exception | Nil
• #original_args : Array(String)
• #original_args=(v : Array(String)) : Array(String)
• #original_args=(v : Nil)

  nil assignments are always ignored

• #original_args? : Array(String) | Nil
• #prog_name : String
• #prog_name=(v : String) : String
• #prog_name=(v : Nil)

  nil assignments are always ignored

• #prog_name? : String | Nil
• #read_arg_idx : Int32
• #read_arg_idx=(v : Int32) : Int32
• #read_arg_idx=(v : Nil)

  nil assignments are always ignored

• #read_arg_idx? : Int32 | Nil
• #task_name
• #task_name=(v : String) : String
• #task_name=(v : Nil)

  nil assignments are always ignored

• #task_name? : String | Nil
• #task_state : Cmds::State
• #task_state=(v : Nil)

  nil assignments are always ignored

• #task_state=(v : Cmds::State) : Cmds::State
• #task_state? : Cmds::State | Nil

Macro Summary

• task(name, args_hint = nil)

Class Method Detail

Instance Method Detail

Macro Detail