`soim`: Social image generator CLI

Siddharth - Aug 29 '21 - - Dev Community

In my last post on Social Image generation, I talked about how I built a site which can be used to automate social image generation. Well, I just built a CLI for it! Introducing soim.

GitHub logo SiddharthShyniben / soim

Social Image generator

soim

Cover This image was made by running soim -t "This is some sample output of <b><code>soim</code></b>" -T "social, images, generator" -i "https://raw.githubusercontent.com/AnandChowdhary/undrawcdn/master/illustrations/images.svg" -c "Made by @SiddharthShyniben" -p "cover.png"

soim is a CLI tool for generating social images. Given data, soim uses Puppeteer to screenshot a page.

soim can also be used as a library. The exported generateImage function takes an object as options, and the options are the same as the CLI options.

Install

# locally
~$ npm i soim
# globally (for CLI)
~$ npm i -g soim
~$ soim -t ...
Enter fullscreen mode Exit fullscreen mode

CLI options

  • -t, --text: The main text.
  • -T, --tags: Comma separated list of tags, shown at the top of the image
  • -p, --path: The place to write the image
  • -l, --link: Custom link where the social image template lives. Useful if you want to design a custom template. See…

It's a small CLI tool to generate social images. Just run soim --text Something --caption something ... and get an image!

It uses puppeteer under the hood to generate images. I'll write a post on it someday.

Hope you like it!

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .