# localpdf

> A CLI tool to convert HTML to PDF in Root Platform's format.

Latest version **1.0.1** (published 2020-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install localpdf
pnpm add localpdf
yarn add localpdf
bun add localpdf
```

Provides the command `localpdf`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-11-11 |
| First published | 2020-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Louw Hopley |
| Maintainers | andre.mocke.root, louwhopley |

## Links

- npm: https://www.npmjs.com/package/localpdf
- npm.io page: https://npm.io/package/localpdf

## Dependencies (1)

- [wkhtmltopdf](https://npm.io/package/wkhtmltopdf.md) ^0.3.4

## Recent versions

- 1.0.1 (latest) — 2020-11-11
- 1.0.0 — 2020-11-11

## README

# LocalPDF

A CLI tool to build [Root](https://root.co.za) compatible PDF documents locally.

## Usage

1. Install wkhtmltopdf locally on your machine: [download](https://wkhtmltopdf.org/downloads.html#stable)
2. Install localPDF `npm install localpdf -g`
3. Run it in the folder with your html file `localpdf myfile.html myoutputfile.pdf`

```
Usage: localpdf [input_file] [output_file]
Arguments:
  > input_file   required  Path to input HTML file
  > output_file  optional  Path to output PDF file
```

## Development

### Installation

1. Install wkhtmltopdf locally on your machine: [download](https://wkhtmltopdf.org/downloads.html#stable)
2. Clone this repo: `git clone ...`
3. Install the dependencies: `cd localpdf` and `npm install`

[todo: add this to npm registry and allow direct usage]

### Usage

After you've installed this repo, you can convert files to PDF using the following command (make sure you've `cd`'d into the repo folder)

`node index.js`

---
_Source: https://npm.io/package/localpdf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._