Package

ConsoleKitCommands

ConsoleKitCommands provides utilities for handing commandline arguments in a Swift application. It provides Command and AsyncCommand types, as well as other supporting types, for processing commands with arguments, options, and flags.

Overview

Note

At this time, the argument handling capabilities of ConsoleKit are considered obsolete; when possible, we strongly recommend using ArgumentParser instead.

Topics

Classes

class Argument
An argument for a console command
class Flag
A supported option for a command.
class Option
A supported option for a command.

Protocols

protocol AnyAsyncCommand
A type-erased Command.
protocol AnyCommand
A type-erased Command.
protocol AsyncCommand
A command that can be run through a Console.
protocol AsyncCommandGroup
A group of named commands that can be run through a Console.
protocol Command
A command that can be run through a Console.
protocol CommandGroup
A group of named commands that can be run through a Console.
protocol CommandSignature
The structure of the inputs that a command can take

Structures

struct AsyncCommands
Represents a top-level group of configured commands. This is usually created by calling resolve(for:) on AsyncCommands.
struct CommandContext
A type-erased CommandContext
struct CommandInput
Raw input for commands. Use this to parse options and arguments for the command context.
struct Commands
Represents a top-level group of configured commands. This is usually created by calling resolve(for:) on Commands.
struct CompletionAction
An action to be used in the shell completion script(s) to provide special shell completion behaviors for an Option’s argument or a positional Argument.
struct ConsoleError
struct MergedAsyncCommandGroup

Enumerations

enum CommandError
Errors working with the ConsoleKitCommands module.
enum Shell
Shell completion implementations.

Extended Modules

ConsoleKitTerminal