sugarcraft/sugar-spark

PHP port of charmbracelet/sequin — ANSI escape-sequence inspector. Decodes SGR / CSI / OSC / DCS / APC / SS3 sequences into human-readable labels.

Maintainers

Package info

github.com/sugarcraft/sugar-spark

Documentation

pkg:composer/sugarcraft/sugar-spark

Statistics

Installs: 0

Dependents: 2

Suggesters: 0

Stars: 1

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v0.2.0 2026-05-07 01:29 UTC

Requires

Requires (Dev)

MIT 83ea60e1de4c82802f37cb3fab3b21f27966bd6f

  • Joe Huss <detain.woop@interserver.net>

debugterminalinspectoransiEscapetuisequinsugarcraft

This package is auto-updated.

Last update: 2026-05-18 22:49:49 UTC

README

sugar-spark

SugarSpark

CI codecov Packagist Version License PHP

demo

PHP port of charmbracelet/sequin — an ANSI escape-sequence inspector. Pipe styled output through it and each escape becomes a labelled line.

composer require sugarcraft/sugar-spark

CLI

$ printf '\e[31mhello\e[0m world\n' | sugarspark
ESC[31m  SGR foreground red
hello
ESC[0m   SGR reset
 world
$ printf '\e]0;new title\e\\' | sugarspark
ESC]0;new title  set window title to "new title"
$ printf '\e[?2026h' | sugarspark
ESC[?2026h  enable synchronized output

Library

use SugarCraft\Spark\Inspector;

foreach (Inspector::parse("\e[1;31mboom\e[0m") as $segment) {
    echo $segment->describe(), "\n";
}

// One-shot report:
echo Inspector::report($capturedTerminalOutput);

What it decodes

  • SGR — foreground / background (16, 256, 24-bit truecolor) + bold / italic / underline / blink / reverse / strikethrough / faint.
  • CSI — cursor moves, erase, scroll region (DECSTBM), scroll up/down, insert/delete line/char, tab forward/backward, DECSCUSR cursor shape, DECRQM mode query, DECRPM mode reply, request cursor position, XTVERSION query, kitty keyboard query/push/pop.
  • CSI ~ keys — Home / End / Delete / PgUp / PgDn / F1-F12 / bracketed paste markers.
  • DEC private modes — cursor visibility, mouse modes (1000/1002/1003/ 1006/1015), focus reporting (1004), alt screen (47/1047/1049), bracketed paste (2004), synchronized output (2026), unicode grapheme mode (2027).
  • OSC — title (0/2), icon (1), palette (4), cwd (7), hyperlink (8), iTerm2 (9), taskbar progress (9;4), terminal colour set (10/11/12), clipboard (52), reset terminal colour (110/111/112).
  • DCS — XTVERSION reply (>|<term> <ver>), DECRPSS, sixel.
  • APC — CandyZone markers (candyzone:S/E:<id>), kitty graphics (G…).
  • SS3 — F1-F4 / cursor / Home / End.
  • 2-byte ESC — DECSC / DECRC / keypad mode / index / reverse-index / reset.

Anything unrecognised falls back to a generic CSI/OSC/... descriptor — nothing is silently swallowed.

Test

cd sugar-spark && composer install && vendor/bin/phpunit