Skip to main content
On this page

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.

1

Install the extension

Install the kxbuild toolchain from the install page. Then search for KXBuild in the VS Code Extensions view (Ctrl+Shift+X) and install it. A KXBuild icon appears in the Activity Bar. If you develop in WSL, also install the WSL extension.

The KXBuild view in the Activity Bar
2

Create a project

Run KXBuild: New Project from the Command Palette (Ctrl+Shift+P), pick the "iOS App (SwiftUI)" template, enter a project name and bundle ID, and choose a folder. Open that folder and the KXBuild view shows the project and its targets. To use an existing project, just open its folder. See Create, open and import projects.

Template list in the New Project wizard
3

Add your certificate

Put your .p12 certificate and .mobileprovision profile in a keychain folder, either in the project root or under KXBUILD_HOME. In the same folder, add a password.properties file with one file=password line per certificate. The profile must be a development profile that includes this iPhone's UDID. See Certificates and signing.

development.p12=123456
4

Connect your iPhone

Connect the iPhone to your computer and click it under the Device node in the KXBuild view to make it the active device. The first time, you need to do four things.

  • Install the driver. When the Device node says "click to set up", click it and approve the admin prompt.
  • Trust the computer. Tap Trust when the iPhone asks.
  • Turn on Developer Mode. On the iPhone, go to Settings > Privacy & Security > Developer Mode, turn it on and restart.
  • Wait for device symbols. They download automatically before your first debug session. It's a few GB and takes about ten minutes, but only once.
5

Debug on the device

Set a breakpoint and press F5. KXBuild builds, signs, installs and launches the app, then attaches the debugger. When the breakpoint hits, VS Code switches to the debug view. App output goes to Output > KXBuild Console, and build errors show up in the Problems panel.

The debug view stopped at a breakpoint
6

Build a Release .ipa

Add an Apple Distribution certificate and an App Store provisioning profile to the keychain folder. Use the Build configuration node in the KXBuild view to switch the configuration to Release, then run KXBuild: Build from the Command Palette. The build writes build\MyApp.ipa in the project folder. Upload it to App Store Connect with Transporter or Appuploader. See Release and App Store submission.

Next steps

Project Settings Editor

No need to open project.pbxproj. Change identity, deployment, signing and version on the General page, and view and edit Build Settings by Basic, Customized, All and by level, with resolved values shown live.

Asset Catalog Editor

Create image sets, color sets, symbol sets and app icons, generate every icon size from one 1024 image, set appearance, device and scale for image sets, and use the built-in validation and compile check.