Classes
Argument
- Initializers
- init(name: String, help: String, completion: CompletionAction)
- Instance Properties
- let completion: CompletionAction
- let help: String
- var initialized: Bool
- let name: String
- var projectedValue: Argument<Value>
- var wrappedValue: Value
Flag
- Initializers
- init(name: String, short: Character?, help: String)
- Instance Properties
- let help: String
- var initialized: Bool
- let name: String
- var projectedValue: Flag
- let short: Character?
- var wrappedValue: Bool
Option
- Initializers
- init(name: String, short: Character?, help: String, completion: CompletionAction)
- Instance Properties
- let completion: CompletionAction
- let help: String
- var initialized: Bool
- var isPresent: Bool
- let name: String
- var projectedValue: Option<Value>
- let short: Character?
- var wrappedValue: Value?
Protocols
AnyAsyncCommand
AnyCommand
AsyncCommand
- Associated Types
- Signature
- Instance Methods
- func run(using: CommandContext, signature: Self.Signature) async throws
AsyncCommandGroup
Command
- Associated Types
- Signature
- Instance Methods
- func run(using: CommandContext, signature: Self.Signature) throws
CommandGroup
CommandSignature
- Initializers
- init()
- init(from: inout CommandInput) throws
- Instance Methods
- func outputHelp(help: String, using: inout CommandContext)
Structures
AsyncCommands
- Initializers
- init(commands: [String : any AnyAsyncCommand], defaultCommand: (any AnyAsyncCommand)?, enableAutocomplete: Bool)
- Instance Properties
- var commands: [String : any AnyAsyncCommand]
- var defaultCommand: (any AnyAsyncCommand)?
- var enableAutocomplete: Bool
- Instance Methods
- func group(help: String) -> any AsyncCommandGroup
- func use(any AnyAsyncCommand, as: String, isDefault: Bool)
CommandContext
- Initializers
- init(console: any Console, input: CommandInput)
- Instance Properties
- var console: any Console
- var input: CommandInput
- var userInfo: [AnySendableHashable : any Sendable]
CommandInput
- Initializers
- init(arguments: [String])
- Instance Properties
- var arguments: [String]
- var executable: String
- var executablePath: [String]
Commands
- Initializers
- init(commands: [String : any AnyCommand], defaultCommand: (any AnyCommand)?, enableAutocomplete: Bool)
- Instance Properties
- var commands: [String : any AnyCommand]
- var defaultCommand: (any AnyCommand)?
- var enableAutocomplete: Bool
- Instance Methods
- func group(help: String) -> any CommandGroup
- func use(any AnyCommand, as: String, isDefault: Bool)
CompletionAction
- Initializers
- init([Shell : String])
- Instance Properties
- let expressions: [Shell : String]
- Subscripts
- subscript(Shell) -> String?
- Type Properties
- static var `default`: CompletionAction
- Type Methods
- static func directories() -> CompletionAction
- static func files(withExtensions: [String]) -> CompletionAction
- static func values([String]) -> CompletionAction
- static func values<C>(of: C.Type) -> CompletionAction
- Default Implementations
- ExpressibleByDictionaryLiteral Implementations
  - Initializers
  - init(dictionaryLiteral: (Shell, String)...)
ConsoleError
- Instance Properties
- let identifier: String
- let reason: String
MergedAsyncCommandGroup
- Instance Properties
- let commands: [String : any AnyAsyncCommand]
- let defaultCommand: (any AnyAsyncCommand)?
- var help: String
Enumerations
CommandError
- Operators
- static func == (CommandError, CommandError) -> Bool
- Enumeration Cases
- case invalidArgumentType(String, type: any Any.Type)
- case invalidOptionType(String, type: any Any.Type)
- case missingCommand
- case missingRequiredArgument(String)
- case unknownCommand(String, available: [String])
- case unknownInput(String)
- Instance Properties
- var debugDescription: String
- var description: String
Shell
- Enumeration Cases
- case bash
- case zsh
- Initializers
- init?(String)
- init?(rawValue: String)
- Instance Properties
- var description: String
Extended Modules
ConsoleKitTerminal
- Extended Protocols
- Console
  - Instance Methods
  - func run(_:input:)
  - func run(_:with:)

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

Instance Property

initialized

var initialized: Bool { get }

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

Twitter
Mastodon
Bsky
GitHub