quickstart

SVG Term Quickstart

Create beautiful animated SVG recordings of terminal sessions.

Commands

• svg-term <resource> <action> — Execute svg-term commands

Installation

npm install -g svg-term-cli

# Optional: Install asciinema for recording
brew install asciinema  # macOS

Basic Workflow

1. Record Terminal Session

# Start recording
asciinema rec demo.cast

# Do your terminal work...

# Stop recording (Ctrl+D or type 'exit')

2. Convert to SVG

# From local file
svg-term --in demo.cast --out demo.svg

# From asciinema.org (replace CAST_ID with actual ID)
svg-term --cast CAST_ID --out demo.svg

Styling Options

# Set window frame style
svg-term --in demo.cast --out demo.svg --window

# Set theme
svg-term --in demo.cast --out demo.svg --theme monokai

# Available themes: dracula, monokai, solarized-dark, etc.

Embedding

The generated SVG can be:

• Embedded directly in README.md
• Used in blog posts
• Added to documentation
• Viewed in any modern browser

![Demo](demo.svg)

Tips

• Keep recordings short for smaller file sizes
• Use --window flag for a realistic terminal frame
• Test different themes for better contrast
• Consider using --padding for breathing room