ConsoleToSvg 0.1.1

ConsoleToSvg

console2svg is a .NET global tool that converts terminal output into SVG.

Overview

console2svg | console2svg

This image is generated by converting the description text of this library into SVG (oh, how meta).

console2svg -w 100 -h 24 --window macos --padding 5 -- console2svg

You can also generate SVG with a window frame. and some options to customize the appearance.

Play animation

console2svg -m video --window macos -w 120 -h 16 -- ./my-install.sh

In video mode, you can capture the animation of the command execution and save it as an SVG.

Play loop animation

console2svg -m video --window macos --loop -- copilot --banner

Loop playback is also supported.

Install

dotnet tool install -g ConsoleToSvg

Usage

Pipe mode

Width and height default to the current terminal dimensions.

my-command | console2svg

PTY command mode

console2svg "git log --oneline"

Or pass the command after --:

console2svg -- dotnet test.cs

Animated SVG

console2svg -m video -- dotnet build

Loop playback:

console2svg -m video --loop -- nyancat

Static SVG with crop

# ch: charactor width, px: pixel
console2svg "dotnet --info" --crop-top 1ch --crop-right 5px

You can also crop at the position where a specific character appears. When specifying a character, you can specify it like :(number), which crops at a relative position from the detected line.

console2svg "dotnet --info" --crop-top "Host" --crop-bottom ".NET runtimes installed:-2"

Window chrome and padding

console2svg --window macos --padding 8 -- dotnet --version

Key options

• -m, --mode image|video
• -c, --command <cmd> (also works as a bare positional argument)
• -o, --out <svg-path>
• -w, --width <columns> / -h, --height <rows> (default: auto-detected from terminal in pipe mode, 80×24 for PTY)
• --frame <index>
• --crop-top|--crop-right|--crop-bottom|--crop-left <px|ch|pattern>
• --theme dark|light
• --window none|macos|windows
• --padding <px> (default: 2)
• --loop (video mode only, default: false)
• --fps <number> (video mode only, default: 12)
• --font <css-font-family>
• --in <cast-path>
• --save-cast <path>
• --help
• --version