Protocols

Protocol that defines the help generation logic. This protocol has an extension that implements all the methods required. You can choose to override helpMessage to completely costumize the help message to print. Alternatively, override one of the sections only to alter that section.

When the help is about to be printed, a CommandHelp is generated from the current Command. a HelpGenerator is created and passed this CommandHelp. the HelpGenerator is used to print the help message string

---

The help has this format

Usage:
  command [flags]
  command [command]

Aliases:
  alias1, alias2

Examples:
  the command usage example

Available Commands:
  sub_command1  subcommand description
  sub_command2  subcommand description

Flags:
  -f, --flag         flag1 description
      --user string  flag2 description

Use "command [command] --help" for more information about a command.

See more

public protocol HelpGenerator

Protocol that defines the needs to be implemented for a type to be used as a flag value

---

Example

Flag with User type

struct User: FlagValue {
  let name: String

  static func fromString(flagValue value: String) throws -> User {
    return User(name: value)
  }

  static var typeDescription: String {
    return "A user structure"
  }
}

We can then use user to define flag type:

let flag = try! Flag(longName: "debug", type: User.self)

See more

public protocol FlagValue