class Jargon::CLI

• Jargon::CLI
• Reference
• Object

Defined in:

jargon/cli.cr
jargon/config.cr
jargon/help.cr

Constructors

• .from_file(path : String, program_name : String = "cli") : CLI

  Create a CLI from a JSON or YAML schema file.

• .from_json(json : String, program_name : String = "cli") : CLI

  Create a CLI from a JSON schema string.

• .from_yaml(yaml : String, program_name : String = "cli") : CLI

  Create a CLI from a YAML schema string.

• .new(schema : Schema, program_name : String = "cli")
• .new(program_name : String)

Instance Method Summary

• #bash_completion : String
• #config_paths : Array(String)

  Returns the list of config paths that would be searched

• #default_subcommand(name : String)
• #default_subcommand : String | Nil
• #fish_completion : String
• #help(subcommand : String) : String
• #help : String
• #json(args : Array(String), input : IO, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil) : JSON::Any
• #json(args : Array(String) = ARGV, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil) : JSON::Any

  Return just the parsed data as JSON.

• #load_config(*, merge : Bool = true) : JSON::Any | Nil

  Load config from standard locations.

• #output : IO
• #output=(output : IO)
• #parse(args : Array(String), input : IO, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil) : Result
• #parse(args : Array(String) = ARGV, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil) : Result

  Parse arguments and return full Result with errors array.

• #program_name : String
• #run(args : Array(String), input : IO, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil) : Result
• #run(args : Array(String) = ARGV, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil) : Result

  Run the CLI with automatic --help, --completions, and error handling.

• #run(args : Array(String), input : IO, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil, &) : Nil
• #run(args : Array(String) = ARGV, *, defaults : JSON::Any | Hash(String, JSON::Any) | Nil = nil, &) : Nil
• #schema : Schema | Nil
• #subcommand(name : String, schema : Schema)
• #subcommand(name : String, cli : CLI)
• #subcommand(name : String, *, json : String)
• #subcommand(name : String, *, yaml : String)
• #subcommand(name : String, *, file : String)

  Load subcommand(s) from a file.

• #subcommand(*, file : String)

  Load subcommands from a multi-document file (no parent name).

• #subcommand_key(key : String)
• #subcommand_key : String
• #subcommands : Hash(String, Schema | CLI)
• #validate(data : Hash(String, JSON::Any), subcommand : String | Nil = nil) : Array(String)

  Validate data against a schema, returning any errors.

• #validate(result : Result) : Array(String)
• #zsh_completion : String

Constructor Detail

Instance Method Detail