Package

ConsoleKit

💻 APIs for creating interactive CLI tools.

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.

protocol Console
Protocol for powering styled Console I/O.
class Terminal
Generic console that uses a mixture of Swift and C standard libraries to fulfill protocol requirements.
enum ConsoleColor
Supported colors for creating a ConsoleStyle for ConsoleText.
struct ConsoleStyle
Representation of a style for outputting to a Console in different colors with differing attributes. A few suggested default styles are provided.
enum ConsoleClear
Supported methods for clearing the Console.
struct ConsoleText
A collection of ConsoleTextFragments. Represents stylized text that can be outputted to a Console.
struct ConsoleTextFragment
A single piece of ConsoleText. Contains a raw String and the desired ConsoleStyle.
func + (ConsoleText, ConsoleText) -> ConsoleText
Appends a ConsoleText to another ConsoleText.
func += (inout ConsoleText, ConsoleText)
Appends a ConsoleText to another ConsoleText in-place.
extension StringProtocol

class ActivityIndicator
An instance of a ActivityIndicatorType that can be started, failed, and succeeded.
protocol ActivityIndicatorType
ActivityIndicatorTypes are responsible for drawing / rendering the current ActivityIndicatorState to the Console.
enum ActivityIndicatorState
Possible states to draw / render and ActivityIndicatorType.
protocol ActivityBar
An ActivityIndicatorType that renders an activity bar on a single line.
struct LoadingBar
Loading-style implementation of ActivityBar.
struct ProgressBar
Progress-style implementation of ActivityBar.
struct CustomActivity
An activity indicator with customizable frames and success and failure messages.

struct AnySendableHashable
A Sendable version of the standard library’s AnyHashable type.