sugarcraft/sugar-glow

PHP port of charmbracelet/glow — Markdown CLI viewer / pager composing CandyShine + Viewport. 8 stock themes, word-wrap, OSC 8 hyperlinks.

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

Requires

• php: ^8.1
• sugarcraft/candy-core: @dev
• sugarcraft/candy-shine: @dev
• sugarcraft/sugar-bits: @dev
• symfony/console: ^6.4 || ^7.0

Requires (Dev)

• phpunit/phpunit: ^10.5

MIT

• Joe Huss

• cli
• markdown
• pager
• ansi
• Viewer
• glow
• tui
• sugarcraft

README

SugarGlow

PHP port of charmbracelet/glow — a Markdown CLI viewer that composes CandyShine (rendering) and SugarBits Viewport (scrolling).

composer require sugarcraft/sugar-glow

CLI

sugarglow README.md                            # render to stdout (default)
sugarglow -p README.md                         # open in a fullscreen pager
git log -1 --pretty=%B | sugarglow -p          # pipe stdin
sugarglow --theme dracula README.md
sugarglow --width 80 --no-hyperlinks README.md
sugarglow --theme-config ./my-theme.json README.md

Flags:

• --theme {ansi|plain|dark|light|notty|dracula|tokyo-night|pink} — picks a CandyShine preset.
• --style / -s — alias for --theme (glamour-compat).
• --theme-config <path> — load a custom JSON theme via Theme::fromJson. Overrides --theme.
• --width / -w <N> — word-wrap paragraphs / blockquotes / list bodies. 0 = no wrap.
• --no-hyperlinks — disable OSC 8 link envelopes; render links as text (url) instead.
• --pager / -p — open in a fullscreen pager.

Pager keys

Standard reader keys come from Viewport:

Key	Action
↑ / k	line up
↓ / j	line down
PgUp / b	page up
PgDn / space / f	page down
Ctrl+U / Ctrl+D	half page
Home / g	top
End / G	bottom
q / Esc / Ctrl+C	exit

Demos

Render to stdout

Fullscreen pager

Test

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