Installation & Setup
How to install the iOS SDK, configure App Groups, and prepare your app lifecycle.
1. Add the Swift Package
The SDK is distributed through Swift Package Manager. Your project must target iOS 18.0+ and Swift 6.1+.
- Open your project in Xcode.
- Select File > Add Packages....
- Enter the package URL:
https://github.com/nx10-devs/ios-sdk.git - Select the latest available version and add it to your main app target.
2. Configure App Groups
App Groups are required when your main app and extensions need to share telemetry. Use the same group identifier in every target that configures the SDK.
Shared Storage Requirement
Add an App Group in each target's Signing & Capabilities tab, for example group.com.yourcompany.app. The value passed asappGroup must match exactly in the host app and any custom keyboard extension.
3. Enable Scenes and Deep Links
Apps using scene delegates still need an UIApplicationSceneManifest entry inInfo.plist. It can be empty when your app delegate supplies the scene configuration at runtime.
ContentView()
.onNX10OpenURL { url in
// Handle the incoming deep link
}4. Adding a Keyboard Extension
Keyboard extensions do not have a scene lifecycle, so they configure the SDK directly from their UIInputViewController. Keep the same API key routing strategy and the same App Group identifier as the main app.