sugarcraft/candy-kit

PHP port of charmbracelet/fang — opinionated CLI presentation helpers: StatusLine (✓/✗/⚠/ℹ), Banner, Section header, Stage step, HelpText page, and 6 stock themes (ansi/plain/charm/dracula/nord/catppuccin).

Maintainers

Package info

github.com/sugarcraft/candy-kit

Documentation

pkg:composer/sugarcraft/candy-kit

Transparency log

Statistics

Installs: 0

Dependents: 3

Suggesters: 0

Stars: 1

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

dev-master 2026-07-04 22:42 UTC

Requires

Requires (Dev)

MIT 3629146389b2c3ebcb0df805d7dac539d49b7e64

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

cliconsolehelpbannerpresentationstatus-linefangsugarcraft

Published on Packagist.org on 2026-07-04 22:43 UTC

This package is auto-updated.

Last update: 2026-07-10 03:48:55 UTC

README

candy-kit

CandyKit

CI codecov Packagist Version License PHP

demo

composer require sugarcraft/candy-kit

PHP port of charmbracelet/fang — opinionated CLI presentation helpers that turn ordinary command- line output into something that matches the rest of the SugarCraft stack. CandyKit is library-only — drop it into any Composer project, no Symfony Console requirement.

use SugarCraft\Kit\StatusLine;
use SugarCraft\Kit\Banner;
use SugarCraft\Kit\Theme;

echo Banner::title('CandyApp', 'v0.1.0'), "\n\n";
echo StatusLine::info('connecting to https://example.com'), "\n";
echo StatusLine::success('done in 0.4s'), "\n";
echo StatusLine::warn('disk almost full'), "\n";
echo StatusLine::error('connection refused'), "\n";

Components

  • Theme — palette of Sprinkles\Style objects keyed by status level (success / error / warn / info / prompt / accent / muted). Theme::ansi() ships a sensible default; bring your own theme by passing styles to the constructor.
  • StatusLine — success / error / warn / info static helpers returning a glyph + message string styled per the active theme.
  • Banner — render a bordered title block with optional subtitle, rounded by default. Useful for app intros / --version output.
  • Logo — ASCII-art logo renderer with Logo::sugarcraft() built-in preset and Logo::fromAscii($art) for custom art. Chain ->withColor($hex) to apply foreground color.
  • Section — styled section with title and body content, themeable.
  • Stage — multi-section presentation container.
  • HelpText — formatted help output.
  • Frame — full-screen application chrome: a double-line box that fills the terminal exactly (Frame::new()->withTitle($bar) ->withStatus($bar)->render($body, $cols, $rows)), with a centred title bar, dividers, and a status bar. Normalises the body to a constant line count and pads ANSI-width-aware so it never overflows the terminal — safe for a TEA program whose frame-diff renderer owns the screen.

Demos

CLI page

cli-page

Logo

logo

Section

section

Stage

stage

Test

cd candy-kit && composer install && vendor/bin/phpunit

Snapshot tests

Presenter output is pinned via candy-testing's assertGoldenAnsi golden-file snapshots. Any change to the ANSI slide output must be intentional — re-record the fixture with --update-golden to accept a new canonical render.