freeze: Create Images of Code and Terminal Output

Overview

Freeze is a Go command-line tool for rendering source files and terminal output as images. It helps developers create shareable, styled code and terminal screenshots without manually arranging them in an image editor.

It can read code from files or standard input, and can capture ANSI-formatted output from a command. An interactive mode and configuration files let users adjust the appearance for repeated use.

Key Features

• Render code files or standard input as images.
• Capture terminal command output with the --execute flag.
• Export PNG, SVG, and WebP images.
• Customize syntax theme, font, line numbers, background, padding, and window styling.
• Save and reuse settings through JSON configuration files.
• Adjust settings in an interactive terminal interface.
• Capture terminal UI states by piping tmux capture-pane output into Freeze.

Use Cases

• Developers can create consistent code visuals for documentation and tutorials.
• Educators and technical writers can prepare readable code examples for slides or articles.
• CLI maintainers can share formatted command output in release notes or support discussions.
• Terminal UI developers can capture a chosen application state for documentation or bug reports.

Project Facts

• Language: Go
• License: MIT
• Stars: 4.9k
• Forks: 107
• Topics: none listed
• Archived: No

Getting Started

Install with Go:

go install github.com/charmbracelet/freeze@latest

For other installation options and usage details, see the README.

Alternatives

• VHS: VHS scripts and records terminal sessions as GIFs or videos, while freeze creates static images of source code or terminal output.

Considerations

Freeze is a command-line utility, so users need to be comfortable working in a terminal. Its output is intended as a visual rendering, not an editable code document. Check the README for installation options and the full list of supported customization settings.