Installation

Get Shaft up and running on your development machine.

System Requirements

Shaft requires Swift 6.2 or later and platform-specific dependencies depending on your operating system.

1. Install Xcode

Shaft requires Xcode to be installed.

Download from the App Store:

Open the App Store
Search for “Xcode”
Click “Get” or “Install”

Verify installation:

swift --version
# Apple Swift version 6.2 (swift-6.2-RELEASE)

Note:
If you encounter errors like xcrun: error: unable to lookup item..., update your command line tools with xcode-select --install or set the path manually with sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer.

Note:
For macOS app development with Shaft, only Xcode with Swift 6.12+ works. The open-source Swift toolchain does not support macOS app development.

Next Steps

Now that you have Shaft installed, you’re ready to:

Create your first app with the Quick Start guide
Clone the CounterTemplate to get started quickly
Explore the Core Concepts to understand Shaft’s architecture

Troubleshooting

Common Issues

“Package resolution failed”

Ensure you have an active internet connection
Try running swift package clean and retry
Check that you’re using Swift 6.2 or later

Build errors on Linux

Verify all SDL dependencies are installed
Some distributions may require additional packages

Getting Help

If you encounter issues: