Before we start..
Primordial is in alpha and under active development. The current SDK build supports Apple devices first, and we are using this phase to harden the developer experience, licensing flow, and local AI runtime before adding more platforms.
Even if the SDK is not ready for everything you need yet, we recommend
signing up now. We are actively building it and will
keep registered developers updated as features land. You can also join our
Discord channel.
Wonder what are the possibilities with Primordial SDK? Check out our Itsanote!
Note:
Licenses are coming soon. You can still sign up for a developer account and generate evaluation keys to try the SDK.
Requirements
- Xcode 26.0+
- Swift 6.2+
- iOS 26.0+
Install
- Open your app project in Xcode.
- Select
File > Add Package Dependencies. - Add the repository URL shared with you.
- Pin the exact alpha tag or commit.
- Add the
Primordialproduct to your app target.
git@github.com:fairymeadowslab/primordial-apple.git
Import only Primordial in your app. With Primordial SDK,
you do not need to add separate engine or runtime packages.
Quickstart
The quickstart does not require an account or key. Use it to verify package resolution, module import, and platform status.
import Primordial
try Primordial.checkIntegration()
Keys For Testing, Licenses For Distribution
Once the SDK is installed and the quickstart runs successfully, you are ready to try real features like model use, voice, or device testing. Create a developer account to generate an evaluation key for development and testing. When you are ready to share or release your app, generate a production license.
How your access to SDK works
Quickstart
Install the package, import the module, and run the integration check. No account or key required.
Develop and test
Create an evaluation key for Debug builds, device testing, model loading, voice, and benchmarks.
Distribute apps
Bundle a signed offline license before releasing a mobile app to testers or users.
Why You Need Keys And Licenses
Primordial is still young, and we are adding new features every day. By creating a developer account, you stay connected with us and can hear about exciting updates as the SDK grows.
Evaluation keys help Fairy Meadows Lab understand which developers are trying the SDK, what they are building, and where the product is actually useful.
Licenses make it possible for you to ship offline, private AI inside your app while letting the SDK validate access without an internet connection. That keeps our promise of privacy and offline-first apps intact, while still giving us a fair way to support the SDK and keep building for the teams who depend on it.
We do not track production usage in real time. We only know what you share when you create evaluation keys and licenses, such as your app name, platform, intended use case, and registered app ID.
The goal is not to make trying Primordial hard. The goal is to learn from real developers early, protect production usage, and keep the SDK sustainable.