KXBuild docs

New here? Start with one of the two Get started tutorials. Each takes you from install to the App Store. After that, look up what you need in Common tasks. For details on every extension feature and every command, go to IDE or CLI in the top bar.

Get started

Two tutorials with matching steps. Read the first if you use the VS Code extension, and the second if you work in the terminal or set up CI.

Get started with the KXBuild IDE

Use the KXBuild VS Code extension to go through the whole iOS workflow on Windows. Create a project, add your certificate, debug on your iPhone and build a Release .ipa. Linux and macOS work the same way.

VS Code · F5 Read

Get started with KXBuild

Go through the whole iOS workflow on Windows using only the terminal. Create a project, add your certificate, install and debug on your iPhone and build a Release .ipa. Linux and macOS work the same way.

kxbuild · kxdevice Read

Common tasks

How to get one thing done, whichever tool you use. Each guide shows the IDE way and the command-line way side by side.

iOS SDK

Download the two archives iPhoneOS.platform.zip and toolchain.zip, put them in sharedcomponents and run kxbuild doctor.

sharedcomponents/ · kxbuild doctor Read

Project templates

The 11 built-in templates for new projects, how a template folder is structured, and how to add your own. The VS Code wizard and the CLI use the same templates.

resources/templates/ Read

Build and configure

Debug versus Release, choosing a scheme, target and configuration, overriding build settings, where build products go, when you get an .ipa and when Swift package dependencies resolve.

Build · kxbuild build Read

Release and App Store submission

Build Release with a Distribution certificate to get an .ipa, upload it to App Store Connect with Transporter or Appuploader, then go through TestFlight and App Review. Ad Hoc and enterprise distribution work the same way.

Release · Transporter / Appuploader Read

Troubleshooting

Run kxbuild doctor first. Then look up your error message by category: install, project, signing, device, release or extension. Also covers where to find the logs.

kxbuild doctor Read

Performance profiling

Profile without Instruments. kxdevice records CPU, memory allocations, network, energy, dropped frames and call stacks straight from your iPhone, from the command line or a web UI.

kxdevice instruments Read

Certificates and signing

You can build without a certificate, but you can't install on a device. Put your .p12 and .mobileprovision in the keychain folder and every build signs automatically. Also covers choosing a certificate in the project and overriding it on the command line.

keychain/ folder Read

Set up your device

Get your computer to recognize your iPhone. Install the driver, trust the computer and turn on Developer Mode, download device symbols before your first debug session, and choose between multiple devices.

Diagnose Devices · kxdevice doctor Read

Need to install apps, read logs, transfer files or profile from the terminal? kxdevice command reference

Installer not working, or want to pick each component's version and location yourself? Install manually