Integrating PSPDFKit Using Carthage
ℹ️ Note: Using Carthage may result in errors saying “Incompatible Swift version - framework was built ...” when using an Xcode version different from what PSPDFKit was built with. If you see this error, or if you need Mac Catalyst support, you can work around this harmless warning by switching to the Xcode version we built the release with, or use the manual integration.
PSPDFKit is available via Carthage. If you’re new to Carthage, check out the documentation first.
- Get Carthage via
brew install carthage(this requires Homebrew to be installed)
- Create a Cartfile in the same directory where your .xcodeproj or .xcworkspace is
- Add PSPDFKit as dependency to this Cartfile:
- If successful, a
Cartfile.resolvedfile and a
Carthagedirectory will appear in the same directory as your Xcode project.
- Drag the binaries from Carthage/Build/
into your application’s Xcode project.
Depending on how you use Carthage, you might require additional steps,as listed on their Quick Start guide.
- Please don’t follow our manual integration guide if you’re using Carthage. Do not use
strip-framework.shor other scripts, as they are not necessary when using Carthage and will prevent your project from working.
- Please make sure you have Carthage version >= 0.19 installed. You can check your Carthage version with
- Nightly builds are currently not supported in Carthage.
PSPDFKit is a commercial framework. As such, you get a unique Carthage URL specific to your license or trial. You can find your Carthage URL in our customer portal by choosing the Use Carthage tab when downloading PSPDFKit. If you are currently evaluating PSPDFKit, you first need a trial license, which you can obtain by clicking on the trial button on our website. Follow the instructions in the email to get the URL specific to your trial. To purchase a license, please contact our sales team.
Below you will find more information on what you have to add to your
Cartfile (Carthage URLs use the same secret key as CocoaPods).
Use the Version Compatible With:
binary "https://customers.pspdfkit.com/pspdfkit-ios.json" ~> 9.3
Using the above Carthage will download a PSPDFKit version compatible with 9.3. Compatibility is determined according to Semantic Versioning. This means that any version greater than or equal to 9.0, but less than 7.0, will be considered compatible with 9.3.
Use a Specific Version:
binary "https://customers.pspdfkit.com/pspdfkit-ios.json" == 9.3.1
Using the above Carthage will download PSPDFKit version 9.3.1.
Use the Latest Version:
Using the above Carthage will download the latest PSPDFKit version.
Follow the instructions in the Carthage documentation to finish the integration.