@opscode/snappy

Generate beautiful code snapshot images from local files with customizable themes and backgrounds.

Features

• 🎨 Multiple Themes: Choose from Nord, Dracula, GitHub Dark/Light, Monokai, and more
• 🌈 Custom Backgrounds: Use preset gradients or your own images
• 🔧 Configurable: Set default themes, backgrounds, and opacity
• 💨 Lightweight: Uses your system's Chrome/Chromium instead of bundling a browser
• 📦 Easy to Use: Simple CLI interface with sensible defaults

Installation

npm install -g @opscode/snappy

Requirements:

• Node.js >= 12.0.0
• Chrome, Chromium, or Edge browser installed

Quick Start

# Basic usage
snappy capture myfile.js

# With custom theme and background
snappy capture myfile.js --theme dracula --background ocean

# With custom opacity
snappy capture myfile.js --opacity 80

# Use your own background image
snappy capture myfile.js --background ./my-wallpaper.png

Commands

capture

Generate a code snapshot from a file.

snappy capture <file> [options]

Options:

• -o, --output <path> - Output file path
• -t, --theme <name> - Theme to use (dracula, nord, github-dark, etc.)
• -b, --background <preset|path> - Background (preset name or image path)
• --opacity <0-100> - Window opacity (default: 100)

list

List available themes and backgrounds.

snappy list

config

Manage default configuration.

# Set default theme
snappy config:theme:set dracula

# Set default background
snappy config:background:set ocean

# Set default opacity
snappy config:opacity:set 90

Available Themes

• nord
• dracula
• github-dark
• github-light
• material-theme
• monokai
• min-light

Available Background Presets

• dawn - Orange to pink gradient
• dusk - Blue to purple gradient
• cool - Cyan to blue gradient
• warm - Yellow gradient
• neon - Green to blue gradient
• ocean - Teal to purple gradient
• forest - Green gradient
• cyber - Pink gradient
• grape - Orange to yellow gradient
• midnight - Dark gray gradient

Examples

# Capture with Nord theme and ocean background
snappy capture app.ts --theme nord --background ocean

# Use custom background image with transparency
snappy capture app.ts --background ./wallpaper.png --opacity 75

# Set defaults and use them
snappy config:theme:set dracula
snappy config:background:set dawn
snappy capture app.ts

License

MIT

Author

opscode