@funbrew/pdf-cli

v1.0.0

Published

2 days ago

CLI for FUNBREW PDF API — generate PDFs from HTML, URLs, Markdown, and templates

0High
0Medium
0Low

taiki14175

pdf cli html-to-pdf markdown-to-pdf funbrew

fbpdf

Command-line tool for the FUNBREW PDF API. Generate PDFs from HTML, URLs, Markdown, and templates — right from your terminal.

Install

npm install -g fbpdf

Quick Start

# Set your API key
fbpdf config set-key YOUR_API_KEY

# Generate a PDF from HTML
fbpdf html "<h1>Hello World</h1>" -o hello.pdf

# Test your connection
fbpdf test

Commands

PDF Generation

# From HTML (string or file)
fbpdf html "<h1>Hello</h1>" -o output.pdf
fbpdf html page.html -o output.pdf

# From URL
fbpdf url https://example.com -o example.pdf

# From Markdown (string or file)
fbpdf markdown README.md -o doc.pdf
fbpdf markdown README.md --theme github -o doc.pdf

# From template
fbpdf template invoice --data '{"name":"John"}' -o invoice.pdf
fbpdf template invoice --data data.json -o invoice.pdf

Common Options

| Flag | Description | |------|-------------| | -o, --output <path> | Save PDF to file (auto-downloads) | | --format <size> | Paper size: A4, Letter, etc. | | --landscape | Landscape orientation | | --header <html> | Header HTML | | --footer <html> | Footer HTML | | --json | Output raw JSON response |

File Operations

fbpdf info <file-id>         # File info
fbpdf download <file-id>     # Download PDF
fbpdf delete <file-id>       # Delete PDF
fbpdf merge id1 id2 id3      # Merge PDFs

Other

fbpdf themes                 # List Markdown themes
fbpdf usage                  # Show API usage
fbpdf test                   # Test API connection

Configuration

# Save API key (stored in ~/.fbpdf/config.json)
fbpdf config set-key YOUR_API_KEY

# Custom base URL (self-hosted)
fbpdf config set-url https://your-server.com

# Show current config
fbpdf config show

You can also use environment variables:

export FUNBREW_API_KEY=your-api-key
export FUNBREW_BASE_URL=https://your-server.com  # optional

Environment variables take precedence over config file.

Examples

# Generate a report and save it
fbpdf html report.html --format A4 --landscape -o report.pdf

# Convert Markdown docs with a theme
fbpdf markdown docs/guide.md --theme github -o guide.pdf

# Quick test with raw JSON output
fbpdf html "<p>test</p>" --json

# Use in scripts
FUNBREW_API_KEY=xxx fbpdf url https://example.com -o page.pdf

License

MIT