demainilpleut.dev's Opengraph image generator.
It is a cli tool written in Go that can be called from the main project to generate the Opengraph images for demainilpleut's articles.
This project was born out of the frustration of doing a similar thing with a node script, that was using a lot of dependecies, constantly updated and breaking my build.
By rewriting this tool with Go, I can generate a binary and let it run for YEARS without touching it.
- go >= 1.21
Clone the repository.
git clone https://github.com/jveillet/demainilpleut-opengraph.gitBuild the binary.
go build -o opengraphBuilding without cgo (disables calling C code (import "C"))
CGO_ENABLED=0 go build -o opengraphOr run via source.
go run main.go$ opengraph -h
A CLI tool to manipulate opengraph images for demainilpleut.dev
Usage:
opengraph [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
generate demainilpleut's OpenGraph images generation
help Help about any command
version print Opengraph version
Flags:
-h, --help help for opengraph
-t, --toggle Help message for toggle
Use "opengraph [command] --help" for more information about a command.$ opengraph generate -h
Opengraph is a CLI to generate opengraph images for blog posts.
it uses the command line arguments to write text on an image template.
Usage:
opengraph generate [flags]
Flags:
-a, --author string post AUTHOR
-b, --background_path string Background image temmplates path SRC
-d, --date string post DATE in YYYY-MM-DD format
-o, --output string output FILE
-h, --help help for generate
-l, --logo_path string Logo image path SRC
-t, --title string post TITLEExample:
Via source
go run main.go generate -a johndoe -d 1970-01-01 -o ./dist/out.png -t "The quick brown fox jumps over the lazy dog" -b "dist/background.png" -ol "dist/logo.png"Via binary
./opengraph generate -a johndoe -d 1970-01-01 -o ./dist/out.png -t "The quick brown fox jumps over the lazy dog" -b "dist/background.png" -l "dist/logo.png"Since version 2.0.0:
Loading of images path from the environment is deprecated.
Image templates don't rely on environment variables anymore.
You need to pass the full path to the images via the arguments to the generate command:
-bfor the path to the background image.-lfor the path to the logo.
As such, images have been removed from the repo and depend now on images external to this tool.
The destination image path is now under the flag -o or --output.
The -l or --label is now deprecated (-l is now for the logo image).
The Arial font file is now embed in the binary, to cope with systems where the font might not be available.
The only external dependencies needed are now github.com/spf13/cobra to create a modern CLI interface.
By all means, yes.
It is specifically tailored to run for demainilpleut.dev, so it might not be usefull to you, as is.
You are free to fork the project and adapt it to your own needs 😄️.