Command Structure
Quick Reference
Build & Run
| Command | Alias | Description |
|---|---|---|
context | ctx | Discover project structure (workspace, schemes, simulators) |
build | Build the project | |
run | Build and launch the app | |
test | Run unit and UI tests | |
test discover | Discover available tests | |
clean | Clean build artifacts |
App Management
| Command | Description |
|---|---|
apps | List apps launched by FlowDeck |
logs / log | Stream app logs |
stop | Stop a running app |
Simulator Management
| Command | Alias | Description |
|---|---|---|
simulator list | sim list | List available simulators |
simulator boot | Boot a simulator | |
simulator shutdown | Shutdown a simulator | |
simulator screenshot | Capture a screenshot | |
simulator erase | Reset simulator to factory | |
simulator clear-cache | Clear simulator caches | |
simulator create | Create a new simulator | |
simulator delete | Delete a simulator | |
simulator prune | Delete unused simulators | |
simulator runtimes | List available runtimes | |
simulator device-types | List available device types |
Device Management
| Command | Alias | Description |
|---|---|---|
device list | dev list | List connected devices |
device install | Install app on device | |
device uninstall | Remove app from device | |
device launch | Launch app on device |
Platform & Xcode
| Command | Alias | Description |
|---|---|---|
platform list | plat list | List installed runtimes |
platform available | List downloadable runtimes | |
platform install | Install a runtime | |
platform remove | Remove a runtime | |
platform prune | Delete simulators for a runtime | |
xcode open | xc open | Open Xcode with project |
xcode clean-derived-data | Delete DerivedData folder | |
xcode clean-cache | Delete Xcode cache |
Project Configuration
| Command | Description |
|---|---|
scheme list | List schemes in workspace |
scheme info | Show scheme details |
buildconfig | List build configurations (aliases: config, cfg) |
System
| Command | Description |
|---|---|
license status | Check license status |
license activate | Activate a license |
license deactivate | Deactivate license |
update | Check for updates |
Common Options
Most commands support these options:| Option | Short | Description |
|---|---|---|
--json | -j | Output as JSON (for automation) |
--workspace <path> | -w | Path to .xcworkspace or .xcodeproj |
--scheme <name> | -s | Build scheme name |
--simulator <name> | -S | Simulator name/UDID |
--device <name> | -D | Physical device name/UDID, or “My Mac” for macOS |
--configuration <name> | -C | Build configuration (Debug/Release) |
--project <path> | -p | Project directory |
--verbose | -v | Show detailed output |
--config <path> | -c | Load settings from config file |
Exit Codes
| Code | Description |
|---|---|
0 | Success |
1 | Failure |
Environment Variables
| Variable | Description |
|---|---|
FLOWDECK_LICENSE_KEY | License key for CI/CD environments |
DEVELOPER_DIR | Override Xcode installation path |
FLOWDECK_NO_UPDATE_CHECK | Set to 1 to disable update checks |
Config File
Many commands support loading settings from a JSON config file via--config: