§01
Installation
# Install globally
npm install -g siteassets
# Or use npx
npx siteassets check https://example.com
CLI Reference
Command-line interface.
Automate OG tag checks and image generation from your terminal. Perfect for CI/CD pipelines and batch processing.
§02
Authentication
Set your API key as an environment variable or pass it with --api-key:
# Environment variable
export SITEASSETS_API_KEY=your_api_key_here
# Or inline
siteassets generate https://example.com --api-key your_api_key_here
§03
Commands
№01
check
Check OG tags for a URL
siteassets check https://example.com
Options
-f, --format <format> Output format (json, table) default: table --timeout <ms> Request timeout in milliseconds default: 10000 №02
generate
Generate OG image for a URL
siteassets generate https://example.com
Options
-t, --template <template> OG template name default: minimal -o, --output <path> Output file path default: og-image.png --format <format> Image format (png, svg, webp) default: png --api-key <key> SiteAssets API key (or set SITEASSETS_API_KEY env var) №03
bulk check
Check OG tags for multiple URLs
siteassets bulk check urls.txt
Options
-o, --output <path> Output file path default: results.json --timeout <ms> Request timeout in milliseconds default: 10000 №04
bulk generate
Generate OG images for multiple URLs
siteassets bulk generate urls.txt
Options
-t, --template <template> OG template name default: minimal -o, --output <dir> Output directory default: ./og-images --format <format> Image format (png, svg, webp) default: png --api-key <key> SiteAssets API key (or set SITEASSETS_API_KEY env var) §04
Examples
Check a single URL
siteassets check https://example.com
Generate OG image with custom template
siteassets generate https://example.com -t gradient -o my-og.png
Bulk check multiple URLs
# urls.txt contains one URL per line
siteassets bulk check urls.txt -o results.json
Bulk generate and upload
siteassets bulk generate urls.txt -t brand -o ./og-images