Skip to content

README.md

Latest commit

聽

History

History
51 lines (35 loc) 路 2.19 KB

README.md

File metadata and controls

51 lines (35 loc) 路 2.19 KB
Raw

ConsoleKit

Documentation Team Chat MIT License Continuous Integration Swift 6.1+


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

Supported Platforms

ConsoleKit supports all platforms supported by Swift 6.1 and later.

Installation

Use the SPM string to easily include the dependendency in your Package.swift file

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

and add it to your target's dependencies:

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

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 a terminal.
  • Utilities for reading input from a terminal.
  • ConsoleLogger, a SwiftLog LogHandler implementation for customizable logging to a console.

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")