Skip to content

ConsoleKit

Core

Vapor VaporMacros beta AsyncKit RoutingKit ConsoleKit ConsoleKitCommands ConsoleKitTerminal ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

4.x

4.x 5.0 (beta) beta

ConsoleKit

Classes
ActivityIndicator
- Instance Properties
- var activity: A
- Instance Methods
- func fail()
- func start(refreshRate: Int)
- func succeed()
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?
Terminal
- Initializers
- init()
- Instance Properties
- var size: (width: Int, height: Int)
- var userInfo: [AnySendableHashable : any Sendable]
- Instance Methods
- func clear(ConsoleClear)
- func input(isSecure: Bool) -> String
- func output(ConsoleText, newLine: Bool)
- func report(error: String, newLine: Bool)
Protocols
ActivityBar
- Instance Properties
- var title: String
- Instance Methods
- func renderActiveBar(tick: UInt, width: Int) -> ConsoleText
- Type Properties
- static var width: Int
ActivityIndicatorType
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)
Console
LoggerFragment
TimestampSource
- Instance Methods
- func now() -> tm
Structures
AndFragment
- Initializers
- init(T, U)
- Instance Properties
- let first: T
- let second: U
- Instance Methods
- func hasContent(record: inout LogRecord) -> Bool
- func write(inout LogRecord, to: inout FragmentOutput)
AnySendableHashable
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
ConsoleFragmentLogger
ConsoleStyle
- Initializers
- init(color: ConsoleColor?, background: ConsoleColor?, isBold: Bool)
- Instance Properties
- let background: ConsoleColor?
- let color: ConsoleColor?
- let isBold: Bool
- Type Properties
- static var error: ConsoleStyle
- static var info: ConsoleStyle
- static var plain: ConsoleStyle
- static var success: ConsoleStyle
- static var warning: ConsoleStyle
ConsoleText
ConsoleTextFragment
- Initializers
- init(string: String, style: ConsoleStyle)
- Instance Properties
- var string: String
- var style: ConsoleStyle
CustomActivity
- Initializers
- init(frames: [ConsoleText], success: String, failure: String)
- init(frames: [String], success: String, failure: String, color: ConsoleColor)
- Instance Properties
- let failure: String
- let frames: [ConsoleText]
- let success: String
- Instance Methods
- func outputActivityIndicator(to: any Console, state: ActivityIndicatorState)
FragmentOutput
- Operators
- static func += (inout FragmentOutput, ConsoleText)
- Initializers
- init()
- Instance Properties
- var needsSeparator: Bool
- var text: ConsoleText
IfMaxLevelFragment
- Initializers
- init(T, maxLevel: Logger.Level)
- Instance Properties
- let fragment: T
- let maxLevel: Logger.Level
- Instance Methods
- func hasContent(record: inout LogRecord) -> Bool
- func write(inout LogRecord, to: inout FragmentOutput)
LabelFragment
- Initializers
- init()
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
LevelFragment
- Initializers
- init()
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
LiteralFragment
- Initializers
- init(ConsoleText)
- Instance Properties
- let literal: ConsoleText
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
LoadingBar
- Instance Properties
- var title: String
- Instance Methods
- func renderActiveBar(tick: UInt, width: Int) -> ConsoleText
LogRecord
LoggerSourceFragment
- Initializers
- init()
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
MergedAsyncCommandGroup
- Instance Properties
- let commands: [String : any AnyAsyncCommand]
- let defaultCommand: (any AnyAsyncCommand)?
- var help: String
MessageFragment
- Initializers
- init()
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
MetadataFragment
- Initializers
- init()
- Instance Methods
- func hasContent(record: inout LogRecord) -> Bool
- func write(inout LogRecord, to: inout FragmentOutput)
ProgressBar
- Instance Properties
- var currentProgress: Double
- var title: String
- Instance Methods
- func renderActiveBar(tick: UInt, width: Int) -> ConsoleText
SeparatorFragment
- Initializers
- init(ConsoleText, fragment: T)
- Instance Properties
- var fragment: T
- let literal: ConsoleText
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
SourceLocationFragment
- Initializers
- init()
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
SystemTimestampSource
- Initializers
- init()
- Instance Methods
- func now() -> tm
TimestampFragment
- Initializers
- init(S)
- Instance Methods
- func write(inout LogRecord, to: inout FragmentOutput)
Functions
func defaultLoggerFragment() -> DefaultLoggerFragmentType
func timestampDefaultLoggerFragment(timestampSource: some TimestampSource) -> some LoggerFragment
Operators
func + (ConsoleText, ConsoleText) -> ConsoleText
func += (inout ConsoleText, ConsoleText)
Type Aliases
ConsoleLogger
DefaultLoggerFragmentType
Enumerations
ActivityIndicatorState
- Enumeration Cases
- case active(tick: UInt)
- case failure
- case ready
- case success
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
ConsoleClear
- Enumeration Cases
- case line
- case screen
ConsoleColor
- Enumeration Cases
- case black
- case blue
- case brightBlack
- case brightBlue
- case brightCyan
- case brightGreen
- case brightMagenta
- case brightRed
- case brightWhite
- case brightYellow
- case custom(r: UInt8, g: UInt8, b: UInt8)
- case cyan
- case green
- case magenta
- case palette(UInt8)
- case red
- case white
- case yellow
Shell
- Enumeration Cases
- case bash
- case zsh
- Initializers
- init?(String)
- init?(rawValue: String)
- Instance Properties
- var description: String
Extended Modules
Logging
Swift

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 MethodConsoleKitTerminal

hasContent(record:)

func hasContent(record: inout LogRecord) -> Bool

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

API Documentation © 2026 Vapor.

Twitter
Mastodon
Bsky
GitHub