Install the extension and toolchain
Install from the Marketplace, from a VSIX or in WSL, point the extension at your toolchain, see when auto-update and doctor run, and find the walkthrough.
Install the extension
The extension needs the kxbuild toolchain, so install that first from the install page. If the extension can't find a toolchain at startup, the KXBuild view shows two buttons, "Install KXBuild" and "Locate Installation…".
| Method | Steps |
|---|---|
| Marketplace | Search for KXBuild in the Extensions view (Ctrl+Shift+X) and install it. Updates arrive automatically. |
| Local VSIX | Drag the .vsix file into the editor window and restart VS Code. Use this on offline machines. |
| WSL | Install the WSL extension, open the project from an Ubuntu terminal with code ., then install the KXBuild extension on the WSL side from the Extensions view. |
Flutter projects also need the Dart extension. You're prompted to install it the first time you debug.
Choose a toolchain
If you installed from the install page, there's nothing to set. The extension finds the toolchain on its own. If you installed to a custom folder or have more than one installation, click "Locate Installation…" in the KXBuild view and pick one.
Updates and doctor
At startup the extension checks for a newer kxbuild. If there is one, it updates in a terminal and then runs doctor. When the extension and kxbuild versions don't match, the view asks you to run doctor.
KXBuild: Doctor (fix environment) checks your environment, installs missing components and updates outdated ones. Run it with a project open and it also prepares that project, which Flutter, React Native, Expo, Kotlin Multiplatform and cocos2d-x projects need. Run it once after installing the toolchain or extension, the first time you open one of those projects, and whenever the extension asks you to.
Walkthrough
After you first install the extension, the Welcome page shows the Get Started with KXBuild walkthrough. It takes you through setting up the toolchain, creating or opening a project, and selecting a device to debug, the same steps as Get started with the KXBuild IDE.
Next steps
Create, open and import projects
Create projects in VS Code, open existing ones, add Swift package dependencies and app extensions such as widgets, and convert a Swift package into an app project. Loaded projects show up in the KXBuild view, ready to run with F5. A table at the end lists which folder to open for each project type.
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.