PDF Oxide

https://pdf.oxide.fyi
Admin
PDF Oxide is a complete PDF toolkit built on a Rust core for maximum performance, offering a unified...
Tokens:2,487,997
Snippets:32,004
Trust Score:4.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install via cargo-binstall

Source: https://pdf.oxide.fyi/csharp/docs/getting-started/cli

Install the pre-built binary using cargo-binstall.

```bash
cargo binstall pdf_oxide_cli
```

--------------------------------

### Install PDF Oxide on Windows

Source: https://pdf.oxide.fyi/csharp/docs/getting-started/cli

Use PowerShell to download and execute the installation script.

```powershell
irm oxide.fyi/install.ps1 | iex
```

--------------------------------

### Alternative Installation Methods

Source: https://pdf.oxide.fyi/javascript-wasm/docs/getting-started/mcp

Install the binary directly using Homebrew or Cargo if not using the crgx runner.

```bash
brew install yfedoseev/tap/pdf-oxide
```

```bash
cargo install pdf_oxide_mcp
```

--------------------------------

### Common CLI Usage Examples

Source: https://pdf.oxide.fyi/docs/getting-started/cli

Practical examples for specific PDF processing tasks.

```bash
pdf-oxide markdown report.pdf --pages 1-5 -o report.md
```

```bash
pdf-oxide merge cover.pdf body.pdf appendix.pdf -o combined.pdf
```

```bash
pdf-oxide watermark contract.pdf "DRAFT" --opacity 0.2 --font-size 72
```

```bash
pdf-oxide forms application.pdf --fill "name=Jane Doe,date=2026-02-28" -o filled.pdf
```

```bash
pdf-oxide search paper.pdf "neural.?network" -i
```

```bash
pdf-oxide render report.pdf --dpi 300 --format png --pages 1 -o page1.png
```

```bash
pdf-oxide paths schematic.pdf --format json -o paths.json
```

--------------------------------

### Install pdf_oxide

Source: https://pdf.oxide.fyi/dart/docs/guides/extract-text-from-pdf

Installation commands for different environments.

```bash
pip install pdf_oxide
```

```bash
npm install pdf-oxide-wasm
```

```bash
cargo add pdf_oxide
```

--------------------------------

### Install via Homebrew

Source: https://pdf.oxide.fyi/elixir/docs/getting-started/cli

Install the CLI tool using the Homebrew package manager.

```bash
brew install yfedoseev/tap/pdf-oxide
```

--------------------------------

### Install pdf_oxide

Source: https://pdf.oxide.fyi/dart/docs/guides/xfa-forms

Use pip to install the library package.

```bash
pip install pdf_oxide
```

--------------------------------

### Install PDF Oxide CLI

Source: https://pdf.oxide.fyi/cpp/docs/getting-started/cli

Installation commands for various environments.

```bash
curl -fsSL oxide.fyi/install.sh | sh
```

```powershell
irm oxide.fyi/install.ps1 | iex
```

```bash
brew install yfedoseev/tap/pdf-oxide
```

```bash
cargo install pdf_oxide_cli
```

```bash
cargo binstall pdf_oxide_cli
```

--------------------------------

### Install PDF Oxide

Source: https://pdf.oxide.fyi/clojure/docs/comparison/pymupdf-vs-pypdf

Quick installation command for the PDF Oxide library.

```bash
pip install pdf_oxide
```

--------------------------------

### Install PDF Oxide via Alternative Methods

Source: https://pdf.oxide.fyi/clojure/docs/getting-started/mcp

Install the binary directly using Homebrew or Cargo if not using crgx.

```bash
brew install yfedoseev/tap/pdf-oxide    # includes pdf-oxide-mcp
```

```bash
cargo install pdf_oxide_mcp
```

--------------------------------

### Install PDF Oxide via Package Managers

Source: https://pdf.oxide.fyi/clojure/docs/getting-started/cli

Alternative installation methods using Homebrew or Cargo.

```bash
brew install yfedoseev/tap/pdf-oxide
```

```bash
cargo install pdf_oxide_cli
```

```bash
cargo binstall pdf_oxide_cli
```

--------------------------------

### Install PDF Oxide directly

Source: https://pdf.oxide.fyi/csharp/docs/getting-started/mcp

Alternative installation methods for macOS, Linux, and via Cargo.

```bash
brew install yfedoseev/tap/pdf-oxide
```

```bash
cargo install pdf_oxide_mcp
```

--------------------------------

### Install and Import PDF Oxide

Source: https://pdf.oxide.fyi/clojure/docs/reference/go-api

Commands to install the package and import it into a Go project.

```bash
go get github.com/yfedoseev/pdf_oxide/go
```

```go
import pdfoxide "github.com/yfedoseev/pdf_oxide/go"
```

--------------------------------

### Install PDF Oxide via Homebrew

Source: https://pdf.oxide.fyi/dart/docs/getting-started/mcp

Alternative installation method for macOS and Linux using Homebrew.

```bash
brew install yfedoseev/tap/pdf-oxide    # includes pdf-oxide-mcp
```

--------------------------------

### Install PDF Oxide with purego

Source: https://pdf.oxide.fyi/docs/getting-started/go

Use this command to install the library with the purego backend, suitable for environments where CGO_ENABLED=0.

```bash
go get github.com/yfedoseev/pdf_oxide/go
go run github.com/yfedoseev/pdf_oxide/go/cmd/install@shared
```

--------------------------------

### Install PDF Oxide with CGo

Source: https://pdf.oxide.fyi/docs/getting-started/go

Use this command to install the library with the default CGo backend, which requires a C toolchain.

```bash
go get github.com/yfedoseev/pdf_oxide/go
go run github.com/yfedoseev/pdf_oxide/go/cmd/install@latest
```

--------------------------------

### Advanced CLI Usage Examples

Source: https://pdf.oxide.fyi/clojure/docs/getting-started/cli

Specific examples for merging, watermarking, filling forms, and rendering pages.

```bash
pdf-oxide markdown report.pdf --pages 1-5 -o report.md
```

```bash
pdf-oxide merge cover.pdf body.pdf appendix.pdf -o combined.pdf
```

```bash
pdf-oxide watermark contract.pdf "DRAFT" --opacity 0.2 --font-size 72
```

```bash
pdf-oxide forms application.pdf --fill "name=Jane Doe,date=2026-02-28" -o filled.pdf
```

```bash
pdf-oxide search paper.pdf "neural.?network" -i
```

```bash
pdf-oxide render report.pdf --dpi 300 --format png --pages 1 -o page1.png
```

```bash
pdf-oxide paths schematic.pdf --format json -o paths.json
```

--------------------------------

### Install and Load pdfoxide

Source: https://pdf.oxide.fyi/clojure/docs/reference/r-api

Install the package from source using the R command line and load it into the R session.

```bash
# install from source (requires a C toolchain)
R CMD INSTALL pdfoxide
```

```R
library(pdfoxide)
```

--------------------------------

### Rust PDF Search and Highlight

Source: https://pdf.oxide.fyi/zig/docs/extraction/search

Examples for searching text and applying highlight annotations in Rust.

```rust
let mut pdf = Pdf::open("report.pdf")?;
let results = pdf.search("important")?;
```

```rust
let options = SearchOptions::case_insensitive()
    .with_whole_word(true)
    .with_page_range(0, 5);
let results = pdf.search_with_options("abstract", options)?;
```

```rust
let results = pdf.search_page(0, r"\d+\.\d+")?; // Find decimal numbers
```

```rust
let mut pdf = Pdf::open("report.pdf")?;
let results = pdf.search("important")?;
pdf.highlight_matches(&results, [1.0, 1.0, 0.0])?; // Yellow
pdf.save("highlighted.pdf")?;
```

--------------------------------

### Get PdfPage box dimensions

Source: https://pdf.oxide.fyi/zig/docs/reference/java-api

Retrieves the MediaBox or CropBox for the page.

```java
BBox mediaBox()
```

```java
BBox cropBox()
```

--------------------------------

### Get a specific field value

Source: https://pdf.oxide.fyi/clojure/docs/extraction/forms

Examples showing how to retrieve the value of a specific form field by its name.

```rust
use pdf_oxide::editor::{DocumentEditor, EditableDocument};

let mut editor = DocumentEditor::open("form.pdf")?;

if let Some(value) = editor.get_form_field_value("employee_name")? {
    println!("Name: {:?}", value);
}
```

```python
from pdf_oxide import PdfDocument

doc = PdfDocument("form.pdf")

name = doc.get_form_field_value("employee_name")
ssn = doc.get_form_field_value("ssn")
agreed = doc.get_form_field_value("agree_to_terms")

print(f"Name: {name}")       # "John Doe"
print(f"SSN: {ssn}")         # "123-45-6789"
print(f"Agreed: {agreed}")   # True
```

```javascript
const doc = new WasmPdfDocument(bytes);

const name = doc.getFormFieldValue("employee_name");
const ssn = doc.getFormFieldValue("ssn");
const agreed = doc.getFormFieldValue("agree_to_terms");

console.log(`Name: ${name}`);     // "John Doe"
console.log(`SSN: ${ssn}`);       // "123-45-6789"
console.log(`Agreed: ${agreed}`); // true
```

--------------------------------

### Quick Start: Create and Read PDF

Source: https://pdf.oxide.fyi/docs/getting-started/scala

Demonstrates creating a PDF from Markdown and extracting metadata and text using resource management.

```scala
import fyi.oxide.pdf.{Pdf, PdfDocument, producerOption}
import scala.util.Using

Using.resource(Pdf.fromMarkdown("# Hello pdf_oxide\n\nThis is a **Scala** binding.\n")): pdf =>
  Using.resource(PdfDocument.open(pdf.save())): doc =>
    println(s"pages:    ${doc.pageCount()}")
    println(s"producer: ${doc.producerOption.getOrElse("(none)")}")
    println(doc.extractText(0))
```

--------------------------------

### Complete document generation example

Source: https://pdf.oxide.fyi/clojure/docs/reference/go-api

A full example demonstrating font loading, page creation, element placement, and saving the document.

```go
font, _ := pdfoxide.EmbeddedFontFromFile("DejaVuSans.ttf")
defer font.Close()

builder, _ := pdfoxide.NewDocumentBuilder()
page, _ := builder.LetterPage()
page.Font("Helvetica", 12).
    At(72, 720).Text("Hello").
    Heading(1, "Title").
    Paragraph("Body text with automatic wrapping.").
    LinkURL("https://example.com").
    Highlight(1.0, 1.0, 0.0).
    TextField("name", 150, 400, 200, 20, "Jane Doe").
    Checkbox("agree", 72, 380, 15, 15, true).
    FilledRect(50, 260, 500, 2, 0.9, 0.9, 0.9)
builder, _ = page.Done()
_ = builder.Save("out.pdf")
```

--------------------------------

### Get page labels

Source: https://pdf.oxide.fyi/clojure/docs/reference/python-api

Retrieves page label ranges including style, prefix, and start values.

```python
doc.page_labels() -> list[dict]
```

--------------------------------

### Get PdfPage physical properties

Source: https://pdf.oxide.fyi/zig/docs/reference/java-api

Retrieves the page width, height, and rotation.

```java
double width()
double height()
```

```java
int rotation()
```

--------------------------------

### Complete API Usage Example

Source: https://pdf.oxide.fyi/dart/docs/reference/rust-api

Demonstrates document creation via builders and Markdown, text extraction, editing, and search functionality.

```rust
use pdf_oxide::api::Pdf;
use pdf_oxide::writer::{DocumentBuilder, PageSize};

fn main() -> pdf_oxide::Result<()> {
    // --- Creation (fluent builder) ---
    DocumentBuilder::new()
        .title("Report")
        .author("PDF Oxide")
        .letter_page()
            .heading(1, "Quarterly Report")
            .paragraph("Generated natively in Rust.")
            .link_url("https://pdf.oxide.fyi")
        .done()
        .save("report.pdf")?;

    // --- Creation from Markdown ---
    let mut pdf = Pdf::from_markdown("# Hello\n\nFrom **PDF Oxide**.")?;
    pdf.save("hello.pdf")?;

    // --- Extraction + editing ---
    let mut doc = Pdf::open("input.pdf")?;
    println!("Pages: {}", doc.page_count()?);
    let markdown = doc.to_markdown(0)?;
    println!("{markdown}");

    doc.set_title("Updated Title")?;
    doc.rotate_all_pages(90)?;

    // DOM search and replace
    let mut page = doc.page(0)?;
    for text in page.find_text_containing("DRAFT") {
        page.set_text(text.id(), "FINAL")?;
    }
    doc.save_page(page)?;

    // Search across the document
    let hits = doc.search_with_options(
        "configuration",
        pdf_oxide::search::SearchOptions::case_insensitive(),
    )?;
    println!("Found {} matches", hits.len());

    doc.save("output.pdf")?;
    Ok(())
}
```

--------------------------------

### Install pdf_oxide dependencies

Source: https://pdf.oxide.fyi/clojure/docs/guides/extract-text-from-pdf

Installation commands for different environments.

```bash
pip install pdf_oxide
```

```bash
npm install pdf-oxide-wasm
```

```bash
cargo add pdf_oxide
```

--------------------------------

### Installation

Source: https://pdf.oxide.fyi/swift/docs/reference/php-api

How to install the PDF Oxide PHP package using Composer.

```APIDOC
## Installation

### Command
`composer require oxide/pdf-oxide`
```

--------------------------------

### Creating a Pdf Instance

Source: https://pdf.oxide.fyi/clojure/docs/reference/ruby-api

Initialize a PDF from markdown content.

```ruby
pdf = PdfOxide::Pdf.from_markdown("# Title\n\nBody")
```

--------------------------------

### Install pdf-oxide-wasm package

Source: https://pdf.oxide.fyi/clojure/docs/reference/javascript-wasm-api

Use npm to install the package in your project.

```bash
npm install pdf-oxide-wasm
```

--------------------------------

### Complete PDF Processing Example

Source: https://pdf.oxide.fyi/dart/docs/reference/clojure-api

Demonstrates document creation, text extraction, search, metadata handling, rendering, and redaction.

```clojure
(require '[pdf-oxide.core :as pdf])
(import '[fyi.oxide.pdf.geometry BBox])

;; --- Creation + Extraction ---
(with-open [p (pdf/from-markdown "# Report\n\nGenerated by PDF Oxide.\n")
            d (pdf/open (pdf/save p))]
  (println "Pages:" (pdf/page-count d))
  (println (pdf/extract-text d 0))
  (println (pdf/to-markdown d))
  (println (pdf/to-html d 0))

  ;; Page elements (List -> vector)
  (let [pg (pdf/page d 0)]
    (println "Words:" (count (pdf/words pg)))
    (doseq [w (pdf/words pg)] (print (.text w) "")))

  ;; Search
  (doseq [m (pdf/search d "Report")]
    (println "Match:" (.text m)))

  ;; Metadata (Optional -> nil)
  (println "Producer:" (or (pdf/producer d) "(none)"))

  ;; Render
  (spit "page0.png" (pdf/render d 0 150)))

;; --- Editing + Redaction ---
(with-open [ed (pdf/editor pdf-bytes)]
  (pdf/scrub-metadata ed)
  (pdf/add-redaction ed 0 (BBox. 10.0 10.0 50.0 20.0))
  (pdf/apply-redactions ed)
  (spit "redacted.pdf" (pdf/editor-save ed)))
```

--------------------------------

### Install PDF Oxide gem

Source: https://pdf.oxide.fyi/clojure/docs/reference/ruby-api

Command to install the native Ruby bindings.

```bash
gem install pdf_oxide
```

--------------------------------

### Quick Start in Node.js

Source: https://pdf.oxide.fyi/docs/getting-started/javascript-wasm

Read a PDF file from the filesystem and extract text using the WASM build.

```javascript
import { readFileSync } from "fs";
import { WasmPdfDocument } from "pdf-oxide-wasm";

const bytes = new Uint8Array(readFileSync("document.pdf"));
const doc = new WasmPdfDocument(bytes);

console.log(`Pages: ${doc.pageCount()}`);
console.log(doc.extractText(0));

doc.free();
```

--------------------------------

### Install and Require PDF Oxide

Source: https://pdf.oxide.fyi/elixir/docs/reference/ruby-api

Installation command and the required statement to load the library.

```bash
gem install pdf_oxide
```

```ruby
require 'pdf_oxide'
```

--------------------------------

### Complete PDF Operations Example

Source: https://pdf.oxide.fyi/clojure/docs/reference/elixir-api

Demonstrates common workflows including text extraction, document creation, builder usage, and editing existing files.

```elixir
# --- Extraction ---
{:ok, doc} = PdfOxide.open("input.pdf")
count = PdfOxide.page_count(doc)

text = PdfOxide.extract_text(doc, 0)
{:ok, chars} = PdfOxide.extract_chars(doc, 0)
{:ok, tables} = PdfOxide.extract_tables(doc, 0)

# Search
results = PdfOxide.search_all(doc, "configuration", false)

# --- Creation ---
{:ok, pdf} = PdfOxide.from_markdown("# Report\n\nGenerated by PDF Oxide.")
:ok = PdfOxide.save(pdf, "report.pdf")

# --- Builder ---
{:ok, b} = PdfOxide.builder()
PdfOxide.builder_set_title(b, "Invoice")
{:ok, pb} = PdfOxide.builder_a4_page(b)
PdfOxide.page_font(pb, "Helvetica", 12)
PdfOxide.page_at(pb, 72, 720)
PdfOxide.page_text(pb, "Hello, world")
PdfOxide.page_done(pb)
PdfOxide.builder_save(b, "invoice.pdf")

# --- Editing ---
{:ok, ed} = PdfOxide.open_editor("document.pdf")
PdfOxide.rotate_all_pages(ed, 90)
PdfOxide.set_form_field_value(ed, "name", "John Doe")
PdfOxide.editor_save(ed, "output.pdf")
PdfOxide.editor_close(ed)
```

--------------------------------

### Install and Import PdfOxide

Source: https://pdf.oxide.fyi/cpp/docs/reference/csharp-api

Use the NuGet package manager to install the library and import the core namespace for access to document handles.

```bash
dotnet add package PdfOxide
```

```csharp
using PdfOxide.Core;
```

--------------------------------

### Install via Cargo

Source: https://pdf.oxide.fyi/csharp/docs/getting-started/cli

Install the CLI tool directly from crates.io using Cargo.

```bash
cargo install pdf_oxide_cli
```

--------------------------------

### Install via Homebrew

Source: https://pdf.oxide.fyi/csharp/docs/getting-started/cli

Install using the Homebrew package manager on macOS or Linux.

```bash
brew install yfedoseev/tap/pdf-oxide
```

--------------------------------

### Fetch and compile dependencies

Source: https://pdf.oxide.fyi/docs/getting-started/elixir

Commands to download and build the native NIF components.

```bash
mix deps.get
mix compile
```

--------------------------------

### Install pdf-oxide package

Source: https://pdf.oxide.fyi/clojure/docs/reference/javascript-node-api

Use npm to install the native N-API addon for Node.js.

```bash
npm install pdf-oxide
```

--------------------------------

### Quick Start in Browser

Source: https://pdf.oxide.fyi/docs/getting-started/javascript-wasm

Initialize the WASM module and fetch a PDF document in a browser environment.

```javascript
<script type="module">
import init, { WasmPdfDocument } from "pdf-oxide-wasm";

await init();

const response = await fetch("document.pdf");
const bytes = new Uint8Array(await response.arrayBuffer());
const doc = new WasmPdfDocument(bytes);

console.log(`Pages: ${doc.pageCount()}`);
console.log(doc.extractText(0));
doc.free();
</script>
```

--------------------------------

### Install crgx runner

Source: https://pdf.oxide.fyi/clojure/docs/getting-started/mcp

Use these commands to install the crgx runner for Linux/macOS or Windows.

```bash
curl -fsSL crgx.dev/install.sh | sh
```

```powershell
irm crgx.dev/install.ps1 | iex
```

--------------------------------

### Perform basic PDF operations

Source: https://pdf.oxide.fyi/clojure/docs/getting-started

Demonstrates creating a PDF from Markdown, opening it, and extracting text using with-open for resource management.

```clojure
(require '[pdf-oxide.core :as pdf])

(with-open [p (pdf/from-markdown "# Hello\n\nbody\n")
            d (pdf/open (pdf/save p))]
  (println "pages:   " (pdf/page-count d))
  (println "producer:" (or (pdf/producer d) "(none)"))
  (println (pdf/extract-text d 0)))
```

--------------------------------

### Opening and Initializing Documents

Source: https://pdf.oxide.fyi/dart/docs/reference/zig-api

Methods for creating a Document instance from different sources and freeing the native handle.

```zig
pub fn open(path: [:0]const u8) Error!Document;                                       // open from a filesystem path (NUL-terminated)
pub fn openFromBytes(data: []const u8) Error!Document;                                // open from in-memory bytes
pub fn openWithPassword(path: [:0]const u8, password: [:0]const u8) Error!Document;   // open a password-protected PDF
pub fn openFromDocxBytes(data: []const u8) Error!Document;                            // open a PDF rendered from DOCX bytes
pub fn openFromPptxBytes(data: []const u8) Error!Document;                            // open a PDF rendered from PPTX bytes
pub fn openFromXlsxBytes(data: []const u8) Error!Document;                            // open a PDF rendered from XLSX bytes
pub fn deinit(self: *Document) void;                                                  // free the native handle
```

--------------------------------

### Install crgx on Windows

Source: https://pdf.oxide.fyi/dart/docs/getting-started/mcp

Use this command to install the crgx runner on Windows via PowerShell.

```powershell
irm crgx.dev/install.ps1 | iex
```

--------------------------------

### Install crgx on Linux or macOS

Source: https://pdf.oxide.fyi/dart/docs/getting-started/mcp

Use this command to install the crgx runner on Unix-based systems.

```bash
curl -fsSL crgx.dev/install.sh | sh
```

--------------------------------

### Initialize and manipulate PDF documents

Source: https://pdf.oxide.fyi/clojure/docs/reference/kotlin-api

Demonstrates creating a PDF from Markdown, opening it, and accessing document properties using the Kotlin use block for resource management.

```kotlin
import fyi.oxide.pdf.Pdf
import fyi.oxide.pdf.PdfDocument
import fyi.oxide.pdf.producerOrNull

Pdf.fromMarkdown("# Hello\n\nbody\n").use { pdf ->
    PdfDocument.open(pdf.save()).use { doc ->
        println(doc.pageCount())
        println(doc.extractText(0))
        println(doc.toMarkdown())
        println(doc.page(0).words().map { it.text() })
        println(doc.producerOrNull() ?: "(no producer)")   // Optional -> nullable
    }
}
```

--------------------------------

### Initialize DocumentBuilder

Source: https://pdf.oxide.fyi/clojure/docs/creation/document-builder

Create a new instance of the DocumentBuilder.

```rust
let mut builder = DocumentBuilder::new();
```
Tokens:
Raw