Quick Start

Create an account

Sign up for a free account to get your API key. The free tier includes 1,000 executions per month with full observability.

Install the SDK

Add PipeKitSDK to your project using Swift Package Manager:

See the full installation guide for detailed setup instructions.

Initialize and register a node

Configure PipeKit in your AppDelegate.swift and register your first node with the @Rewire macro:

import UIKit
import PipeKitSDK

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {

        // Replace with your API key from the dashboard
        PipeKit.shared.configure(
            apiKey: "pk_live_xxxxxxxxxxxxxxxx"
        )

        return true
    }
}

// Register a node — this function can be triggered remotely
@Rewire("clear-cache")
func clearCache() async -> NodeResult {
    await CacheManager.shared.purge()
    return .success(["freed": "128MB"])
}

Run your app

Build and run your app. PipeKit immediately starts capturing telemetry — session recordings, console logs, and network requests are all bound to your session automatically. Use your app for a few seconds, then check your dashboard.