abstract class Cling::Command

• Cling::Command
• Reference
• Object

Direct Known Subclasses

• Cling::MainCommand

Defined in:

cling/command.cr

Constructors

• .new(*, aliases : Set(String) | Nil = nil, usage : Array(String) | Nil = nil, header : String | Nil = nil, summary : String | Nil = nil, description : String | Nil = nil, footer : String | Nil = nil, parent : Command | Nil = nil, children : Array(Command) | Nil = nil, arguments : Hash(String, Argument) | Nil = nil, options : Hash(String, Option) | Nil = nil, hidden : Bool = false, inherit_borders : Bool = false, inherit_options : Bool = false, inherit_streams : Bool = false, stdin : IO = STDIN, stdout : IO = STDOUT, stderr : IO = STDERR)

Instance Method Summary

• #add_alias(name : String) : Nil

  Adds an alias to the command.

• #add_aliases(*names : String) : Nil

  Adds several aliases to the command.

• #add_argument(name : String, *, description : String | Nil = nil, required : Bool = false, multiple : Bool = false) : Nil

  Adds an argument to the command.

• #add_command(command : Command) : Nil

  Adds a command as a subcommand to the parent.

• #add_commands(*commands : Command) : Nil

  Adds several commands as subcommands to the parent (see #add_command).

• #add_option(short : Char, long : String, *, description : String | Nil = nil, required : Bool = false, type : Option::Type = :none, default : Value::Type = nil) : Nil

  Adds a short flag option to the command.

• #add_option(long : String, *, description : String | Nil = nil, required : Bool = false, type : Option::Type = :none, default : Value::Type = nil) : Nil

  Adds a long flag option to the command.

• #add_usage(usage : String) : Nil

  Adds a usage string to the command.

• #aliases : Set(String)

  A set of aliases for the command.

• #arguments : Hash(String, Argument)

  A hash of arguments belonging to the command.

• #children : Hash(String, Command)

  A hash of commands that belong and inherit from the parent command.

• #description : String | Nil

  The description of the command to show for specific help with the command.

• #description=(description : String | Nil)

  The description of the command to show for specific help with the command.

• #execute(input : String | Array(String), *, parser : Parser | Nil = nil) : Nil

  Executes the command with the given input and parser (see Parser).

• #footer : String | Nil

  A footer message to display at the bottom of generated help templates.

• #footer=(footer : String | Nil)

  A footer message to display at the bottom of generated help templates.

• #header : String | Nil

  A header message to display at the top of generated help templates.

• #header=(header : String | Nil)

  A header message to display at the top of generated help templates.

• #help_template : String

  Returns the help template for this command.

• #hidden=(hidden : Bool)

  Whether the command should be hidden from generated help templates.

• #hidden? : Bool

  Whether the command should be hidden from generated help templates.

• #inherit_borders=(inherit_borders : Bool)

  Whether the command should inherit the #header and #footer strings from the parent command.

• #inherit_borders? : Bool

  Whether the command should inherit the #header and #footer strings from the parent command.

• #inherit_options=(inherit_options : Bool)

  Whether the command should inherit the options from the parent command.

• #inherit_options? : Bool

  Whether the command should inherit the options from the parent command.

• #inherit_streams=(inherit_streams : Bool)

  Whether the command should inherit the IO streams from the parent command.

• #inherit_streams? : Bool

  Whether the command should inherit the IO streams from the parent command.

• #is?(name : String) : Bool

  Returns true if the argument matches the command name or any aliases.

• #name : String

  The name of the command.

• #name=(name : String)
• #on_error(ex : Exception)

  A hook method for when the command raises an exception during execution.

• #on_missing_arguments(arguments : Array(String))

  A hook method for when the command receives missing arguments during execution.

• #on_missing_options(options : Array(String))

  A hook method for when the command receives missing options that are required during execution.

• #on_unknown_arguments(arguments : Array(String))

  A hook method for when the command receives unknown arguments during execution.

• #on_unknown_options(options : Array(String))

  A hook method for when the command receives unknown options during execution.

• #options : Hash(String, Option)

  A hash of flag options belonging to the command.

• #parent : Command | Nil

  The parent of the command of which the current command inherits from.

• #parent=(parent : Command | Nil)

  The parent of the command of which the current command inherits from.

• #post_run(arguments : Arguments, options : Options) : Nil

  A hook method to run once the #pre_run and main #run methods have been executed.

• #pre_run(arguments : Arguments, options : Options) : Bool | Nil

  A hook method to run once the command/subcommands, arguments and options have been parsed.

• #run(arguments : Arguments, options : Options) : Nil

  The main point of execution for the command, where arguments and options can be accessed.

• #setup : Nil

  An abstract method that should define information about the command such as the name, aliases, arguments, options, etc.

• #stderr : IO

  The standard error stream for commands (defaults to STDERR).

• #stderr=(stderr : IO)

  The standard error stream for commands (defaults to STDERR).

• #stdin : IO

  The standard input stream for commands (defaults to STDIN).

• #stdin=(stdin : IO)

  The standard input stream for commands (defaults to STDIN).

• #stdout : IO

  The standard output stream for commands (defaults to STDOUT).

• #stdout=(stdout : IO)

  The standard output stream for commands (defaults to STDOUT).

• #summary : String | Nil

  The summary of the command to show in generated help templates.

• #summary=(summary : String | Nil)

  The summary of the command to show in generated help templates.

• #usage : Array(String)

  An array of usage strings to display in generated help templates.

Constructor Detail

Instance Method Detail