35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# xcodebuildmcp/config.yaml Reference
|
||
|
||
This file is required for XcodeBuildMCP to automate builds, tests, and simulator actions. It tells the tool which workspace, scheme, configuration, and simulator to use.
|
||
|
||
## Example config.yaml
|
||
```yaml
|
||
schemaVersion: 1
|
||
sessionDefaults:
|
||
workspacePath: ./OneApp.xcworkspace
|
||
scheme: ToyotaOneApp
|
||
configuration: Debug
|
||
simulatorName: iPhone 17 Pro Max
|
||
simulatorId: <SIMULATOR_UDID>
|
||
useLatestOS: true
|
||
```
|
||
|
||
## Key Fields
|
||
- `workspacePath`: Path to your .xcworkspace or .xcodeproj
|
||
- `scheme`: The Xcode scheme to build/test
|
||
- `configuration`: Build configuration (Debug, Release, etc.)
|
||
- `simulatorName`: Name of the simulator to use
|
||
- `simulatorId`: UDID of the simulator (optional; takes precedence over name)
|
||
- `useLatestOS`: If true, always use the latest available iOS version
|
||
|
||
## Where to put it
|
||
Place this file at `.xcodebuildmcp/config.yaml` in your repo root.
|
||
|
||
## Why it matters
|
||
This config lets XcodeBuildMCP run builds, tests, and launches without manual setup. It ensures all developers and CI jobs use the same settings.
|
||
|
||
## Troubleshooting
|
||
- If builds fail, check workspacePath and scheme.
|
||
- If the simulator isn’t found, check simulatorName or simulatorId.
|
||
- If you change project structure, update config.yaml accordingly.
|