PipeKitBeta

Installation

Add PipeKitSDK to your iOS project. Download the framework, drop it into Xcode, and configure one build flag.

Requirements

  • iOS 16.0+
  • Xcode 15.0+
  • Swift 5.9+
  • Apple Silicon Mac (M1 or later) for building

1Download the SDK

Download the latest release containing the XCFramework and the macro binary.

Download PipeKit SDK

Contains PipeKitSDK.xcframework and Macros/PipeKitMacros

2Add the XCFramework

  1. aUnzip the downloaded file
  2. bDrag PipeKitSDK.xcframework into your Xcode project
  3. cIn your target's General → Frameworks, Libraries, and Embedded Content, ensure it's listed with Embed & Sign

3Add the Macro Binary

  1. aCopy the Macros folder from the zip into your project root (next to your .xcodeproj)
  2. bYou should have: YourProject/Macros/PipeKitMacros

The macro binary runs at compile time only — it does not get bundled into your app. Do not add it to any Xcode target.

4Configure the Build Flag

In your app target's Build Settings, find Other Swift Flags (under Swift Compiler — Custom Flags) and add two separate entries using the + button:

Other Swift Flags
-load-plugin-executable
$(SRCROOT)/Macros/PipeKitMacros#PipeKitMacros

These must be two separate lines

Click the + button in Xcode to add each entry individually. If you paste them as a single combined string, you'll get a Driver threw unknown argument error.

5Import and Use

Import PipeKitSDK in any file where you want to use it:

ContentView.swift
import PipeKitSDK


struct ContentView: View {
    @PipeFlag("my-feature") var isEnabled: Bool = false


    var body: some View {
        Text(isEnabled ? "Feature ON" : "Feature OFF")
    }
}

Troubleshooting

Driver threw unknown argument

The two flags are combined into a single string. Open Build Settings → Other Swift Flags and make sure -load-plugin-executable and the path are on separate lines.

No such file or directory

The macro binary is not at the expected path. Verify Macros/PipeKitMacros exists in your project root (the directory containing your .xcodeproj). Also ensure the file has execute permission: chmod +x Macros/PipeKitMacros

plugin for module 'PipeKitMacros' not found

The build flag is missing or incorrect. Double-check that both entries are in Other Swift Flags and the path matches where you placed the binary.

Next: Initialize the SDK

Now that you've installed the SDK, let's configure it in your app.

Continue to Configuration →