PDF command-line utils written in Rust

Jérome Eertmans

Last update: May 9, 2023

Related tags

PDF Files Processing rpdf

Overview

rpdf

PDF command-line utils written in Rust.

rpdf makes working with PDF annotions super easy! It can merge annotations from multiple files, some show statistics (stats) or strip specific (or all) annotations.

About
CLI Reference
Contributing

About

rpdf is a Rust binary that aims to provides an open source and straighforward command-line alternative to other tools such as PDF Annotator and others.

Disclaimer: rpdf is currently in an early stage, and does not implement many features. I was first developed for my own use, because I needed to merge annotations from PDFs I review with other people. Do not hesitate to propose new features if you feel they could be intersting!

Installation

You can install the latest version with cargo.

> cargo install rpdf

CLI Reference

The command line tool is pretty straighforward to use and is self-documented:

Anytime you need help for a command, you can use rpdf <COMMAND> --help, or -h for the short version.

Examples

Annotations statistics

You can count how many annotations your file contains:

And you can also do this per page:

Merge annotations

Say we have to files with the same content but different annotations:

You can merge the annotations from both files into one with the merge command, and verify that all the annotations are present in the final product:

Strip annotations

If you want to remove some annotations from a PDF, you can do so with the strip command:

By default, strip excludes Link annotations from the removal process. You can modifiy the behavior with the -e/--exclude parameter.

Contributing

Contributions are more than welcome! Please reach me via GitHub for any questions: Issues, Pull requests or Discussions.

Comments

chore(deps): bump anyhow from 1.0.70 to 1.0.71
Bumps anyhow from 1.0.70 to 1.0.71.

Release notes

Sourced from anyhow's releases.

1.0.71

Documentation improvements

Commits

8b4fc43 Release 1.0.71

3c33b4b Merge pull request #306 from dtolnay/noinline

d491b88 Mark format_err macro as doc(no_inline)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
chore(deps): bump baptiste0928/cargo-install from 1 to 2
Bumps baptiste0928/cargo-install from 1 to 2.

Release notes

Sourced from baptiste0928/cargo-install's releases.

v2.0.0

:sparkles: New major release. This new version should remove the warning about Node 12 being deprecated, along with some improvements to the default behaviour. I also rewrote and improved most of the code.

Added

Name and version are shown in the cache key. This allows to identify cache entries in the cache management UI more easily.

Changed

Breaking: The action now runs on Node.js 16.

Breaking: Versions without semver range (e.g. 1.2.3) are now considered as exact versions.

Breaking: Set --locked by default. locked input is no longer deprecated.

Various code improvements and refactoring.

v1.3.1

Fixed

Use semver instead of compare-versions to fix version resolution issues.

Dependencies have been updated. This removes the warning about set-output being deprecated.

v1.3.0

Added

Add args input to add additional arguments to the cargo install command.

Deprecated

locked input is deprecated, use the args input with --locked instead.

v1.2.0

Added

Add locked input to add --locked argument to cargo install command.

Changed

Dependencies have been updated.

v1.1.0

Added

Add cache-key input to add a custom key to the automatic cache key.

v1.0.1

Fixed

Errors when saving cache no longer cause the workflow to fail.

Changelog

Sourced from baptiste0928/cargo-install's changelog.

[2.0.0] - 2023-03-23

Added

Name and version are shown in the cache key. This allow to identify cache entries in the cache management UI more easily.

Changed

Breaking: The action now runs on Node.js 16.

Breaking: Versions without semver range (e.g. 1.2.3) are now considered as exact versions.

Breaking: Set --locked by default. locked input is no longer deprecated.

Various code improvements and refactoring.

Commits

48c92f3 docs: update changelog link

b930757 chore: release 2.0.0

a5ed085 docs: improve readme

4a97b38 feat: set locked by default

fbee928 feat: replace ncc with esbuild

f6bf54d refactor: rewrite and improve code (#12)

182c00e chore: fix changelog link

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
chore(deps): bump actions/checkout from 1 to 3
Bumps actions/checkout from 1 to 3.

Release notes

Sourced from actions/checkout's releases.

v3.0.0

Updated to the node16 runtime by default

This requires a minimum Actions Runner version of v2.285.0 to run, which is by default available in GHES 3.4 or later.

v2.7.0

What's Changed

Add new public key for known_hosts (#1237) by @TingluoHuang in actions/checkout#1238

Full Changelog: https://github.com/actions/checkout/compare/v2.6.0...v2.7.0

v2.6.0

What's Changed

Add backports to v2 branch by @cory-miller in actions/checkout#1040

Includes backports from the following changes: actions/checkout#964, actions/checkout#1002, actions/checkout#1029

Upgraded the licensed version to match what is used in v3.

Full Changelog: https://github.com/actions/checkout/compare/v2.5.0...v2.6.0

v2.5.0

What's Changed

Update @actions/core to 1.10.0 by @rentziass in actions/checkout#962

Full Changelog: https://github.com/actions/checkout/compare/v2...v2.5.0

v2.4.2

What's Changed

Add set-safe-directory input to allow customers to take control. (#770) by @TingluoHuang in actions/checkout#776

Prepare changelog for v2.4.2. by @TingluoHuang in actions/checkout#778

Full Changelog: https://github.com/actions/checkout/compare/v2...v2.4.2

v2.4.1

Fixed an issue where checkout failed to run in container jobs due to the new git setting safe.directory

v2.4.0

Convert SSH URLs like org-<ORG_ID>@github.com: to https://github.com/ - pr

v2.3.5

Update dependencies

v2.3.4

Add missing awaits

Swap to Environment Files

v2.3.3

Remove Unneeded commit information from build logs

Add Licensed to verify third party dependencies

... (truncated)

Changelog

Sourced from actions/checkout's changelog.

Changelog

v3.5.2

Fix api endpoint for GHES

v3.5.1

Fix slow checkout on Windows

v3.5.0

Add new public key for known_hosts

v3.4.0

Upgrade codeql actions to v2

Upgrade dependencies

Upgrade @actions/io

v3.3.0

Implement branch list using callbacks from exec function

Add in explicit reference to private checkout options

[Fix comment typos (that got added in #770)](actions/checkout#1057)

v3.2.0

Add GitHub Action to perform release

Fix status badge

Replace datadog/squid with ubuntu/squid Docker image

Wrap pipeline commands for submoduleForeach in quotes

Update @actions/io to 1.1.2

Upgrading version to 3.2.0

v3.1.0

Use @actions/core saveState and getState

Add github-server-url input

v3.0.2

Add input set-safe-directory

v3.0.1

Fixed an issue where checkout failed to run in container jobs due to the new git setting safe.directory

Bumped various npm package versions

v3.0.0

Update to node 16

v2.3.1

Fix default branch resolution for .wiki and when using SSH

v2.3.0

... (truncated)

Commits

8e5e7e5 Release v3.5.2 (#1291)

eb35239 Fix: convert baseUrl to serverApiUrl 'formatted' (#1289)

83b7061 Release v3.5.1 (#1284)

40a16eb Improve checkout performance on Windows runners by upgrading @actions/github ...

8f4b7f8 Add new public key for known_hosts (#1237)

cd6a9fd Update update-main-version.yml

24cb908 Bump @actions/io to v1.1.3 (#1225)

27135e3 Upgrade dependencies (#1210)

7b18718 Upgrade codeql actions to v2 (#1209)

ac59398 Fix comment typos (that got added in #770) (#1057)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
[pre-commit.ci] pre-commit autoupdate
updates:

github.com/macisamuele/language-formatters-pre-commit-hooks: v2.7.0 → v2.8.0

github.com/igorshubovych/markdownlint-cli: v0.33.0 → v0.34.0
opened by pre-commit-ci[bot] 0
chore(deps): bump clap from 4.2.5 to 4.2.7
Bumps clap from 4.2.5 to 4.2.7.

Release notes

Sourced from clap's releases.

v4.2.7

[4.2.7] - 2023-05-02

Fixes

Correctly track remaining length for iterators provided by ArgMatches

v4.2.6

[4.2.6] - 2023-05-02

Features

impl Eq<std::any::TypeId> for clap_builder::util::AnyValueId

Changelog

Sourced from clap's changelog.

[4.2.7] - 2023-05-02

Fixes

Correctly track remaining length for iterators provided by ArgMatches

[4.2.6] - 2023-05-02

Features

impl Eq<std::any::TypeId> for clap_builder::util::AnyValueId

Commits

baaf5c6 chore: Release

1e0d76b docs: Update changelog

7b40f43 Merge pull request #4875 from epage/panic

937f1ed fix(parser): Update iterator sizes as we go

a721454 chore: Release

4fec577 docs: Update changelog

a2131ae Merge pull request #4873 from Molkars/master

be88567 docs(ref): Fix feature name

3750774 impl Eq<std::any::TypeId> for clap_builder::util::AnyValueId

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0

Owner

Jérome Eertmans

PhD student, with a Master in Electromechanical Engineering

GitHub

Generating PDF files in pure Rust

pdf-canvas A pure rust library for generating PDF files. Currently, simple vector graphics and text set in the 14 built-in fonts are supported. To use

128 Jan 1, 2023

An easy-to-use library for writing PDF in Rust

printpdf printpdf is a library designed for creating printable PDF documents. Crates.io | Documentation [dependencies] printpdf = "0.3.2" Features Cur

592 Jan 8, 2023

A Rust library for PDF document manipulation.

lopdf A Rust library for PDF document manipulation. Example Code Create PDF document #[macro_use] extern crate lopdf; use lopdf::{Document, Object, St

1.1k Dec 30, 2022

Generate PDF files with JavaScript and WASM (WebAssembly)

WASM-PDF Generates PDF files directly in the browser with JavaScript and WASM (WebAssembly). Idea here is to push all the work involved in creating a

369 Jan 2, 2023

docx-you-want is a tool to convert a PDF document into a .docx file

ddocx-you-want is a tool to convert a PDF document into a .docx file ... in an unusual way. Since these two formats are inherently differ

45 Dec 23, 2022

PDF Structure Viewer, This tool is useful for when working with PDFs and/or lopdf.

PDF Structure Viewer Inspect how the PDF's structure looks. This tool is useful for when working with PDFs and/or lopdf. This application is used lopd

13 Nov 21, 2022

Image cropper (and colorizer) for pdf scans

Image cropper for personal use (might not work with your pdfs) Requires pdfimages on the path to work properly It's thought just for my workflow so is

2 Nov 7, 2022

Make a PDF file by writing kind of like HTML and CSS.

markup-pdf-rs The Rust library for making a PDF files by writing kind of like HTML and CSS. Inspired by Satori and React-pdf. This library makes a PDF

9 Jan 10, 2023

interactcli-rs is a command-line program framework used to solve the problem of the integration of command-line and interactive modes, including functions such as unification of command-line interactive modes and sub-command prompts. The framework integrates clap and shellwords.

interactcli-rs 简体中文 interactcli-rs is a command-line program framework used to solve the problem of the integration of command-line and interactive mo

12 Nov 5, 2022

PDF command-line utils written in Rust

Related tags

Overview

rpdf

About

Installation

CLI Reference

Examples

Annotations statistics

Merge annotations

Strip annotations

Contributing

Comments

chore(deps): bump anyhow from 1.0.70 to 1.0.71

1.0.71

chore(deps): bump baptiste0928/cargo-install from 1 to 2

v2.0.0

Added

Changed

v1.3.1

Fixed

v1.3.0

Added

Deprecated

v1.2.0

Added

Changed

v1.1.0

Added

v1.0.1

Fixed

[2.0.0] - 2023-03-23

Added

Changed

chore(deps): bump actions/checkout from 1 to 3

v3.0.0

v2.7.0

What's Changed

v2.6.0

What's Changed

v2.5.0

What's Changed

v2.4.2

What's Changed

v2.4.1

v2.4.0

v2.3.5

v2.3.4

v2.3.3

Changelog

v3.5.2

v3.5.1

v3.5.0

v3.4.0

v3.3.0

v3.2.0

v3.1.0

v3.0.2

v3.0.1

v3.0.0

v2.3.1

v2.3.0

[pre-commit.ci] pre-commit autoupdate

chore(deps): bump clap from 4.2.5 to 4.2.7

v4.2.7

[4.2.7] - 2023-05-02

Fixes

v4.2.6

[4.2.6] - 2023-05-02

Features

[4.2.7] - 2023-05-02

Fixes

[4.2.6] - 2023-05-02

Features

Owner

Jérome Eertmans

Generating PDF files in pure Rust

An easy-to-use library for writing PDF in Rust

A Rust library for PDF document manipulation.

Generate PDF files with JavaScript and WASM (WebAssembly)