Install Edge Kit

Install Edge Kit with Swift Package Manager.

Requirements

Requirement	Version
iOS	17.0 or later
macOS	14.0 or later
Xcode	15 or later
Swift	5.9 or later
Hardware	Apple Silicon

For iOS apps that run larger models, enable the Increased Memory Limit entitlement.

Package

// Package.swift
dependencies: [
    .package(url: "https://github.com/AtomGradient/edge-kit.git", exact: "1.0.0-rc97")
]

Developer Preview releases should be pinned exactly. Re-run your real-device validation before moving to a newer 1.0.0-rcN tag.

Preview access

The Swift package URL is HTTPS for public docs. Some current preview dependency paths can still require AtomGradient preview access or SSH access, especially while Edge Engine remains a pinned transitive dependency. Confirm package resolution before treating a tag as integrated.

Add the umbrella product

.target(
    name: "MyApp",
    dependencies: [
        .product(name: "EdgeKit", package: "edge-kit")
    ]
)

Then import the umbrella module:

import EdgeKit

Add individual modules

Use individual products when you want a narrower dependency surface.

.target(
    name: "MyApp",
    dependencies: [
        .product(name: "EdgeInference", package: "edge-kit"),
        .product(name: "EdgeModelKit", package: "edge-kit")
    ]
)

Common imports:

import EdgeInference
import EdgeModelKit
import EdgeVoice
import EdgeMesh
import EdgeData

Verify installation

import EdgeInference

let engine = LLMEngine()
print(engine.state)

iOS entitlement

For models larger than small preview models, add the Increased Memory Limit entitlement in the app target. Without it, iOS may terminate the process before physical memory is exhausted.