Reference Classes Reference

Classes

The following classes are available globally.

CommandFlag
A flag is an argument, which when present, represents true. A flag that is not present, represents false.

Example: -v or --verbose
See more
Declaration
Swift

@propertyWrapper public class CommandFlag : CommandFlagSpecification

CommandOptionalInput
An input argument is an argument that represents a file or similar. If it’s the last argument, it could optionally be variadic.

Example: aFile.txt or file1.txt file2.txt file3.txt
See more
Declaration
Swift

@propertyWrapper public class CommandOptionalInput<Value> : CommandInputSpecification where Value : CommandArgumentValue


                    
                    
                    CommandRequiredInput

Undocumented

See more

Declaration

Swift

@propertyWrapper
public class CommandRequiredInput<Value> : CommandInputSpecification where Value : CommandArgumentValue


                    
                    
                    CommandVariadicInput

Undocumented

See more

Declaration

Swift

@propertyWrapper
public class CommandVariadicInput<Value> : CommandInputSpecification where Value : CommandArgumentValue

CommandOption
An option argument represents a named option and is used to pass a value to the command. It could have a default value, or could be omitted.

Example: -p 8 or --passes 8
See more
Declaration
Swift

@propertyWrapper public class CommandOption<Value> : CommandOptionSpecification where Value : CommandArgumentValue

CommandLineParser
Undocumented
See more
Declaration
Swift

public final class CommandLineParser

CommandUsage
Undocumented
See more
Declaration
Swift

public final class CommandUsage

Execution
Undocumented
See more
Declaration
Swift

public final class Execution

ExecutionMode
Undocumented
See more
Declaration
Swift

public final class ExecutionMode

ExecutableFinder
Undocumented
See more
Declaration
Swift

public final class ExecutableFinder

Console
Undocumented
See more
Declaration
Swift

public class Console


                    
                    
                    BasicREPL

Undocumented

Declaration

Swift

public final class BasicREPL : REPLImplementation

CommandLineHistory
Undocumented
See more
Declaration
Swift

public final class CommandLineHistory

ReadEvaluatePrintLoop
Undocumented
See more
Declaration
Swift

public final class ReadEvaluatePrintLoop


                    
                    
                    TerminalREPL

Undocumented

See more

Declaration

Swift

public final class TerminalREPL : REPLImplementation

StandardIO
Undocumented
See more
Declaration
Swift

public final class StandardIO : IO


                    
                    
                    StandardInput

Undocumented

See more

Declaration

Swift

public final class StandardInput : Input, WrapsFileHandle


                    
                    
                    StandardBaseOutput

Undocumented

See more

Declaration

Swift

public class StandardBaseOutput : Output, WrapsFileHandle


                    
                    
                    StandardOutput

Undocumented

Declaration

Swift

public final class StandardOutput : StandardBaseOutput


                    
                    
                    StandardError

Undocumented

Declaration

Swift

public final class StandardError : StandardBaseOutput

Terminal
Undocumented
See more
Declaration
Swift

public final class Terminal

TerminalInputMode
Undocumented
See more
Declaration
Swift

public final class TerminalInputMode

LineReader
Undocumented
See more
Declaration
Swift

public final class LineReader

Environment
Gets and sets environment variables for the current process.
See more
Declaration
Swift

public class Environment

Subprocess
Undocumented
See more
Declaration
Swift

public class Subprocess

SubprocessResult
Undocumented
See more
Declaration
Swift

public class SubprocessResult

SimpleWordCompletion
Undocumented
See more
Declaration
Swift

public class SimpleWordCompletion : TextCompletion