You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
CLI tool that uses the GitHub API, Puppeteer and GitHub Socialify to set the social image for all of your repos automatically.
Installation
npm install -g github-social-image
Usage
Authentication details can be provided in the environment or as CLI arguments
Field
Environment Variable
CLI option
API token
GITHUB_TOKEN
--pat
Username
GITHUB_USERNAME
--username
Password
GITHUB_PASSWORD
--password
OTP
GITHUB_OTP
--otp
github-social-image --target "your-user-name"
Behaviour options
Flag
Description
username
GitHub account username
password
GitHub account password
otp
One Time Password code, required for accounts that use 2FA
pat
Github API token, used to fetch a list of repos
target
User, Org or Team to update the social image for. Will update all repos that the authenticated pat has admin access to. To specify a team, use the format org/team-slug
Specify as --description to use the description from the repo, or `--description "Text Here" to use a custom description
FAQ
Why do you need an API token and my username?
This tool uses the API token for listing repos to update through the API, and the username to drive a browser and log in to your account to set the social image as this operation is not available through the API
