Skip to content

ConsoleKit

Core

Vapor AsyncKit RoutingKit ConsoleKit 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

5.0 (beta)

4.x 5.0 (beta) beta

Terminal
Console
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)
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
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
ConsoleClear
- Enumeration Cases
- case line
- case screen
ConsoleText
ConsoleTextFragment
func + (ConsoleText, ConsoleText) -> ConsoleText
func += (inout ConsoleText, ConsoleText)
StringProtocol
Activity
ActivityIndicator
- Instance Properties
- var activity: A
- Instance Methods
- func withActivityIndicator(refreshRate:_:)
ActivityIndicatorType
ActivityIndicatorState
- Enumeration Cases
- case active(tick: UInt)
- case failure
- case ready
- case success
ActivityBar
- Instance Properties
- var title: String
- Instance Methods
- func renderActiveBar(tick: UInt, width: Int) -> ConsoleText
LoadingBar
- Instance Properties
- let title: String
- Instance Methods
- func renderActiveBar(tick: UInt, width: Int) -> ConsoleText
ProgressBar
- Instance Properties
- var currentProgress: Double
- let title: String
- Instance Methods
- func renderActiveBar(tick: UInt, width: Int) -> ConsoleText
CustomActivity
Structures
AnySendableHashable
Extended Modules
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 Property

background

Optional background color. If nil background is plain.

let background: ConsoleColor?

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