README.md

💻 Utilities for interacting with a terminal and the command line in a Swift application.

Overview

ConsoleKit provides utilities for interacting with a console in a Swift application. It provides:

• Utilities for sending text (including styles and colors, when supported) to and reading input from a terminal.
• ConsoleLogger, a SwiftLog LogHandler implementation for customizable logging to a console.

Supported Platforms

ConsoleKit supports all platforms supported by Swift 6.2 and later.

Installation

Use the Github repository URL to add the dependency to your Package.swift manifest:

.package(url: "https://github.com/vapor/console-kit.git", from: "5.0.0")

CLI Tools

To use ConsoleKit, add it to your target's dependencies:

.product(name: "ConsoleKit", package: "console-kit")

Logging

ConsoleLogger is a flexible logging backend for console applications, allowing developers to customize log output with various fragments, including timestamps, log levels, and source locations.

To use ConsoleLogger, add it to your target's dependencies:

.product(name: "ConsoleLogger", package: "console-kit")