Skip to content

michelada/athenapdf-cli

Repository files navigation

athenapdf

The CLI component of athenapdf.

A simple CLI tool to convert HTML to PDF from a local file or a URL to a web page using Electron (Chromium).

It can be used anywhere with Docker installed, even in a headless environment (i.e. no display server).

Features

  • Alternative / drop-in replacement for wkhtmltopdf
  • Uses the latest, stable release of Chromium, and its Blink web rendering engine:
  • Supports local HTML files, and remote URLs
  • Supports writing to standard output: you can take advantage of UNIX piping / redirects
  • Supports rendering in:
    • Landscape or portrait
    • A3, A4, A5, Legal, Letter, and Tabloid page size
  • Adjustable PDF generation delay
  • Adjustable, built-in timeout mechanism
  • Adjustable cache control
  • Adjustable browser zoom settings
  • Adjustable margin sizes
  • Automatically falls back to screen stylesheets if no print stylesheet is defined
  • Aggressive mode: declutter web pages, and improves readability
  • Bypass paywalls for most digital publications with a single -B flag (experimental feature)
  • Dockerized:
    • Easy to set up, distribute, and run
    • Runs in headless mode (the display server is handled for you)
    • Out-of-the-box support for a broad range of foreign characters
  • Actively maintained, and production tested

Quick Start

See docs/quick-start.md.

Development

See docs/development.md.

Building

See docs/building.md.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published