ArgumentHelp
Help information for a command-line argument.
struct ArgumentHelp
Help information for a command-line argument.
struct ArgumentHelp
import ArgumentParser
Straightforward, type-safe argument parsing for Swift.
Support your users (and yourself) by providing rich help for arguments, options, and flags.
struct ArgumentVisibility
Visibility level of an argument’s help.
struct NameSpecification
A specification for how to represent a property as a command-line argument label.
protocol ExpressibleByExtendedGraphemeClusterLiteral : ExpressibleByUnicodeScalarLiteral
A type that can be initialized with a string literal containing a single extended grapheme cluster.
protocol ExpressibleByStringInterpolation : ExpressibleByStringLiteral
A type that can be initialized by string interpolation with a string literal that includes expressions.
protocol ExpressibleByStringLiteral : ExpressibleByExtendedGraphemeClusterLiteral
A type that can be initialized with a string literal.
protocol ExpressibleByUnicodeScalarLiteral
A type that can be initialized with a string literal containing a single Unicode scalar value.
protocol Sendable
A type whose values can safely be passed across concurrency domains by copying.
init(_ abstract: String = "", discussion: String = "", valueName: String? = nil, visibility: ArgumentVisibility = .default)
Creates a new help instance.
init(stringLiteral value: String)
static var hidden: ArgumentHelp { get }
A Help
instance that shows an argument only in the extended help display.
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 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 = "", 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.
init(extendedGraphemeClusterLiteral value: Self.StringLiteralType)
init(stringInterpolation: DefaultStringInterpolation)
Creates a new instance from an interpolated string literal.
init(unicodeScalarLiteral value: Self.ExtendedGraphemeClusterLiteralType)