@alexberriman/screenshotter v0.1.1

📸 Screenshotter CLI

A fast, reliable command-line tool for taking screenshots of websites. Built with TypeScript and Playwright, designed for automation and CI/CD environments.

Features

• 🚀 Fast & Reliable - Built on Playwright for consistent results
• 🖼️ Multiple Formats - Support for PNG and JPEG with quality settings
• 📐 Viewport Control - Preset sizes or custom dimensions
• ⏱️ Wait Strategies - Network idle, custom selectors, or fixed delays
• 🎯 Full Page Capture - Capture entire pages or just the viewport
• 🔧 Template Support - Dynamic filename generation with placeholders
• 🌐 Headless Operation - Perfect for servers and automation

Installation

npm install -g @alexberriman/screenshotter

Or run directly with Bun:

bun install
bun run build
bun ./dist/index.js https://example.com

Or use Docker:

docker pull alexberriman/screenshotter:latest
docker run -v $(pwd):/output alexberriman/screenshotter:latest https://example.com -o /output/screenshot.png

Usage

npx @alexberriman/screenshotter <url> [options]

Basic Examples

Take a full-page screenshot with default settings:

npx @alexberriman/screenshotter https://example.com

Capture with specific output path:

npx @alexberriman/screenshotter https://example.com -o ./screenshots/homepage.png

Use mobile viewport:

npx @alexberriman/screenshotter https://example.com -v mobile

Advanced Examples

Capture JPEG with custom quality:

npx @alexberriman/screenshotter https://example.com --format jpeg --quality 90

Wait for specific element before capturing:

npx @alexberriman/screenshotter https://example.com --wait-for ".content-loaded"

Use filename template with placeholders:

npx @alexberriman/screenshotter https://example.com --template "{domain}-{date}-{time}.{format}"

Combined options:

npx @alexberriman/screenshotter https://example.com \
  -v tablet \
  --format jpeg \
  --quality 85 \
  -w 2 \
  --wait-for "#main-content" \
  --template "screenshots/{domain}/{date}-{time}.{format}"

All Options

Viewport Presets

• desktop: 1920x1080
• tablet: 768x1024
• mobile: 375x667
• Custom: Any WIDTHxHEIGHT format (e.g., 1280x720)

Template Placeholders

• {timestamp}: ISO timestamp with safe characters
• {date}: Current date (YYYY-MM-DD)
• {time}: Current time (HH-MM-SS)
• {domain}: URL domain with dots replaced by underscores
• {format}: File format (png or jpeg)

Exit Codes

• 0: Success
• 1: Error (invalid options, timeout, network failure, etc.)

Automation Examples

CI/CD Pipeline

# GitHub Actions example
- name: Take screenshot
  run: npx @alexberriman/screenshotter https://myapp.com -o artifacts/screenshot.png

Batch Processing

#!/bin/bash
urls=("https://example.com" "https://google.com" "https://github.com")

for url in "${urls[@]}"; do
  npx @alexberriman/screenshotter "$url" --template "screenshots/{domain}-{date}.png"
done

Error Handling

if npx @alexberriman/screenshotter https://example.com -o screenshot.png; then
  echo "Screenshot saved successfully"
else
  echo "Failed to capture screenshot"
  exit 1
fi

Docker Usage

Building the Docker Image

# Build the image locally
npm run docker:build

# Or use docker directly
docker build -t screenshotter:latest .

Running with Docker

# Basic usage - output to current directory
docker run --rm -v $(pwd):/output screenshotter:latest https://example.com -o /output/screenshot.png

# With custom viewport
docker run --rm -v $(pwd):/output screenshotter:latest https://example.com -v mobile -o /output/mobile.png

# Using docker-compose
docker-compose run screenshotter https://example.com -o /output/screenshot.png

Docker-Compose Configuration

The included docker-compose.yml provides a convenient way to run the screenshotter:

# docker-compose.yml
services:
  screenshotter:
    build: .
    volumes:
      - ./screenshots:/output

Volume Mounting

When using Docker, you need to mount a volume to access the generated screenshots:

# Mount current directory
docker run -v $(pwd):/output screenshotter:latest https://example.com -o /output/shot.png

# Mount specific directory
docker run -v /home/user/screenshots:/output screenshotter:latest https://example.com -o /output/shot.png

Development

# Clone the repository
git clone https://github.com/yourusername/screenshotter.git
cd screenshotter

# Install dependencies
bun install

# Run in development
bun run dev

# Run tests
npm run test

# Type check
bun run typecheck

# Lint code
bun run lint

# Build for production
bun run build

Requirements

• Node.js 18+ or Bun
• Playwright (automatically installed)

Contributing

Pull requests are welcome! Please ensure:

1. All tests pass
2. Code follows the existing style
3. Commit messages follow conventional commits
4. No linting or type errors

License

MIT © Alex Berriman