Skip to content

sugarcraft/candy-freeze

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

21 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

candy-freeze

CandyFreeze

CI codecov Packagist Version License PHP

demo

PHP port of charmbracelet/freeze โ€” turn code or terminal output into an SVG screenshot. No ext-gd / Imagick required; the output is plain text suitable for git diffs and CI artifacts.

composer require candycore/candy-freeze

CLI

echo "function hello() { return 'world'; }" \
    | candyfreeze --theme dracula --line-numbers > out.svg

candyfreeze input.php \
    --theme tokyo-night --no-window --output screenshot.svg

Flags:

  • --theme {dark|light|dracula|tokyo-night|nord} โ€” colour palette.
  • --padding N โ€” content padding inside the frame.
  • --no-window โ€” drop the macOS-style traffic-light controls.
  • --no-shadow โ€” drop the SVG drop-shadow filter.
  • --no-border โ€” drop the frame outline.
  • --line-numbers โ€” render a left-gutter line counter.
  • --border-radius N โ€” corner radius of the frame.
  • -o/--output <path> โ€” write SVG to a file instead of stdout.

Library

use CandyCore\Freeze\SvgRenderer;

$svg = SvgRenderer::dracula()
    ->withLineNumbers(true)
    ->withWindow(true)
    ->withPadding(24)
    ->render($code);

file_put_contents('out.svg', $svg);

ANSI input is honoured โ€” SGR foreground colours (16 / 256 / 24-bit truecolor) plus bold / italic / underline become <tspan> segments in the output.

$svg = SvgRenderer::dark()->render("\x1b[31merror:\x1b[0m something broke");

Themes

SvgRenderer::dark();        // charm-ish #0d1117
SvgRenderer::light();       // #f6f8fa
SvgRenderer::dracula();     // #282a36
SvgRenderer::tokyoNight();  // #1a1b26
SvgRenderer::nord();        // #2e3440

Build a custom theme via the Theme constructor โ€” set background / foreground / border / shadow / line-number colour / window-control colours / font family / size / line height.

Test

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

About

๐Ÿ“ธ PHP port of โ„๏ธ freeze โ€” render terminal output or code to SVG screenshots with macOS window chrome, drop shadow & line numbers.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages