close
Skip to content

leereilly/graphsay

Repository files navigation

graphsay

graphsay

Generate animated GitHub-style contribution graph messages as SVG, GIF, WebP, or MP4.

Installation

Prerequisites

  • Node.js v18 or later
  • ffmpeg (only needed for GIF, WebP, and MP4 output)

Run with npx (no install needed)

npx graphsay -m "HELLO WORLD" -f svg

Install globally

npm install -g graphsay

Install from source

git clone https://github.com/leereilly/graphsay.git
cd graphsay
npm install
npm run build

Usage

npx graphsay --message "HELLO WORLD" --format svg

Options

Flag Description Default
-m, --message <TEXT> Message to display (required, max 500 chars)
-t, --theme <THEME> light, dark, or both both
-f, --format <FORMAT> svg, gif, webp, mp4 mp4
-o, --output <PATH> Output file path auto-generated
--color <HEX> Text color hex code #40c463
--mode <MODE> scroll or static scroll
--speed <SECONDS> Step interval in seconds 0.15
--no-transparent Add a background color instead of transparent transparent
--no-loop Disable looping (SVG plays once and freezes; GIF does not loop) loops

Examples

# SVG with light theme (scroll)
npx graphsay -m "HELLO WORLD" -f svg -t light

Light theme scroll

# SVG with both light/dark mode support
npx graphsay -m "HELLO WORLD" -f svg -t both
Both themes scroll
# Static centered text (dark theme)
npx graphsay -m "HELLO WORLD" -f svg -t dark --mode static

Dark theme static

# Custom color
npx graphsay -m "RUST" -f svg --color "#ff6600"

Custom color

# GIF output (requires ffmpeg)
npx graphsay -m "HELLO" -f gif -t light

GIF example

# With background color (non-transparent)
npx graphsay -m "HELLO WORLD" -f svg -t dark --no-transparent

Non-transparent dark

# MP4 video (requires ffmpeg)
npx graphsay -m "HELLO" -f mp4

➡️ Output

Requirements

  • SVG output: No additional dependencies
  • GIF/WebP/MP4 output: Requires ffmpeg to be installed and available on PATH

Testing

npm test

License

MIT

About

Generate animated GitHub-style contribution graph messages as SVG, GIF, WebP, or MP4.

Topics

Resources

License

Stars

Watchers

Forks

Contributors