hidden
A Help
instance that shows an argument only in the extended help display.
static var hidden: ArgumentHelp { get }
A Help
instance that shows an argument only in the extended help display.
static var hidden: ArgumentHelp { get }
import ArgumentParser
Straightforward, type-safe argument parsing for Swift.
struct ArgumentHelp
Help information for a command-line argument.
init(_ abstract: String = "", discussion: String? = nil, valueName: String? = nil, visibility: ArgumentVisibility = .default, argumentType: (any ExpressibleByArgument.Type)? = nil)
Creates a new help instance.
init(stringLiteral value: String)
static var `private`: ArgumentHelp { get }
A Help
instance that hides an argument from the extended help display.
var abstract: String
A short description of the argument.
var argumentType: (any ExpressibleByArgument.Type)?
A property of meta type any ExpressibleByArgument.Type
that serves to retain information about any arguments that have enumerable values and their descriptions.
var discussion: String?
An expanded description of the argument, in plain text form.
var valueName: String?
An alternative name to use for the argument’s value when showing usage information.
var visibility: ArgumentVisibility
A visibility level indicating whether this argument should be shown in the extended help display.
init(_ abstract: String = "", discussion: String? = nil, valueName: String? = nil, shouldDisplay: Bool)
Creates a new help instance.
var shouldDisplay: Bool { get set }
A Boolean value indicating whether this argument should be shown in the extended help display.