Optimizely will be sunsetting Full Stack Experimentation on July 29, 2024. See the recommended Feature Experimentation migration timeline and documentation.

Dev GuideAPI ReferenceUser Guide
Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySumbit a ticketLog In
GitHubNuGetDev CommunitySumbit a ticket

Install SDK

This topic describes the steps necessary to install the Optimizely Swift SDK.

Suggest Edits

The Optimizely Swift SDK is written completely in Swift and uses all of its native types and patterns. It is available for distribution through CocoaPods, Carthage, or Swift Package Manager (SPM).

You can use this SDK with apps written in Swift and Objective-C.

📘

Note

If you are currently using our Objective-C SDK, here is a guide to help you migrate to our newer Swift SDK.

Requirements

  • Swift client applications must use Swift 5 or higher.
  • Minimum OS version supported is iOS 10.0, tvOS 10.0, and watchOS 3.0.

CocoaPods

  1. Add this line to the Podfile:
pod 'OptimizelySwiftSDK','~> 3.2.1'
  1. Run the command:
pod install

For more installation information, see the CocoaPods Getting Started Guide.

Carthage

  1. Add this line to the Cartfile:
github "optimizely/swift-sdk" ~> "3.2.1"
  1. Run the command:
carthage update
  1. Link the frameworks to your project.
    Go to your project target's Link Binary With Libraries and drag over these frameworks from the Carthage/Build/ folder:
Optimizely.framework
  1. To ensure that proper bitcode-related files and dSYMs are copied when archiving your app, you must install a Carthage build script:
    a. Add a new Run Script phase in your target's Build Phase.
    b. Include this line in the script area:
    /usr/local/bin/carthage copy-frameworks
    c. Add the frameworks to the Input Files list: $(SRCROOT)/Carthage/Build/<platform>/Optimizely.framework
    d. Add the paths to the copied frameworks to the Output Files list:
    $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/Optimizely.framework

For more installation information, see the Carthage GitHub repository.

Swift Package Manager (SPM)

Add the following line to the dependencies value of your Package.swift:

dependencies: [
    .package(url: "https://github.com/optimizely/swift-sdk.git", .upToNextMinor(from: “3.2.1”))
]

If you have a name conflict with other swift packages when you add the Optimizely swift-sdk dependency to Xcode, you can also try with its aliased repo: https://github.com/optimizely/optimizely-swift-sdk.git.

📘

Note

  • All public types start with the Optimizely prefix for clarity.
  • This release includes a wrapper for all public APIs to support Objective-C client applications. See the demo Swift app on GitHub.

Updated 5 months ago