How to use iTMSTransporter

Issue #563

Transporter app

The new Transporter app for macOS makes it easy to upload your binary to App Store Connect. To get started, download Transporter from the Mac App Store, and simply drag and drop your binaries into the upload window. With Transporter you can

https://stackoverflow.com/questions/8094317/where-to-find-application-loader-app-in-mac/40419328

1
2
3
4
5
6
7
8
As of Xcode 11, "Application Loader is no longer included with Xcode", per the Xcode 11 Release Notes:

Xcode supports uploading apps from the Organizer window or from the command line with xcodebuild or xcrun altool. Application Loader is no longer included with Xcode. (29008875)

The Xcode Help page, Upload an app to App Store Connect, explains how to upload from the Xcode Archives Organizer.

Transporter
In October 2019, Apple announced the Transporter app for macOS, now available in the Mac App Store.

Find path

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
public struct Transporter {
var arguments: [String] = []

func run(workflow: Workflow) throws {
guard Folder.directoryExists(path: "/Applications/Transporter.app") else {
Deps.console.warn("You need to install Transporter")
throw PumaError.invalid
}

try CommandLine().runBash(
workflow: workflow,
program: transportPath(),
arguments: arguments
)
}

private func transportPath() throws -> String {
if Folder.directoryExists(path: "/Applications/Transporter.app") {
return "/Applications/Transporter.app/Contents/itms/bin/iTMSTransporter"
} else if Folder.directoryExists(path: "/Applications/Xcode.app/Contents/Applications/Application Loader.app/") {
return "/Applications/Xcode.app/Contents/Applications/Application Loader.app/Contents/MacOS/itms/bin/iTMSTransporter"
} else {
throw PumaError.invalid
}
}
}

Help

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
usage: iTMSTransporter [-help <arg> | -info | -m <arg> | -version]   [-o <arg>] [-v
<arg>] [-WONoPause <arg>] [-Xmx4096m]
iTMSTransporter : iTunes Store Transporter 2.0.0
-help <arg> Show this help. If a mode value is specified, show help specific
to that mode.
-info The -info option should be used by itself and returns the
copyright notice and acknowledgements.
-m <arg> The -m option specifies the tool's mode. The valid values are:
verify, upload, provider, diagnostic, lookupMetadata,
createArtist, lookupArtist, status, statusAll,
createMetadataTicket, queryTickets, generateSchema, transferTest,
downloadMetadataGuides, listReports, requestReport
-o <arg> The -o option specifies the directory and filename you want to use
to log output information. By default, Transporter logs output
information to standard out. If you specify a filename,
Transporter logs the output to the specified file, as well as to
standard out.
-v <arg> The -v option specifies the level of logging. The five values
are: off, detailed, informational, critical, eXtreme.
-version The -version option should be used by itself and returns the
version of the tool.
-WONoPause <arg> The -WONoPause option is only valid on Windows and its value can
be 'true' or 'false'. If an error occurs during script execution,
the process idles because the message 'Press any key...' is
displayed on the console and the system awaits a keypress. To
avoid this behavior, set this property to true
-Xmx4096m Specifies that you want to change the Java Virtual Machine's (JVM)
allocated memory by increasing the JVM heap size. By default,
Transporter uses a 2048MB heap size. You can use the -Xmx4096m
option to specify a 4-gigabyte (GB) heap size. Apple recommends,
if needed, increasing the heap size to 4096MB by specifying the
-Xmx4096m (or -Xmx4g) option and adjusting as needed.

Read more

How to keep command line tool running with async in Swift

Issue #549

Use Semaphore

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public class Sequence: Task {
public func run(workflow: Workflow, completion: @escaping TaskCompletion) {
let semaphore = DispatchSemaphore(value: 0)
runFirst(tasks: tasks, workflow: workflow, completion: { result in
completion(result)
semaphore.signal()
})

semaphore.wait()
}
}

public class Concurrent: Task {
public func run(workflow: Workflow, completion: @escaping (Result<(), Error>) -> Void) {
var runTaskCount = 0
let taskCount = tasks.count
let semaphore = DispatchSemaphore(value: 0)

tasks.forEach { task in
task.run(workflow: workflow, completion: { _ in
self.serialQueue.async {
runTaskCount += 1
if runTaskCount == taskCount {
completion(.success(()))
semaphore.signal()
}
}
})
}

semaphore.wait()
}
}

Read more

How to use xcodebuild

Issue #544

man xcodebuild

1
man xcodebuild
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939

XCODEBUILD(1) BSD General Commands Manual XCODEBUILD(1)

NAME
xcodebuild -- build Xcode projects and workspaces

SYNOPSIS
xcodebuild [-project name.xcodeproj] [[-target targetname] ... | -alltargets] [-configuration configurationname]
[-sdk [sdkfullpath | sdkname]] [action ...] [buildsetting=value ...] [-userdefault=value ...]

xcodebuild [-project name.xcodeproj] -scheme schemename [[-destination destinationspecifier] ...] [-destination-timeout value]
[-configuration configurationname] [-sdk [sdkfullpath | sdkname]] [action ...] [buildsetting=value ...]
[-userdefault=value ...]

xcodebuild -workspace name.xcworkspace -scheme schemename [[-destination destinationspecifier] ...] [-destination-timeout value]
[-configuration configurationname] [-sdk [sdkfullpath | sdkname]] [action ...] [buildsetting=value ...]
[-userdefault=value ...]

xcodebuild -version [-sdk [sdkfullpath | sdkname]] [infoitem]

xcodebuild -showsdks

xcodebuild -showBuildSettings [-project name.xcodeproj | [-workspace name.xcworkspace -scheme schemename]]

xcodebuild -showdestinations [-project name.xcodeproj | [-workspace name.xcworkspace -scheme schemename]]

xcodebuild -showTestPlans [-project name.xcodeproj | -workspace name.xcworkspace] -scheme schemename

xcodebuild -list [-project name.xcodeproj | -workspace name.xcworkspace]

xcodebuild -exportArchive -archivePath xcarchivepath -exportPath destinationpath -exportOptionsPlist path
xcodebuild -exportNotarizedApp -archivePath xcarchivepath -exportPath destinationpath

xcodebuild -exportLocalizations -project name.xcodeproj -localizationPath path [[-exportLanguage language] ...]
xcodebuild -importLocalizations -project name.xcodeproj -localizationPath path

DESCRIPTION
xcodebuild builds one or more targets contained in an Xcode project, or builds a scheme contained in an Xcode workspace or Xcode
project.

Usage
To build an Xcode project, run xcodebuild from the directory containing your project (i.e. the directory containing the
name.xcodeproj package). If you have multiple projects in the this directory you will need to use -project to indicate which
project should be built. By default, xcodebuild builds the first target listed in the project, with the default build configu-
ration. The order of the targets is a property of the project and is the same for all users of the project.

To build an Xcode workspace, you must pass both the -workspace and -scheme options to define the build. The parameters of the
scheme will control which targets are built and how they are built, although you may pass other options to xcodebuild to over-
ride some parameters of the scheme.

There are also several options that display info about the installed version of Xcode or about projects or workspaces in the
local directory, but which do not initiate an action. These include -list, -showBuildSettings, -showdestinations, -showsdks,
-showTestPlans, -usage, and -version.

Options
-project name.xcodeproj
Build the project name.xcodeproj. Required if there are multiple project files in the same directory.

-target targetname
Build the target specified by targetname.

-alltargets
Build all the targets in the specified project.

-workspace name.xcworkspace
Build the workspace name.xcworkspace.

-scheme schemename
Build the scheme specified by schemename. Required if building a workspace.

-destination destinationspecifier
Use the destination device described by destinationspecifier. Defaults to a destination that is compatible with the
selected scheme. See the Destinations section below for more details.

-destination-timeout timeout
Use the specified timeout when searching for a destination device. The default is 30 seconds.

-configuration configurationname
Use the build configuration specified by configurationname when building each target.

-arch architecture
Use the architecture specified by architecture when building each target.

-sdk [sdkfullpath | sdkname]
Build an Xcode project or workspace against the specified SDK, using build tools appropriate for that SDK. The argument
may be an absolute path to an SDK, or the canonical name of an SDK.

-showsdks
Lists all available SDKs that Xcode knows about, including their canonical names suitable for use with -sdk. Does not
initiate a build.

-showBuildSettings
Lists the build settings in a project or workspace and scheme. Does not initiate a build. Use with -project or -workspace
and -scheme.

-showdestinations
Lists the valid destinations for a project or workspace and scheme. Does not initiate a build. Use with -project or
-workspace and -scheme.

-showBuildTimingSummary
Display a report of the timings of all the commands invoked during the build.

-showTestPlans
Lists the test plans (if any) associated with the specified scheme. Does not initiate a build. Use with -scheme.

-list
Lists the targets and configurations in a project, or the schemes in a workspace. Does not initiate a build. Use with
-project or -workspace.

-enableAddressSanitizer [YES | NO]
Turns the address sanitizer on or off. This overrides the setting for the launch action of a scheme in a workspace.

-enableThreadSanitizer [YES | NO]
Turns the thread sanitizer on or off. This overrides the setting for the launch action of a scheme in a workspace.

-enableUndefinedBehaviorSanitizer [YES | NO]
Turns the undefined behavior sanitizer on or off. This overrides the setting for the launch action of a scheme in a
workspace.

-enableCodeCoverage [YES | NO]
Turns code coverage on or off during testing. This overrides the setting for the test action of a scheme in a workspace.

-testLanguage language
Specifies ISO 639-1 language during testing. This overrides the setting for the test action of a scheme in a workspace.

-testRegion region
Specifies ISO 3166-1 region during testing. This overrides the setting for the test action of a scheme in a workspace.

-derivedDataPath path
Overrides the folder that should be used for derived data when performing an action on a scheme in a workspace.

-resultBundlePath path
Writes a bundle to the specified path with results from performing an action on a scheme in a workspace. If the path
already exists, xcodebuild will exit with an error. Intermediate directories will be created automatically. The bundle
contains build logs, code coverage reports, XML property lists with test results, screenshots and other attachments col-
lected during testing, and various diagnostic logs.

-allowProvisioningUpdates
Allow xcodebuild to communicate with the Apple Developer website. For automatically signed targets, xcodebuild will create
and update profiles, app IDs, and certificates. For manually signed targets, xcodebuild will download missing or updated
provisioning profiles. Requires a developer account to have been added in Xcode's Accounts preference pane.

-allowProvisioningDeviceRegistration
Allow xcodebuild to register your destination device on the Apple Developer website if necessary. Requires
-allowProvisioningUpdates.

-exportArchive
Specifies that an archive should be distributed. Requires -archivePath and -exportOptionsPlist. For exporting, -exportPath
is also required. Cannot be passed along with an action.

-exportNotarizedApp
Export an archive that has been notarized by Apple. Requires -archivePath and -exportPath.

-archivePath xcarchivepath
Specifies the path for the archive produced by the archive action, or specifies the archive that should be exported when
-exportArchive or -exportNotarizedApp is passed.

-exportPath destinationpath
Specifies the destination for the exported product, including the name of the exported file.

-exportOptionsPlist path
Specifies options for -exportArchive. xcodebuild -help can print the full set of available options.

-exportLocalizations
Exports localizations to XLIFF files. Requires -project and -localizationPath. Cannot be passed along with an action.

-importLocalizations
Imports localizations from an XLIFF file. Requires -project and -localizationPath. Cannot be passed along with an action.

-localizationPath
Specifies a path to a directory or a single XLIFF localization file.

-exportLanguage language
Specifies optional ISO 639-1 languages included in a localization export. May be repeated to specify multiple languages.
May be excluded to specify an export includes only development language strings.

action ...
Specify one or more actions to perform. Available actions are:

build Build the target in the build root (SYMROOT). This is the default action, and is used if no action
is given.

build-for-testing Build the target and associated tests in the build root (SYMROOT). This will also produce an
xctestrun file in the build root. This requires specifying a scheme.

analyze Build and analyze a target or scheme from the build root (SYMROOT). This requires specifying a
scheme.

archive Archive a scheme from the build root (SYMROOT). This requires specifying a scheme.

test Test a scheme from the build root (SYMROOT). This requires specifying a scheme and optionally a
destination.

test-without-building Test compiled bundles. If a scheme is provided with -scheme then the command finds bundles in the
build root (SRCROOT). If an xctestrun file is provided with -xctestrun then the command finds bun-
dles at paths specified in the xctestrun file.

installsrc Copy the source of the project to the source root (SRCROOT).

install Build the target and install it into the target's installation directory in the distribution root
(DSTROOT).

clean Remove build products and intermediate files from the build root (SYMROOT).

-xcconfig filename
Load the build settings defined in filename when building all targets. These settings will override all other settings,
including settings passed individually on the command line.

-xctestrun xctestrunpath
Specifies test run parameters. Can only be used with the test-without-building action. Cannot be used with -workspace or
-project. See <x-man-page://5/xcodebuild.xctestrun> for file format details.

-testPlan test-plan-name
Specifies which test plan associated with the scheme should be used for testing. Pass the name of the .xctestplan file
without its extension.

-skip-testing test-identifier, -only-testing test-identifier
Constrain test targets, classes, or methods in test actions. -only-testing constrains a test action to only testing a
specified identifier, and excluding all other identifiers. -skip-testing constrains a test action to skip testing a spec-
ified identifier, but including all other identifiers. Test identifiers have the form TestTarget[/TestClass[/TestMethod]].
The TestTarget component of an identifier is the name of a unit or UI testing bundle as shown in the Test Navigator. An
xcodebuild command can combine multiple constraint options, but -only-testing has precedence over -skip-testing.

-skip-test-configuration test-configuration-name, -only-test-configuration test-configuration-name
Constrain test configurations in test actions. -only-test-configuration constrains a test action to only test a specified
test configuration within a test plan, and exclude all other test configurations. -skip-test-configuration constrains a
test action to skip a specified test configuration, but include all other test configurations. Each test configuration
name must match the name of a configuration specified in a test plan and is case-sensitive. An xcodebuild command can com-
bine multiple constraint options, but -only-test-configuration has precedence over -skip-test-configuration.

-disable-concurrent-destination-testing
Do not run tests on the specified destinations concurrently. The full test suite will run to completion on a given desti-
nation before it begins on the next.

-maximum-concurrent-test-device-destinations number
If multiple device destinations are specified (and -disable-concurrent-destination-testing is not passed), only test on
number devices at a time. For example, if four iOS devices are specified, but number is 2, the full test suite will run on
each device, but only two devices will be testing at a given time.

-maximum-concurrent-test-simulator-destinations number
If multiple simulator destinations are specified (and -disable-concurrent-destination-testing is not passed), only test on
number simulators at a time. For example, if four iOS simulators are specified, but number is 2, the full test suite will
run on each simulator, but only two simulators will be testing at a given time.

-parallel-testing-enabled [YES | NO]
Overrides the per-target setting in the scheme for running tests in parallel.

-parallel-testing-worker-count number
Spawn exactly number test runners when executing tests in parallel. Overrides -maximum-parallel-testing-workers, if it is
specified.

-maximum-parallel-testing-workers number
Limit the number of test runners that will be spawned when running tests in parallel to number.

-dry-run, -n
Print the commands that would be executed, but do not execute them.

-skipUnavailableActions
Skip actions that cannot be performed instead of failing. This option is only honored if -scheme is passed.

buildsetting=value
Set the build setting buildsetting to value.

A detailed reference of Xcode build settings can be found at: <https://help.apple.com/xcode/mac/current/#/itcaec37c2a6>

-userdefault=value
Set the user default userdefault to value.

-toolchain [identifier | name]
Use a given toolchain, specified with either an identifier or name.

-quiet
Do not print any output except for warnings and errors.

-verbose
Provide additional status output.

-version
Display version information for this install of Xcode. Does not initiate a build. When used in conjunction with -sdk, the
version of the specified SDK is displayed, or all SDKs if -sdk is given no argument. Additionally, a single line of the
reported version information may be returned if infoitem is specified.

-license
Show the Xcode and SDK license agreements. Allows for accepting the license agreements without launching Xcode itself,
which is useful for headless systems. Must be run as a privileged user.

-checkFirstLaunchStatus
Check if any First Launch tasks need to be performed.

-runFirstLaunch
Install packages and agree to the license.

-usage
Displays usage information for xcodebuild.

Destinations
The -destination option takes as its argument a destination specifier describing the device (or devices) to use as a destina-
tion. A destination specifier is a single argument consisting of a set of comma-separated key=value pairs. The -destination
option may be specified multiple times to cause xcodebuild to perform the specified action on multiple destinations.

Destination specifiers may include the platform key to specify one of the supported destination platforms. There are additional
keys which should be supplied depending on the platform of the device you are selecting.

Some devices may take time to look up. The -destination-timeout option can be used to specify the amount of time to wait before
a device is considered unavailable. If unspecified, the default timeout is 30 seconds.

Currently, xcodebuild supports these platforms:

macOS The local Mac, referred to in the Xcode interface as My Mac, and which supports the following key:

arch The architecture to use, either x86_64 (the default) or i386.

variant The optional variant to use, e.g. Mac Catalyst.

iOS An iOS device, which supports the following keys:

id The identifier of the device to use, as shown in the Devices window. A valid destination specifier must
provide either id or name, but not both.

name The name of the device to use. A valid destination specifier must provide either id or name, but not
both.

iOS Simulator A simulated iOS device, which supports the following keys:

id The identifier of the simulated device to use, as shown in the Devices window. A valid destination
specifier must provide either id or name, but not both.

name The name of the simulated device to use. A valid destination specifier must provide either id or name,
but not both.

OS When specifying the simulated device by name, the iOS version for that simulated device, such as 6.0,
or the string latest (the default) to indicate the most recent version of iOS supported by this version
of Xcode.

watchOS A watchOS app is always built and deployed nested inside of an iOS app. To use a watchOS device as your des-
tination, specify a scheme which is configured to run a WatchKit app, and specify the iOS platform destina-
tion that is paired with the watchOS device you want to use.

watchOS Simulator A watchOS Simulator app is always built and deployed nested inside of an iOS Simulator app. To use a watchOS
Simulator device as your destination, specify a scheme which is configured to run a WatchKit app, and specify
the iOS Simulator platform destination that is paired with the watchOS Simulator device you want to use.

tvOS A tvOS device, which supports the following keys:

id The identifier of the device to use, as shown in the Devices window. A valid destination specifier must
provide either id or name, but not both.

name The name of the device to use. A valid destination specifier must provide either id or name, but not
both.

tvOS Simulator A simulated tvOS device, which supports the following keys:

id The identifier of the simulated device to use, as shown in the Devices window. A valid destination
specifier must provide either id or name, but not both.

name The name of the simulated device to use. A valid destination specifier must provide either id or name,
but not both.

OS When specifying the simulated device by name, the tvOS version for that simulated device, such as 9.0,
or the string latest (the default) to indicate the most recent version of tvOS supported by this ver-
sion of Xcode.

Some actions (such as building) may be performed without an actual device present. To build against a platform generically
instead of a specific device, the destination specifier may be prefixed with the optional string "generic/", indicating that the
platform should be targeted generically. An example of a generic destination is the "Generic iOS Device" destination displayed
in Xcode's UI when no physical iOS device is present.

Testing on Multiple Destinations
When more than one destination is specified with the -destination option, xcodebuild tests on those destinations concurrently.
In this mode, xcodebuild automatically chooses the number of devices and simulators that are used simultaneously. All enabled
tests in the scheme or xctestrun file are run on each destination.

Distributing Archives
The -exportArchive option specifies that xcodebuild should distribute the archive specified by -archivePath using the options
specified by -exportOptionsPlist. xcodebuild -help can print the full set of available inputs to -exportOptionsPlist. The
product can either be uploaded to Apple or exported locally. The exported product will be placed at the path specified by
-exportPath.

Archives that have been uploaded to the Apple notary service can be distributed using the -exportNotarizedApp option. This spec-
ifies that xcodebuild should export a notarized app from the archive specified by -archivePath and place the exported product at
the path specified by -exportPath. If the archive has not completed processing by the notary service, or processing failed,
then xcodebuild will exit and emit informational or error messages.

When uploading an archive using the -exportArchive option, or exporting a notarized archive using the -exportNotarizedApp
option, an Apple ID account belonging to the archive's development team is required. Enter the credentials for the Apple ID
account using Xcode's Accounts preference pane before invoking xcodebuild.

Environment Variables
The following environment variables affect the execution of xcodebuild:

XCODE_XCCONFIG_FILE
Set to a path to a file, build settings in that file will be loaded and used when building all targets. These
settings will override all other settings, including settings passed individually on the command line, and those
in the file passed with the -xcconfig option.

Exit Codes
xcodebuild exits with codes defined by sysexits(3). It will exit with EX_OK on success. On failure, it will commonly exit with
EX_USAGE if any options appear malformed, EX_NOINPUT if any input files cannot be found, EX_IOERR if any files cannot be read or
written, and EX_SOFTWARE if the commands given to xcodebuild fail. It may exit with other codes in less common scenarios.

EXAMPLES
xcodebuild clean install

Cleans the build directory; then builds and installs the first target in the Xcode project in the directory from which
xcodebuild was started.

xcodebuild -project MyProject.xcodeproj -target Target1 -target Target2 -configuration Debug

Builds the targets Target1 and Target2 in the project MyProject.xcodeproj using the Debug configuration.

xcodebuild -target MyTarget OBJROOT=/Build/MyProj/Obj.root SYMROOT=/Build/MyProj/Sym.root

Builds the target MyTarget in the Xcode project in the directory from which xcodebuild was started, putting intermedi-
ate files in the directory /Build/MyProj/Obj.root and the products of the build in the directory
/Build/MyProj/Sym.root.

xcodebuild -sdk macosx10.6

Builds the Xcode project in the directory from which xcodebuild was started against the macOS 10.6 SDK. The canonical
names of all available SDKs can be viewed using the -showsdks option.

xcodebuild -workspace MyWorkspace.xcworkspace -scheme MyScheme

Builds the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace.

xcodebuild archive -workspace MyWorkspace.xcworkspace -scheme MyScheme

Archives the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace.

xcodebuild build-for-testing -workspace MyWorkspace.xcworkspace -scheme MyScheme -destination generic/platform=iOS

Build tests and associated targets in the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace using the
generic iOS device destination. The command also writes test parameters from the scheme to an xctestrun file in the
built products directory.

xcodebuild test-without-building -workspace MyWorkspace.xcworkspace -scheme MyScheme -destination 'platform=iOS
Simulator,name=iPhone 5s' -destination 'platform=iOS,name=My iPad'

Tests the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace using both the iOS Simulator and the device
named iPhone 5s for the latest version of iOS. The command assumes the test bundles are in the build root (SYMROOT).
(Note that the shell requires arguments to be quoted or otherwise escaped if they contain spaces.)

xcodebuild test-without-building -xctestrun MyTestRun.xctestrun -destination 'platform=iOS Simulator,name=iPhone 5s'
-destination 'platform=iOS,name=My iPad'

Tests using both the iOS Simulator and the device named iPhone 5s. Test bundle paths and other test parameters are
specified in MyTestRun.xctestrun. The command requires project binaries and does not require project source code.

xcodebuild test -workspace MyWorkspace.xcworkspace -scheme MyScheme -destination 'platform=macOS,arch=x86_64'

Tests the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace using the destination described as My Mac
64-bit in Xcode.

XCODEBUILD(1) BSD General Commands Manual XCODEBUILD(1)

NAME
xcodebuild -- build Xcode projects and workspaces

SYNOPSIS
xcodebuild [-project name.xcodeproj] [[-target targetname] ... | -alltargets] [-configuration configurationname]
[-sdk [sdkfullpath | sdkname]] [action ...] [buildsetting=value ...] [-userdefault=value ...]

xcodebuild [-project name.xcodeproj] -scheme schemename [[-destination destinationspecifier] ...] [-destination-timeout value]
[-configuration configurationname] [-sdk [sdkfullpath | sdkname]] [action ...] [buildsetting=value ...]
[-userdefault=value ...]

xcodebuild -workspace name.xcworkspace -scheme schemename [[-destination destinationspecifier] ...] [-destination-timeout value]
[-configuration configurationname] [-sdk [sdkfullpath | sdkname]] [action ...] [buildsetting=value ...]
[-userdefault=value ...]

xcodebuild -version [-sdk [sdkfullpath | sdkname]] [infoitem]

xcodebuild -showsdks

xcodebuild -showBuildSettings [-project name.xcodeproj | [-workspace name.xcworkspace -scheme schemename]]

xcodebuild -showdestinations [-project name.xcodeproj | [-workspace name.xcworkspace -scheme schemename]]

xcodebuild -showTestPlans [-project name.xcodeproj | -workspace name.xcworkspace] -scheme schemename

xcodebuild -list [-project name.xcodeproj | -workspace name.xcworkspace]

xcodebuild -exportArchive -archivePath xcarchivepath -exportPath destinationpath -exportOptionsPlist path
xcodebuild -exportNotarizedApp -archivePath xcarchivepath -exportPath destinationpath

xcodebuild -exportLocalizations -project name.xcodeproj -localizationPath path [[-exportLanguage language] ...]
xcodebuild -importLocalizations -project name.xcodeproj -localizationPath path

DESCRIPTION
xcodebuild builds one or more targets contained in an Xcode project, or builds a scheme contained in an Xcode workspace or Xcode
project.

Usage
To build an Xcode project, run xcodebuild from the directory containing your project (i.e. the directory containing the
name.xcodeproj package). If you have multiple projects in the this directory you will need to use -project to indicate which
project should be built. By default, xcodebuild builds the first target listed in the project, with the default build configu-
ration. The order of the targets is a property of the project and is the same for all users of the project.

To build an Xcode workspace, you must pass both the -workspace and -scheme options to define the build. The parameters of the
scheme will control which targets are built and how they are built, although you may pass other options to xcodebuild to over-
ride some parameters of the scheme.

There are also several options that display info about the installed version of Xcode or about projects or workspaces in the
local directory, but which do not initiate an action. These include -list, -showBuildSettings, -showdestinations, -showsdks,
-showTestPlans, -usage, and -version.

Options
-project name.xcodeproj
Build the project name.xcodeproj. Required if there are multiple project files in the same directory.

-target targetname
Build the target specified by targetname.

-alltargets
Build all the targets in the specified project.

-workspace name.xcworkspace
Build the workspace name.xcworkspace.

-scheme schemename
Build the scheme specified by schemename. Required if building a workspace.

-destination destinationspecifier
Use the destination device described by destinationspecifier. Defaults to a destination that is compatible with the
selected scheme. See the Destinations section below for more details.

-destination-timeout timeout
Use the specified timeout when searching for a destination device. The default is 30 seconds.

-configuration configurationname
Use the build configuration specified by configurationname when building each target.

-arch architecture
Use the architecture specified by architecture when building each target.

-sdk [sdkfullpath | sdkname]
Build an Xcode project or workspace against the specified SDK, using build tools appropriate for that SDK. The argument
may be an absolute path to an SDK, or the canonical name of an SDK.

-showsdks
Lists all available SDKs that Xcode knows about, including their canonical names suitable for use with -sdk. Does not
initiate a build.

-showBuildSettings
Lists the build settings in a project or workspace and scheme. Does not initiate a build. Use with -project or -workspace
and -scheme.

-showdestinations
Lists the valid destinations for a project or workspace and scheme. Does not initiate a build. Use with -project or
-workspace and -scheme.

-showBuildTimingSummary
Display a report of the timings of all the commands invoked during the build.

-showTestPlans
Lists the test plans (if any) associated with the specified scheme. Does not initiate a build. Use with -scheme.

-list
Lists the targets and configurations in a project, or the schemes in a workspace. Does not initiate a build. Use with
-project or -workspace.

-enableAddressSanitizer [YES | NO]
Turns the address sanitizer on or off. This overrides the setting for the launch action of a scheme in a workspace.

-enableThreadSanitizer [YES | NO]
Turns the thread sanitizer on or off. This overrides the setting for the launch action of a scheme in a workspace.

-enableUndefinedBehaviorSanitizer [YES | NO]
Turns the undefined behavior sanitizer on or off. This overrides the setting for the launch action of a scheme in a
workspace.

-enableCodeCoverage [YES | NO]
Turns code coverage on or off during testing. This overrides the setting for the test action of a scheme in a workspace.

-testLanguage language
Specifies ISO 639-1 language during testing. This overrides the setting for the test action of a scheme in a workspace.

-testRegion region
Specifies ISO 3166-1 region during testing. This overrides the setting for the test action of a scheme in a workspace.

-derivedDataPath path
Overrides the folder that should be used for derived data when performing an action on a scheme in a workspace.

-resultBundlePath path
Writes a bundle to the specified path with results from performing an action on a scheme in a workspace. If the path
already exists, xcodebuild will exit with an error. Intermediate directories will be created automatically. The bundle
contains build logs, code coverage reports, XML property lists with test results, screenshots and other attachments col-
lected during testing, and various diagnostic logs.

-allowProvisioningUpdates
Allow xcodebuild to communicate with the Apple Developer website. For automatically signed targets, xcodebuild will create
and update profiles, app IDs, and certificates. For manually signed targets, xcodebuild will download missing or updated
provisioning profiles. Requires a developer account to have been added in Xcode's Accounts preference pane.

-allowProvisioningDeviceRegistration
Allow xcodebuild to register your destination device on the Apple Developer website if necessary. Requires
-allowProvisioningUpdates.

-exportArchive
Specifies that an archive should be distributed. Requires -archivePath and -exportOptionsPlist. For exporting, -exportPath
is also required. Cannot be passed along with an action.

-exportNotarizedApp
Export an archive that has been notarized by Apple. Requires -archivePath and -exportPath.

-archivePath xcarchivepath
Specifies the path for the archive produced by the archive action, or specifies the archive that should be exported when
-exportArchive or -exportNotarizedApp is passed.

-exportPath destinationpath
Specifies the destination for the exported product, including the name of the exported file.

-exportOptionsPlist path
Specifies options for -exportArchive. xcodebuild -help can print the full set of available options.

-exportLocalizations
Exports localizations to XLIFF files. Requires -project and -localizationPath. Cannot be passed along with an action.

-importLocalizations
Imports localizations from an XLIFF file. Requires -project and -localizationPath. Cannot be passed along with an action.

-localizationPath
Specifies a path to a directory or a single XLIFF localization file.

-exportLanguage language
Specifies optional ISO 639-1 languages included in a localization export. May be repeated to specify multiple languages.
May be excluded to specify an export includes only development language strings.

action ...
Specify one or more actions to perform. Available actions are:

build Build the target in the build root (SYMROOT). This is the default action, and is used if no action
is given.

build-for-testing Build the target and associated tests in the build root (SYMROOT). This will also produce an
xctestrun file in the build root. This requires specifying a scheme.

analyze Build and analyze a target or scheme from the build root (SYMROOT). This requires specifying a
scheme.

archive Archive a scheme from the build root (SYMROOT). This requires specifying a scheme.

test Test a scheme from the build root (SYMROOT). This requires specifying a scheme and optionally a
destination.

test-without-building Test compiled bundles. If a scheme is provided with -scheme then the command finds bundles in the
build root (SRCROOT). If an xctestrun file is provided with -xctestrun then the command finds bun-
dles at paths specified in the xctestrun file.

installsrc Copy the source of the project to the source root (SRCROOT).

install Build the target and install it into the target's installation directory in the distribution root
(DSTROOT).

clean Remove build products and intermediate files from the build root (SYMROOT).

-xcconfig filename
Load the build settings defined in filename when building all targets. These settings will override all other settings,
including settings passed individually on the command line.

-xctestrun xctestrunpath
Specifies test run parameters. Can only be used with the test-without-building action. Cannot be used with -workspace or
-project. See <x-man-page://5/xcodebuild.xctestrun> for file format details.

-testPlan test-plan-name
Specifies which test plan associated with the scheme should be used for testing. Pass the name of the .xctestplan file
without its extension.

-skip-testing test-identifier, -only-testing test-identifier
Constrain test targets, classes, or methods in test actions. -only-testing constrains a test action to only testing a
specified identifier, and excluding all other identifiers. -skip-testing constrains a test action to skip testing a spec-
ified identifier, but including all other identifiers. Test identifiers have the form TestTarget[/TestClass[/TestMethod]].
The TestTarget component of an identifier is the name of a unit or UI testing bundle as shown in the Test Navigator. An
xcodebuild command can combine multiple constraint options, but -only-testing has precedence over -skip-testing.

-skip-test-configuration test-configuration-name, -only-test-configuration test-configuration-name
Constrain test configurations in test actions. -only-test-configuration constrains a test action to only test a specified
test configuration within a test plan, and exclude all other test configurations. -skip-test-configuration constrains a
test action to skip a specified test configuration, but include all other test configurations. Each test configuration
name must match the name of a configuration specified in a test plan and is case-sensitive. An xcodebuild command can com-
bine multiple constraint options, but -only-test-configuration has precedence over -skip-test-configuration.

-disable-concurrent-destination-testing
Do not run tests on the specified destinations concurrently. The full test suite will run to completion on a given desti-
nation before it begins on the next.

-maximum-concurrent-test-device-destinations number
If multiple device destinations are specified (and -disable-concurrent-destination-testing is not passed), only test on
number devices at a time. For example, if four iOS devices are specified, but number is 2, the full test suite will run on
each device, but only two devices will be testing at a given time.

-maximum-concurrent-test-simulator-destinations number
If multiple simulator destinations are specified (and -disable-concurrent-destination-testing is not passed), only test on
number simulators at a time. For example, if four iOS simulators are specified, but number is 2, the full test suite will
run on each simulator, but only two simulators will be testing at a given time.

-parallel-testing-enabled [YES | NO]
Overrides the per-target setting in the scheme for running tests in parallel.

-parallel-testing-worker-count number
Spawn exactly number test runners when executing tests in parallel. Overrides -maximum-parallel-testing-workers, if it is
specified.

-maximum-parallel-testing-workers number
Limit the number of test runners that will be spawned when running tests in parallel to number.

-dry-run, -n
Print the commands that would be executed, but do not execute them.

-skipUnavailableActions
Skip actions that cannot be performed instead of failing. This option is only honored if -scheme is passed.

buildsetting=value
Set the build setting buildsetting to value.

A detailed reference of Xcode build settings can be found at: <https://help.apple.com/xcode/mac/current/#/itcaec37c2a6>

-userdefault=value
Set the user default userdefault to value.

-toolchain [identifier | name]
Use a given toolchain, specified with either an identifier or name.

-quiet
Do not print any output except for warnings and errors.

-verbose
Provide additional status output.

-version
Display version information for this install of Xcode. Does not initiate a build. When used in conjunction with -sdk, the
version of the specified SDK is displayed, or all SDKs if -sdk is given no argument. Additionally, a single line of the
reported version information may be returned if infoitem is specified.

-license
Show the Xcode and SDK license agreements. Allows for accepting the license agreements without launching Xcode itself,
which is useful for headless systems. Must be run as a privileged user.

-checkFirstLaunchStatus
Check if any First Launch tasks need to be performed.

-runFirstLaunch
Install packages and agree to the license.

-usage
Displays usage information for xcodebuild.

Destinations
The -destination option takes as its argument a destination specifier describing the device (or devices) to use as a destina-
tion. A destination specifier is a single argument consisting of a set of comma-separated key=value pairs. The -destination
option may be specified multiple times to cause xcodebuild to perform the specified action on multiple destinations.

Destination specifiers may include the platform key to specify one of the supported destination platforms. There are additional
keys which should be supplied depending on the platform of the device you are selecting.

Some devices may take time to look up. The -destination-timeout option can be used to specify the amount of time to wait before
a device is considered unavailable. If unspecified, the default timeout is 30 seconds.

Currently, xcodebuild supports these platforms:

macOS The local Mac, referred to in the Xcode interface as My Mac, and which supports the following key:

arch The architecture to use, either x86_64 (the default) or i386.

variant The optional variant to use, e.g. Mac Catalyst.

iOS An iOS device, which supports the following keys:

id The identifier of the device to use, as shown in the Devices window. A valid destination specifier must
provide either id or name, but not both.

name The name of the device to use. A valid destination specifier must provide either id or name, but not
both.

iOS Simulator A simulated iOS device, which supports the following keys:

id The identifier of the simulated device to use, as shown in the Devices window. A valid destination
specifier must provide either id or name, but not both.

name The name of the simulated device to use. A valid destination specifier must provide either id or name,
but not both.

OS When specifying the simulated device by name, the iOS version for that simulated device, such as 6.0,
or the string latest (the default) to indicate the most recent version of iOS supported by this version
of Xcode.

watchOS A watchOS app is always built and deployed nested inside of an iOS app. To use a watchOS device as your des-
tination, specify a scheme which is configured to run a WatchKit app, and specify the iOS platform destina-
tion that is paired with the watchOS device you want to use.

watchOS Simulator A watchOS Simulator app is always built and deployed nested inside of an iOS Simulator app. To use a watchOS
Simulator device as your destination, specify a scheme which is configured to run a WatchKit app, and specify
the iOS Simulator platform destination that is paired with the watchOS Simulator device you want to use.

tvOS A tvOS device, which supports the following keys:

id The identifier of the device to use, as shown in the Devices window. A valid destination specifier must
provide either id or name, but not both.

name The name of the device to use. A valid destination specifier must provide either id or name, but not
both.

tvOS Simulator A simulated tvOS device, which supports the following keys:

id The identifier of the simulated device to use, as shown in the Devices window. A valid destination
specifier must provide either id or name, but not both.

name The name of the simulated device to use. A valid destination specifier must provide either id or name,
but not both.

OS When specifying the simulated device by name, the tvOS version for that simulated device, such as 9.0,
or the string latest (the default) to indicate the most recent version of tvOS supported by this ver-
sion of Xcode.

Some actions (such as building) may be performed without an actual device present. To build against a platform generically
instead of a specific device, the destination specifier may be prefixed with the optional string "generic/", indicating that the
platform should be targeted generically. An example of a generic destination is the "Generic iOS Device" destination displayed
in Xcode's UI when no physical iOS device is present.

Testing on Multiple Destinations
When more than one destination is specified with the -destination option, xcodebuild tests on those destinations concurrently.
In this mode, xcodebuild automatically chooses the number of devices and simulators that are used simultaneously. All enabled
tests in the scheme or xctestrun file are run on each destination.

Distributing Archives
The -exportArchive option specifies that xcodebuild should distribute the archive specified by -archivePath using the options
specified by -exportOptionsPlist. xcodebuild -help can print the full set of available inputs to -exportOptionsPlist. The
product can either be uploaded to Apple or exported locally. The exported product will be placed at the path specified by
-exportPath.

Archives that have been uploaded to the Apple notary service can be distributed using the -exportNotarizedApp option. This spec-
ifies that xcodebuild should export a notarized app from the archive specified by -archivePath and place the exported product at
the path specified by -exportPath. If the archive has not completed processing by the notary service, or processing failed,
then xcodebuild will exit and emit informational or error messages.

When uploading an archive using the -exportArchive option, or exporting a notarized archive using the -exportNotarizedApp
option, an Apple ID account belonging to the archive's development team is required. Enter the credentials for the Apple ID
account using Xcode's Accounts preference pane before invoking xcodebuild.

Environment Variables
The following environment variables affect the execution of xcodebuild:

XCODE_XCCONFIG_FILE
Set to a path to a file, build settings in that file will be loaded and used when building all targets. These
settings will override all other settings, including settings passed individually on the command line, and those
in the file passed with the -xcconfig option.

Exit Codes
xcodebuild exits with codes defined by sysexits(3). It will exit with EX_OK on success. On failure, it will commonly exit with
EX_USAGE if any options appear malformed, EX_NOINPUT if any input files cannot be found, EX_IOERR if any files cannot be read or
written, and EX_SOFTWARE if the commands given to xcodebuild fail. It may exit with other codes in less common scenarios.

EXAMPLES
xcodebuild clean install

Cleans the build directory; then builds and installs the first target in the Xcode project in the directory from which
xcodebuild was started.

xcodebuild -project MyProject.xcodeproj -target Target1 -target Target2 -configuration Debug

Builds the targets Target1 and Target2 in the project MyProject.xcodeproj using the Debug configuration.

xcodebuild -target MyTarget OBJROOT=/Build/MyProj/Obj.root SYMROOT=/Build/MyProj/Sym.root

Builds the target MyTarget in the Xcode project in the directory from which xcodebuild was started, putting intermedi-
ate files in the directory /Build/MyProj/Obj.root and the products of the build in the directory
/Build/MyProj/Sym.root.

xcodebuild -sdk macosx10.6

Builds the Xcode project in the directory from which xcodebuild was started against the macOS 10.6 SDK. The canonical
names of all available SDKs can be viewed using the -showsdks option.

xcodebuild -workspace MyWorkspace.xcworkspace -scheme MyScheme

Builds the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace.

xcodebuild archive -workspace MyWorkspace.xcworkspace -scheme MyScheme

Archives the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace.

xcodebuild build-for-testing -workspace MyWorkspace.xcworkspace -scheme MyScheme -destination generic/platform=iOS

Build tests and associated targets in the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace using the
generic iOS device destination. The command also writes test parameters from the scheme to an xctestrun file in the
built products directory.

xcodebuild test-without-building -workspace MyWorkspace.xcworkspace -scheme MyScheme -destination 'platform=iOS
Simulator,name=iPhone 5s' -destination 'platform=iOS,name=My iPad'

Tests the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace using both the iOS Simulator and the device
named iPhone 5s for the latest version of iOS. The command assumes the test bundles are in the build root (SYMROOT).
(Note that the shell requires arguments to be quoted or otherwise escaped if they contain spaces.)

xcodebuild test-without-building -xctestrun MyTestRun.xctestrun -destination 'platform=iOS Simulator,name=iPhone 5s'
-destination 'platform=iOS,name=My iPad'

Tests using both the iOS Simulator and the device named iPhone 5s. Test bundle paths and other test parameters are
specified in MyTestRun.xctestrun. The command requires project binaries and does not require project source code.

xcodebuild test -workspace MyWorkspace.xcworkspace -scheme MyScheme -destination 'platform=macOS,arch=x86_64'

Tests the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace using the destination described as My Mac
64-bit in Xcode.

xcodebuild test -workspace MyWorkspace.xcworkspace -scheme MyScheme -destination 'platform=macOS,arch=x86_64' -only-testing
MyTests/FooTests/testFooWithBar

Tests the scheme MyScheme in the Xcode workspace MyWorkspace.xcworkspace using the destination described as My Mac
64-bit in Xcode. Only the test testFooWithBar of the test suite FooTests, part of the MyTests testing bundle target,
will be run.

xcodebuild -exportArchive -archivePath MyMobileApp.xcarchive -exportPath ExportDestination -exportOptionsPlist 'export.plist'

Exports the archive MyMobileApp.xcarchive to the path ExportDestination using the options specified in export.plist.

xcodebuild -exportLocalizations -project MyProject.xcodeproj -localizationPath MyDirectory -exportLanguage zh-hans
-exportLanguage es-MX

Exports two XLIFF files to MyDirectory from MyProject.xcodeproj containing development language strings and transla-
tions for Simplified Chinese and Mexican Spanish.

xcodebuild -exportLocalizations -project MyProject.xcodeproj -localizationPath MyDirectory

Export a single XLIFF file to MyDirectory from MyProject.xcodeproj containing only development language strings. (In
this case, the -exportLanguage parameter has been excluded.)

xcodebuild -importLocalizations -project MyProject.xcodeproj -localizationPath MyLocalizations.xliff

Imports localizations from MyLocalizations.xliff into MyProject.xcodeproj. Translations with issues will be reported
but not imported.

SEE ALSO
ibtool(1), sysexits(3), xcode-select(1), xcrun(1), xed(1)

Xcode Builds Settings Reference <https://help.apple.com/xcode/mac/current/#/itcaec37c2a6>

macOS June 20, 2016 macOS
(END)

xcodebuild –help

1
xcodebuild --help
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
Usage: xcodebuild [-project <projectname>] [[-target <targetname>]...|-alltargets] [-configuration <configurationname>] [-arch <architecture>]... [-sdk [<sdkname>|<sdkpath>]] [-showBuildSettings [-json]] [<buildsetting>=<value>]... [<buildaction>]...
xcodebuild [-project <projectname>] -scheme <schemeName> [-destination <destinationspecifier>]... [-configuration <configurationname>] [-arch <architecture>]... [-sdk [<sdkname>|<sdkpath>]] [-showBuildSettings [-json]] [-showdestinations] [<buildsetting>=<value>]... [<buildaction>]...
xcodebuild -workspace <workspacename> -scheme <schemeName> [-destination <destinationspecifier>]... [-configuration <configurationname>] [-arch <architecture>]... [-sdk [<sdkname>|<sdkpath>]] [-showBuildSettings] [-showdestinations] [<buildsetting>=<value>]... [<buildaction>]...
xcodebuild -version [-sdk [<sdkfullpath>|<sdkname>] [-json] [<infoitem>] ]
xcodebuild -list [[-project <projectname>]|[-workspace <workspacename>]] [-json]
xcodebuild -showsdks [-json]
xcodebuild -exportArchive -archivePath <xcarchivepath> [-exportPath <destinationpath>] -exportOptionsPlist <plistpath>
xcodebuild -exportNotarizedApp -archivePath <xcarchivepath> -exportPath <destinationpath>
xcodebuild -exportLocalizations -localizationPath <path> -project <projectname> [-exportLanguage <targetlanguage>...[-includeScreenshots]]
xcodebuild -importLocalizations -localizationPath <path> -project <projectname>
xcodebuild -resolvePackageDependencies [-project <projectname>|-workspace <workspacename>] -clonedSourcePackagesDirPath <path>
xcodebuild -create-xcframework [-help] [-framework <path>] [-library <path> [-headers <path>]] -output <path>

Options:
-usage print brief usage
-help print complete usage
-verbose provide additional status output
-license show the Xcode and SDK license agreements
-checkFirstLaunchStatus Check if any First Launch tasks need to be performed
-runFirstLaunch install packages and agree to the license
-project NAME build the project NAME
-target NAME build the target NAME
-alltargets build all targets
-workspace NAME build the workspace NAME
-scheme NAME build the scheme NAME
-configuration NAME use the build configuration NAME for building each target
-xcconfig PATH apply the build settings defined in the file at PATH as overrides
-arch ARCH build each target for the architecture ARCH; this will override architectures defined in the project
-sdk SDK use SDK as the name or path of the base SDK when building the project
-toolchain NAME use the toolchain with identifier or name NAME
-destination DESTINATIONSPECIFIER use the destination described by DESTINATIONSPECIFIER (a comma-separated set of key=value pairs describing the destination to use)
-destination-timeout TIMEOUT wait for TIMEOUT seconds while searching for the destination device
-parallelizeTargets build independent targets in parallel
-jobs NUMBER specify the maximum number of concurrent build operations
-maximum-concurrent-test-device-destinations NUMBER the maximum number of device destinations to test on concurrently
-maximum-concurrent-test-simulator-destinations NUMBER the maximum number of simulator destinations to test on concurrently
-parallel-testing-enabled YES|NO overrides the per-target setting in the scheme
-parallel-testing-worker-count NUMBER the exact number of test runners that will be spawned during parallel testing
-maximum-parallel-testing-workers NUMBER the maximum number of test runners that will be spawned during parallel testing
-dry-run do everything except actually running the commands
-quiet do not print any output except for warnings and errors
-hideShellScriptEnvironment don't show shell script environment variables in build log
-showsdks display a compact list of the installed SDKs
-showdestinations display a list of destinations
-showTestPlans display a list of test plans
-showBuildSettings display a list of build settings and values
-list lists the targets and configurations in a project, or the schemes in a workspace
-find-executable NAME display the full path to executable NAME in the provided SDK and toolchain
-find-library NAME display the full path to library NAME in the provided SDK and toolchain
-version display the version of Xcode; with -sdk will display info about one or all installed SDKs
-enableAddressSanitizer YES|NO turn the address sanitizer on or off
-enableThreadSanitizer YES|NO turn the thread sanitizer on or off
-enableUndefinedBehaviorSanitizer YES|NO turn the undefined behavior sanitizer on or off
-resultBundlePath PATH specifies the directory where a result bundle describing what occurred will be placed
-resultStreamPath PATH specifies the file where a result stream will be written to (the file must already exist)
-resultBundleVersion 3 [default] specifies which result bundle version should be used
-clonedSourcePackagesDirPath PATH specifies the directory to which remote source packages are fetch or expected to be found
-derivedDataPath PATH specifies the directory where build products and other derived data will go
-archivePath PATH specifies the directory where any created archives will be placed, or the archive that should be exported
-exportArchive specifies that an archive should be exported
-exportNotarizedApp export an archive that has been notarized by Apple
-exportOptionsPlist PATH specifies a path to a plist file that configures archive exporting
-enableCodeCoverage YES|NO turn code coverage on or off when testing
-exportPath PATH specifies the destination for the product exported from an archive
-skipUnavailableActions specifies that scheme actions that cannot be performed should be skipped instead of causing a failure
-exportLocalizations exports completed and outstanding project localizations
-importLocalizations imports localizations for a project, assuming any necessary localized resources have been created in Xcode
-localizationPath specifies a path to XLIFF localization files
-exportLanguage specifies multiple optional ISO 639-1 languages included in a localization export
-xctestrun specifies a path to a test run specification
-testPlan specifies the name of the test plan associated with the scheme to use for testing
-only-testing constrains testing by specifying tests to include, and excluding other tests
-only-testing:TEST-IDENTIFIER constrains testing by specifying tests to include, and excluding other tests
-skip-testing constrains testing by specifying tests to exclude, but including other tests
-skip-testing:TEST-IDENTIFIER constrains testing by specifying tests to exclude, but including other tests
-only-test-configuration constrains testing by specifying test configurations to include, and excluding other test configurations
-skip-test-configuration constrains testing by specifying test configurations to exclude, but including other test configurations
-testLanguage constrains testing by specifying ISO 639-1 language in which to run the tests
-testRegion constrains testing by specifying ISO 3166-1 region in which to run the tests
-resolvePackageDependencies resolves any Swift package dependencies referenced by the project or workspace
-disableAutomaticPackageResolution prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file
-json output as JSON (note: -json implies -quiet)
-allowProvisioningUpdates Allow xcodebuild to communicate with the Apple Developer website. For automatically signed targets, xcodebuild will create and update profiles, app IDs, and certificates. For manually signed targets, xcodebuild will download missing or updated provisioning profiles. Requires a developer account to have been added in Xcode's Accounts preference pane.
-allowProvisioningDeviceRegistration Allow xcodebuild to register your destination device on the developer portal if necessary. This flag only takes effect if -allowProvisioningUpdates is also passed.
-showBuildTimingSummary display a report of the timings of all the commands invoked during the build
-create-xcframework create an xcframework from prebuilt libraries; -help for more information.

Available keys for -exportOptionsPlist:

compileBitcode : Bool

For non-App Store exports, should Xcode re-compile the app from bitcode? Defaults to YES.

destination : String

Determines whether the app is exported locally or uploaded to Apple. Options are export or upload. The available options vary based on the selected distribution method. Defaults to export.

embedOnDemandResourcesAssetPacksInBundle : Bool

For non-App Store exports, if the app uses On Demand Resources and this is YES, asset packs are embedded in the app bundle so that the app can be tested without a server to host asset packs. Defaults to YES unless onDemandResourcesAssetPacksBaseURL is specified.

generateAppStoreInformation : Bool

For App Store exports, should Xcode generate App Store Information for uploading with iTMSTransporter? Defaults to NO.

iCloudContainerEnvironment : String

If the app is using CloudKit, this configures the "com.apple.developer.icloud-container-environment" entitlement. Available options vary depending on the type of provisioning profile used, but may include: Development and Production.

installerSigningCertificate : String

For manual signing only. Provide a certificate name, SHA-1 hash, or automatic selector to use for signing. Automatic selectors allow Xcode to pick the newest installed certificate of a particular type. The available automatic selectors are "Mac Installer Distribution" and "Developer ID Installer". Defaults to an automatic certificate selector matching the current distribution method.

manifest : Dictionary

For non-App Store exports, users can download your app over the web by opening your distribution manifest file in a web browser. To generate a distribution manifest, the value of this key should be a dictionary with three sub-keys: appURL, displayImageURL, fullSizeImageURL. The additional sub-key assetPackManifestURL is required when using on-demand resources.

method : String

Describes how Xcode should export the archive. Available options: app-store, validation, ad-hoc, package, enterprise, development, developer-id, and mac-application. The list of options varies based on the type of archive. Defaults to development.

onDemandResourcesAssetPacksBaseURL : String

For non-App Store exports, if the app uses On Demand Resources and embedOnDemandResourcesAssetPacksInBundle isn't YES, this should be a base URL specifying where asset packs are going to be hosted. This configures the app to download asset packs from the specified URL.

provisioningProfiles : Dictionary

For manual signing only. Specify the provisioning profile to use for each executable in your app. Keys in this dictionary are the bundle identifiers of executables; values are the provisioning profile name or UUID to use.

signingCertificate : String

For manual signing only. Provide a certificate name, SHA-1 hash, or automatic selector to use for signing. Automatic selectors allow Xcode to pick the newest installed certificate of a particular type. The available automatic selectors are "Mac App Distribution", "iOS Developer", "iOS Distribution", "Developer ID Application", "Apple Distribution", "Mac Developer", and "Apple Development". Defaults to an automatic certificate selector matching the current distribution method.

signingStyle : String

The signing style to use when re-signing the app for distribution. Options are manual or automatic. Apps that were automatically signed when archived can be signed manually or automatically during distribution, and default to automatic. Apps that were manually signed when archived must be manually signed during distribtion, so the value of signingStyle is ignored.

stripSwiftSymbols : Bool

Should symbols be stripped from Swift libraries in your IPA? Defaults to YES.

teamID : String

The Developer Portal team to use for this export. Defaults to the team used to build the archive.

thinning : String

For non-App Store exports, should Xcode thin the package for one or more device variants? Available options: <none> (Xcode produces a non-thinned universal app), <thin-for-all-variants> (Xcode produces a universal app and all available thinned variants), or a model identifier for a specific device (e.g. "iPhone7,1"). Defaults to <none>.

uploadBitcode : Bool

For App Store exports, should the package include bitcode? Defaults to YES.

uploadSymbols : Bool

For App Store exports, should the package include symbols? Defaults to YES.

How to set language and locale with xcodebuild

Issue #540

testLanguage and testRegion

1
2
3
4
5
6
7
-testLanguage language
Specifies ISO 639-1 language during testing. This overrides the setting for the test action of a
scheme in a workspace.

-testRegion region
Specifies ISO 3166-1 region during testing. This overrides the setting for the test action of a
scheme in a workspace.
1
xcodebuild -project 'TestApp.xcodeproj' -scheme 'TestAppUITests' -configuration Debug -sdk iphonesimulator -UseModernBuildSystem=YES -destination 'OS=13.2.2,name=iPhone 11,platform=iOS Simulator' -testLanguage ja -testRegion ja_JP test

How to setup multiple git accounts for GitHub and Bitbucket

Issue #514

Generate SSH keys

1
2
3
4
5
6
7
8
9
ssh-keygen -t rsa -C "onmyway133@gmail.com" -f "id_rsa_github"
ssh-keygen -t rsa -C "onmyway133bitbucket@gmail.com" -f "id_rsa_bitbucket"

pbcopy < ~/.ssh/id_rsa_github.pub
pbcopy < ~/.ssh/id_rsa_bitbucket.pub

ssh-add -D
ssh-add id_rsa_github
ssh-add id_rsa_bitbucket
1
2
3
4
5
6
7
8
9
10
11
12
13
vim ~/.ssh/config

#Github (personal)
Host gh
HostName github.com
User git
IdentityFile ~/.ssh/id_rsa_github

#Bitbucket (work)
Host bb
HostName bitbucket.org
User git
IdentityFile ~/.ssh/id_rsa_bitbucket

Config

1
2
git config --global user.email "onmyway133@gmail.com"
git config --local user.email "onmyway133bitbucket@gmail.com"

Read more

How to work around app damaged warning in macOS

Issue #238

“App” is damaged and can’t be opened. You should move it to the Trash.

👉 Disable gate keeper

1
2
sudo spctl --master-disable
spctl --status

Current workaround is to remove Launch At Login handling code.