Modules Overview

This page provides a quick overview of all available modules and their purpose.
For detailed API documentation, click on any module name.

Core Modules

These are the main modules you'll interact with most.

ansi

Provides the S and Term classes for typed, operator-based terminal styling, as well as terminal cursor and screen control.

color

Provides color manipulation across RGBA, HSLA, and hex spaces.
Includes dedicated classes for each color model, conversions, parsing, luminance calculation, color adjustments, and gradient generation.

console

Provides comprehensive tools for terminal output and user interaction.
Includes styled logging, box rendering, progress bars, throbbers, interactive prompts, key reading, and command-line argument parsing.

data

Provides utilities for inspecting, transforming, and querying nested data structures.
Includes path-based value lookup and mutation, deep equality comparison, removal of empty elements or duplicates, comment stripping, and syntax-highlighted rendering.

fs

Provides file system and path resolution utilities.
Includes fuzzy path resolution, safe file and directory creation, atomic JSON read and write helpers, and common path accessors.

regex

Provides utilities for dynamic regex pattern generation and compilation.
Includes composable pattern builders for color strings, balanced brackets, quotes, and function calls, alongside LazyRegex for deferred compilation.

string

Provides utility functions for advanced string manipulation.
Includes case conversions, indentation and whitespace normalization, safe type parsing, character frequency analysis, and code pattern detection.

system

Provides OS-level integration and system environment utilities.
Features include OS and hardware detection, environment PATH manipulation, privilege elevation, process restarting, and runtime dependency checking.

Base Utilities

Lower-level utilities, constants, types, exceptions, and decorators used internally across xulbux.

base.consts

Provides constant values used throughout the library.
Includes Unicode character sets, box-drawing characters, keyboard escape sequences, and ANSI formatting constants.

base.decorators

Provides utility decorators used throughout the library.
Includes decorators for deprecating callables and configuring MyPyC compiler attributes.

base.exceptions

Provides custom exception classes used throughout the library.
Includes exceptions for missing dependencies, execution failures, data formatting errors, and filesystem operations.

base.types

Provides custom type definitions and TypeVars used throughout the library.
Includes type aliases for structured color formats, path representations, and generic nested data structures.

CLI Tools

Command-line interface utilities packaged with xulbux.

cli.ansi

CLI command to display all available ANSI style and color codes in the terminal.

cli.color256

CLI command to display the full 256-color ANSI terminal palette.

cli.help

CLI help command and version update checking for the xulbux-lib tool.

cli.true_color

CLI command to render a smooth true-color gradient in the terminal.