# LogsDX
[](https://www.npmjs.com/package/logsdx)
[](https://github.com/yowainwright/logsdx/actions/workflows/ci.yaml)
[](https://codecov.io/gh/yowainwright/logsdx)
[](https://github.com/yowainwright/logsdx/blob/main/LICENSE)
**Beautiful, consistent log styling for terminal and browser environments.**
LogsDX is a schema-based theming engine that applies consistent visual styling to logs across all environments—write themes once, style logs everywhere.
## Features
- **Unified Theming** - One theme works in terminal, browser, and CI/CD
- **Zero Dependencies** - Works with any existing logger
- **8+ Built-in Themes** - Production-ready themes included
- **CLI Tool** - Process log files with beautiful formatting
- **Accessible** - WCAG compliance checking built-in
- **Light/Dark Mode** - Automatic theme adaptation
## Installation
```bash
# npm
npm install logsdx
# bun (recommended for development)
bun add logsdx
# yarn
yarn add logsdx
# pnpm
pnpm add logsdx
```
**Requirements:** Node.js 18+ or Bun 1.0+
## Getting Started
### 1. Basic Usage - Style Your Console Logs
```javascript
import { getLogsDX } from "logsdx";
// Initialize with a built-in theme
const logger = getLogsDX("dracula");
// Style a log line
console.log(
logger.processLine(
"ERROR: Database connection failed at 2024-01-15T10:30:45Z",
),
);
// Output: Styled text with ERROR in red, timestamp in dim gray
```
### 2. Process Multiple Lines
```javascript
const logs = [
"INFO: Server started on port 3000",
"WARN: Memory usage above 80%",
"ERROR: Failed to connect to database",
];
// Process all lines at once
const styledLogs = logger.processLines(logs);
styledLogs.forEach((line) => console.log(line));
```
### 3. Browser Integration (React Example)
```jsx
import { LogsDX } from "logsdx";
function LogViewer({ logs }) {
const logger = LogsDX.getInstance({
theme: "dracula",
outputFormat: "html",
htmlStyleFormat: "css",
});
return (
{logs.map((log, i) => (
))}