Skip to main content

​
Overview

The Encore SDK is distributed as a private Swift Package. You’ll receive a GitHub Personal Access Token from the Encore Dashboard to authenticate and install the package.

​
Prerequisites: Obtain Access Credentials

Before installing the SDK, you need to obtain your access credentials from the Encore Dashboard.
Don’t have credentials? Visit dashboard.encorekit.com to create an account, add your app, and receive your SDK access credentials automatically.
You’ll need the following:
  • Access Token: A GitHub Personal Access Token (starts with ghp_...) provided through the Dashboard
  • Authenticated Repository URL:
https://{YOUR_ACCESS_TOKEN}@github.com/EncoreKit/ios-sdk
Replace {YOUR_ACCESS_TOKEN} with the GitHub Personal Access Token (starts with ghp_...) provided through your Dashboard.

​
Install via Swift Package Manager

Swift Package Manager is Apple’s official dependency manager integrated into Xcode.

​
Step 1: Add Package in Xcode

  1. In Xcode, select File ▸ Add Packages Dependencies…
  2. Paste your authenticated repository URL (with your token embedded):
https://{YOUR_ACCESS_TOKEN}@github.com/EncoreKit/ios-sdk
  1. Press Return or click the search icon. The package should resolve automatically.

​
Step 2: Configure Dependency

With the ios-sdk package selected:
  1. Set Dependency Rule to Up to Next Major Version
  2. Set the lower bound to 1.0.0
  3. Make sure your project is selected in Add to Project
  4. Click Add Package

​
Step 3: Add to Target

After the package resolves:
  1. Ensure Add to Target is set to your app’s name
  2. Click Add Package

​
Step 4: Verify Installation

You should now be able to import the SDK: 
import Encore
✅ Installation complete!

​
Next Steps

Now that the SDK is installed, continue with the integration: For advanced features and complete API documentation, see the SDK Reference.

​
Advanced Topics

To update to the latest version:
  1. In Xcode’s left sidebar, expand Package Dependencies
  2. Find and right-click the Encore package
  3. Select Update Package
Alternatively, select File ▸ Packages ▸ Update to Latest Package Versions to update all packages at once, including Encore.