termsnap: Capture Beautiful Terminal Screenshots, Videos, and GIFs
This repository profile is provided by osrepos.com, an open source repository discovery platform.
Summary
termsnap is a powerful command-line tool that transforms terminal command output into stunning screenshots, animated GIFs, and videos. It offers extensive customization, including local font and emoji support, various output formats, and theme options. This tool is ideal for developers looking to create high-fidelity visual documentation for their CLI projects.
Repository Information
Topics
Click on any tag to explore related repositories
Use at your own risk
OSRepos shares public repositories for knowledge and discovery only. Any installation, execution, configuration, or use of code from these repositories is the user's own responsibility. Always review the repository, source code, dependencies, licenses, and security implications before running or installing anything. OSRepos is not responsible for issues, damages, or losses resulting from third-party repositories.
Introduction
termsnap is an innovative command-line interface (CLI) tool designed to transform your terminal output into stunning visual assets. Whether you need high-quality screenshots, animated GIFs, or even videos of your terminal sessions, termsnap provides a flexible and powerful solution. It stands out with its ability to perfectly render local fonts and emojis, support interactive terminal sessions, and offer extensive theme customization. Built with a Go-based terminal output proxy and web rendering technology, termsnap ensures pixel-perfect fidelity for all your captures.
Installation
Getting started with termsnap is straightforward using npx. You can run it directly without a global installation:
npx termsnap "lolcat -f <(figlet -f banner3 termsnap)"
This command will execute termsnap and capture the output of the lolcat and figlet commands, demonstrating its immediate utility.
Examples
termsnap offers a wide range of output formats and customization options. Here are some common usage examples:
- Browser Preview: Open an animated preview directly in your browser.
npx termsnap "command" --animate --open - Save as HTML File: Generate a standalone HTML file with embedded styling.
npx termsnap "command" --html - Save as Screenshot (PNG): Create a high-quality PNG image of your terminal output.
npx termsnap "command" --png - Save as Video (MP4): Record your terminal session as an MP4 video at a specified frame rate.
npx termsnap "command" --mp4 --fps 60 - Save as Animated GIF: Produce an optimized GIF with customizable frame rate and scale.
npx termsnap "command" --gif --gif-fps 20 --gif-scale 720 - Custom Theme and Decoration: Apply a specific theme and window decorations to your output.
npx termsnap "command" --open --theme "vitesse-light" --decoration
Why Use It
The motivation behind termsnap stems from the limitations of existing terminal screenshot tools, particularly regarding local font and emoji support, and the ability to capture interactive sessions with perfect fidelity. termsnap addresses these challenges by providing a tool that truly feels like recording your terminal, ensuring every detail, from custom fonts to animated typing effects, is captured accurately. It's an invaluable asset for developers, technical writers, and anyone needing to create professional-grade visual documentation for their command-line tools and projects.
Links
Source repository
Open the original repository on GitHub.