Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@tongorender/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@tongorender/cli
TongoRender CLI — convert HTML to PDF, images, and screenshots from your terminal.
Install
npm install -g @tongorender/cliQuick Start
# Authenticate
tongo login
# HTML to PDF
tongo render pdf invoice.html --output invoice.pdf
# Pipe HTML from stdin
echo '<h1>Hello</h1>' | tongo render pdf - --output hello.pdf
# HTML to Image
tongo render image page.html --format png --output page.png
# Screenshot a URL
tongo render screenshot https://example.com --output shot.png
# Check render status
tongo render status <job-id>Commands
Authentication
| Command | Description |
|---|---|
tongo login |
Authenticate with email/password or API key |
tongo logout |
Clear stored credentials |
tongo whoami |
Show current user and plan info |
Rendering
| Command | Description |
|---|---|
tongo render pdf <file> |
Render HTML to PDF |
tongo render image <file> |
Render HTML to image (PNG/JPEG/WebP) |
tongo render screenshot <url> |
Screenshot a live URL |
tongo render status <id> |
Check render job status |
Templates
| Command | Description |
|---|---|
tongo templates list |
Browse available templates |
tongo templates render <slug> |
Render template with JSON data |
API Keys
| Command | Description |
|---|---|
tongo keys list |
List your API keys |
tongo keys create |
Create a new API key |
tongo keys revoke <id> |
Revoke an API key |
Usage & Config
| Command | Description |
|---|---|
tongo usage |
View usage stats |
tongo config set <key> <val> |
Set a config value |
tongo config get <key> |
Get a config value |
Global Flags
| Flag | Description |
|---|---|
--json |
Output as JSON |
--output <path> |
Save result to file |
--no-wait |
Don't wait for render completion |
--help |
Show help for any command |
--version |
Show CLI version |
Requirements
- Node.js >= 18.0.0
License
MIT