Some test text!

Hamburger Icon

Mac / Guides / Ruby

Ruby & macOS PDF library integration

This guide will help you run Apryse samples and integrate a free trial of the Apryse SDK into Ruby application on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

There are two ways to use Apryse with Ruby:

This guide will help you get started using the precompiled Ruby wrappers.


  • Ruby 2.6+

  • Apryse precompiled Python/Ruby SDK for macOS:

Download the SDK

Run Apryse SDK in production
A commercial license key is required for use in a production environment. Please fill out our licensing form if you do not have a valid license key.
Keep your commercial license key confidential.
License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

  1. Download the Python and Ruby prebuilt binaries.
  2. Extract the downloaded zip file and navigate to it.
  3. Navigate to the /PDFNetC/Lib directory of the Python SDK download and execute:
sh ./
  1. Get your Apryse trial key.

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run the samples

Run a specific sample

  1. Navigate to the RUBY folder in the sample, for example /Samples/RUBY and execute ./

Run all samples

  1. To run all tests, navigate to /Samples and execute the runall_ruby file:

The tests will run one by one.

Output files will be in /Samples/TestFiles/Output

Integrate into your application

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

  1. Navigate to your /Samples directory and make a new directory called myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside myApp called RUBY.

  2. Navigate inside that RUBY folder and create a new Ruby file called myApp.rb. Open it with your favorite text editor and paste this into it:

    require '../../../PDFNetC/Lib/PDFNetRuby'
    include PDFNetRuby
    $stdout.sync = true
      PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")         # PDFNet must be initialized before accessing any Apryse API
      doc =
      page = doc.PageCreate()     # Start a new page
      doc.PagePushBack(page)      # Add the page to the document
      doc.Save("output.pdf", SDFDoc::E_linearized);   # Save the document as a linearized PDF
      puts "Hello World!"

    Run your application by executing ruby myApp.rb. If all goes well, your console should output:

    PDFNet is running in demo mode.
    Permission: write
    Hello World!

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Next step

Guides Samples

Also check out the source for the PDFNetC wrappers.


Check the troubleshooting page and our PDFNetWrappers github if you run into any issues going through this document.

Get the answers you need: Chat with us