shipthis 0.0.8 → 0.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +41 -830
  2. package/bin/readme.sh +15 -0
  3. package/bin/run.js +1 -1
  4. package/dist/commands/apple/apiKey/create.js +1 -1
  5. package/dist/commands/apple/apiKey/status.js +1 -1
  6. package/dist/commands/apple/certificate/create.js +1 -1
  7. package/dist/commands/apple/certificate/status.js +1 -1
  8. package/dist/commands/apple/login.js +3 -3
  9. package/dist/commands/apple/status.js +24 -9
  10. package/dist/commands/game/create.js +1 -1
  11. package/dist/commands/game/details.js +1 -1
  12. package/dist/commands/game/ios/app/create.js +1 -1
  13. package/dist/commands/game/ios/app/status.js +1 -1
  14. package/dist/commands/game/ios/app/sync.js +1 -1
  15. package/dist/commands/game/ios/profile/create.js +1 -1
  16. package/dist/commands/game/ios/profile/status.js +1 -1
  17. package/dist/commands/game/job/list.js +1 -1
  18. package/dist/commands/game/list.js +1 -1
  19. package/dist/commands/game/ship.js +1 -1
  20. package/dist/commands/game/status.js +1 -1
  21. package/dist/commands/game/wizard.js +3 -2
  22. package/dist/commands/status.js +1 -1
  23. package/dist/utils/help.js +14 -0
  24. package/docs/README.md +20 -0
  25. package/docs/apple/apiKey/create.md +26 -0
  26. package/docs/apple/apiKey/export.md +24 -0
  27. package/docs/apple/apiKey/import.md +24 -0
  28. package/docs/apple/apiKey/status.md +25 -0
  29. package/docs/apple/apiKey.md +110 -0
  30. package/docs/apple/certificate/create.md +26 -0
  31. package/docs/apple/certificate/export.md +24 -0
  32. package/docs/apple/certificate/import.md +24 -0
  33. package/docs/apple/certificate/status.md +25 -0
  34. package/docs/apple/certificate.md +110 -0
  35. package/docs/apple/login.md +30 -0
  36. package/docs/apple/status.md +21 -0
  37. package/docs/apple.md +48 -0
  38. package/docs/dashboard.md +18 -0
  39. package/docs/game/build/download.md +28 -0
  40. package/docs/game/build/list.md +31 -0
  41. package/docs/game/build.md +68 -0
  42. package/docs/game/create.md +23 -0
  43. package/docs/game/details.md +35 -0
  44. package/docs/game/export.md +26 -0
  45. package/docs/game/ios/app/addTester.md +24 -0
  46. package/docs/game/ios/app/create.md +25 -0
  47. package/docs/game/ios/app/status.md +21 -0
  48. package/docs/game/ios/app/sync.md +23 -0
  49. package/docs/game/ios/app.md +104 -0
  50. package/docs/game/ios/profile/create.md +23 -0
  51. package/docs/game/ios/profile/export.md +25 -0
  52. package/docs/game/ios/profile/import.md +25 -0
  53. package/docs/game/ios/profile/status.md +22 -0
  54. package/docs/game/ios/profile.md +106 -0
  55. package/docs/game/ios/status.md +23 -0
  56. package/docs/game/ios.md +247 -0
  57. package/docs/game/job/list.md +29 -0
  58. package/docs/game/job/status.md +30 -0
  59. package/docs/game/job.md +68 -0
  60. package/docs/game/list.md +26 -0
  61. package/docs/game/ship.md +21 -0
  62. package/docs/game/status.md +23 -0
  63. package/docs/game/wizard.md +23 -0
  64. package/docs/game.md +19 -0
  65. package/docs/help.md +21 -0
  66. package/docs/login.md +28 -0
  67. package/docs/status.md +18 -0
  68. package/oclif.manifest.json +155 -153
  69. package/package.json +17 -3
package/README.md CHANGED
@@ -12,8 +12,9 @@ Mobile Game Shipping Tool
12
12
  <!-- toc -->
13
13
  * [Introduction](#introduction)
14
14
  * [Usage](#usage)
15
- * [Commands](#commands)
15
+ * [Command Topics](#command-topics)
16
16
  <!-- tocstop -->
17
+
17
18
  # Usage
18
19
  <!-- usage -->
19
20
  ```sh-session
@@ -21,841 +22,51 @@ $ npm install -g shipthis
21
22
  $ shipthis COMMAND
22
23
  running command...
23
24
  $ shipthis (--version)
24
- shipthis/0.0.8 linux-x64 node-v20.17.0
25
+ shipthis/0.0.9 linux-x64 node-v20.17.0
25
26
  $ shipthis --help [COMMAND]
26
27
  USAGE
27
28
  $ shipthis COMMAND
28
29
  ...
29
30
  ```
30
31
  <!-- usagestop -->
31
- # Commands
32
- <!-- commands -->
33
- * [`shipthis apple apiKey create`](#shipthis-apple-apikey-create)
34
- * [`shipthis apple apiKey export FILE`](#shipthis-apple-apikey-export-file)
35
- * [`shipthis apple apiKey import FILE`](#shipthis-apple-apikey-import-file)
36
- * [`shipthis apple apiKey status`](#shipthis-apple-apikey-status)
37
- * [`shipthis apple certificate create`](#shipthis-apple-certificate-create)
38
- * [`shipthis apple certificate export FILE`](#shipthis-apple-certificate-export-file)
39
- * [`shipthis apple certificate import FILE`](#shipthis-apple-certificate-import-file)
40
- * [`shipthis apple certificate status`](#shipthis-apple-certificate-status)
41
- * [`shipthis apple login`](#shipthis-apple-login)
42
- * [`shipthis apple status`](#shipthis-apple-status)
43
- * [`shipthis dashboard`](#shipthis-dashboard)
44
- * [`shipthis game build download BUILD_ID FILE`](#shipthis-game-build-download-build_id-file)
45
- * [`shipthis game build list`](#shipthis-game-build-list)
46
- * [`shipthis game create`](#shipthis-game-create)
47
- * [`shipthis game details`](#shipthis-game-details)
48
- * [`shipthis game export GAME_ID`](#shipthis-game-export-game_id)
49
- * [`shipthis game ios app addTester`](#shipthis-game-ios-app-addtester)
50
- * [`shipthis game ios app create`](#shipthis-game-ios-app-create)
51
- * [`shipthis game ios app status`](#shipthis-game-ios-app-status)
52
- * [`shipthis game ios app sync`](#shipthis-game-ios-app-sync)
53
- * [`shipthis game ios profile create`](#shipthis-game-ios-profile-create)
54
- * [`shipthis game ios profile export FILE`](#shipthis-game-ios-profile-export-file)
55
- * [`shipthis game ios profile import FILE`](#shipthis-game-ios-profile-import-file)
56
- * [`shipthis game ios profile status`](#shipthis-game-ios-profile-status)
57
- * [`shipthis game ios status`](#shipthis-game-ios-status)
58
- * [`shipthis game job list`](#shipthis-game-job-list)
59
- * [`shipthis game job status JOB_ID`](#shipthis-game-job-status-job_id)
60
- * [`shipthis game list`](#shipthis-game-list)
61
- * [`shipthis game ship`](#shipthis-game-ship)
62
- * [`shipthis game status`](#shipthis-game-status)
63
- * [`shipthis game wizard`](#shipthis-game-wizard)
64
- * [`shipthis help [COMMAND]`](#shipthis-help-command)
65
- * [`shipthis login`](#shipthis-login)
66
- * [`shipthis status`](#shipthis-status)
67
-
68
- ## `shipthis apple apiKey create`
69
-
70
- Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis account
71
-
72
- ```
73
- USAGE
74
- $ shipthis apple apiKey create [-f] [-q]
75
-
76
- FLAGS
77
- -f, --force
78
- -q, --quiet Avoid output except for interactions and errors
79
-
80
- DESCRIPTION
81
- Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis
82
- account
83
-
84
- EXAMPLES
85
- $ shipthis apple apiKey create
86
-
87
- $ shipthis apple apiKey create --force
88
- ```
89
-
90
- _See code: [src/commands/apple/apiKey/create.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/apiKey/create.ts)_
91
-
92
- ## `shipthis apple apiKey export FILE`
93
-
94
- Saves the current App Store Connect API Key to a ZIP file
95
-
96
- ```
97
- USAGE
98
- $ shipthis apple apiKey export FILE [-f]
99
-
100
- ARGUMENTS
101
- FILE Name of the ZIP file to create
102
-
103
- FLAGS
104
- -f, --force Overwrite the file if it already exists
105
-
106
- DESCRIPTION
107
- Saves the current App Store Connect API Key to a ZIP file
108
-
109
- EXAMPLES
110
- $ shipthis apple apiKey export userApiKey.zip
111
- ```
112
-
113
- _See code: [src/commands/apple/apiKey/export.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/apiKey/export.ts)_
114
-
115
- ## `shipthis apple apiKey import FILE`
116
-
117
- Imports an App Store Connect API Key ZIP file into your ShipThis account
118
-
119
- ```
120
- USAGE
121
- $ shipthis apple apiKey import FILE [-f]
122
-
123
- ARGUMENTS
124
- FILE Name of the ZIP file to import (must be in the same format as the export)
125
-
126
- FLAGS
127
- -f, --force
128
-
129
- DESCRIPTION
130
- Imports an App Store Connect API Key ZIP file into your ShipThis account
131
-
132
- EXAMPLES
133
- $ shipthis apple apiKey import userApiKey.zip
134
- ```
135
-
136
- _See code: [src/commands/apple/apiKey/import.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/apiKey/import.ts)_
137
-
138
- ## `shipthis apple apiKey status`
139
-
140
- Displays the status of the App Store Connect API Keys in your Apple and ShipThis accounts. The API key is used to automatically publish your games to the App Store.
141
-
142
- ```
143
- USAGE
144
- $ shipthis apple apiKey status [-f]
145
-
146
- FLAGS
147
- -f, --noAppleAuth
148
-
149
- DESCRIPTION
150
- Displays the status of the App Store Connect API Keys in your Apple and ShipThis accounts. The API key is used to
151
- automatically publish your games to the App Store.
152
-
153
- EXAMPLES
154
- $ shipthis apple apiKey status
155
-
156
- $ shipthis apple apiKey status --noAppleAuth
157
- ```
158
-
159
- _See code: [src/commands/apple/apiKey/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/apiKey/status.ts)_
160
-
161
- ## `shipthis apple certificate create`
162
-
163
- Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your ShipThis account
164
-
165
- ```
166
- USAGE
167
- $ shipthis apple certificate create [-f] [-q]
168
-
169
- FLAGS
170
- -f, --force
171
- -q, --quiet Avoid output except for interactions and errors
172
-
173
- DESCRIPTION
174
- Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your
175
- ShipThis account
176
-
177
- EXAMPLES
178
- $ shipthis apple certificate create
179
-
180
- $ shipthis apple certificate create --force
181
- ```
182
-
183
- _See code: [src/commands/apple/certificate/create.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/certificate/create.ts)_
184
-
185
- ## `shipthis apple certificate export FILE`
186
-
187
- Saves the current Apple Distribution Certificate to a ZIP file.
188
-
189
- ```
190
- USAGE
191
- $ shipthis apple certificate export FILE [-f]
192
-
193
- ARGUMENTS
194
- FILE Name of the ZIP file to create
195
-
196
- FLAGS
197
- -f, --force Overwrite the file if it already exists
198
-
199
- DESCRIPTION
200
- Saves the current Apple Distribution Certificate to a ZIP file.
201
-
202
- EXAMPLES
203
- $ shipthis apple certificate export userCert.zip
204
- ```
205
-
206
- _See code: [src/commands/apple/certificate/export.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/certificate/export.ts)_
207
-
208
- ## `shipthis apple certificate import FILE`
209
-
210
- Imports an iOS Distribution Certificate to your ShipThis account
211
-
212
- ```
213
- USAGE
214
- $ shipthis apple certificate import FILE [-f]
215
-
216
- ARGUMENTS
217
- FILE Name of the ZIP file to import (must be in the same format as the export)
218
-
219
- FLAGS
220
- -f, --force
221
-
222
- DESCRIPTION
223
- Imports an iOS Distribution Certificate to your ShipThis account
224
-
225
- EXAMPLES
226
- $ shipthis apple certificate import userCert.zip
227
- ```
228
-
229
- _See code: [src/commands/apple/certificate/import.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/certificate/import.ts)_
230
-
231
- ## `shipthis apple certificate status`
232
-
233
- Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts. These are used to sign all of your iOS apps.
234
-
235
- ```
236
- USAGE
237
- $ shipthis apple certificate status [-f]
238
-
239
- FLAGS
240
- -f, --noAppleAuth
241
-
242
- DESCRIPTION
243
- Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts. These are used to sign
244
- all of your iOS apps.
245
-
246
- EXAMPLES
247
- $ shipthis apple certificate status
248
-
249
- $ shipthis apple certificate status --noAppleAuth
250
- ```
251
-
252
- _See code: [src/commands/apple/certificate/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/certificate/status.ts)_
253
-
254
- ## `shipthis apple login`
255
-
256
- Authenticate with Apple - saves the session to the auth file
257
-
258
- ```
259
- USAGE
260
- $ shipthis apple login [-q] [-f] [-e <value>]
261
-
262
- FLAGS
263
- -e, --appleEmail=<value> Your Apple email address
264
- -f, --force
265
- -q, --quiet Avoid output except for interactions and errors
266
-
267
- DESCRIPTION
268
- Authenticate with Apple - saves the session to the auth file
269
-
270
- EXAMPLES
271
- $ shipthis apple login
272
-
273
- $ shipthis apple login --force --appleEmail me@email.nowhere
274
- ```
275
-
276
- _See code: [src/commands/apple/login.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/login.ts)_
277
-
278
- ## `shipthis apple status`
279
-
280
- Shows the status of the Apple authentication and integration
281
-
282
- ```
283
- USAGE
284
- $ shipthis apple status
285
-
286
- DESCRIPTION
287
- Shows the status of the Apple authentication and integration
288
-
289
- EXAMPLES
290
- $ shipthis apple status
291
- ```
292
-
293
- _See code: [src/commands/apple/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/apple/status.ts)_
294
-
295
- ## `shipthis dashboard`
296
-
297
- Opens the web-browser to your ShipThis dashboard
298
-
299
- ```
300
- USAGE
301
- $ shipthis dashboard
302
-
303
- DESCRIPTION
304
- Opens the web-browser to your ShipThis dashboard
305
-
306
- EXAMPLES
307
- $ shipthis dashboard
308
- ```
309
-
310
- _See code: [src/commands/dashboard.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/dashboard.ts)_
311
-
312
- ## `shipthis game build download BUILD_ID FILE`
313
-
314
- Downloads the given build artifact to the specified file
315
-
316
- ```
317
- USAGE
318
- $ shipthis game build download BUILD_ID FILE [-g <value>] [-f]
319
-
320
- ARGUMENTS
321
- BUILD_ID The ID of the build to download
322
- FILE Name of the file to output
323
-
324
- FLAGS
325
- -f, --force Overwrite the file if it already exists
326
- -g, --gameId=<value> The ID of the game
327
-
328
- DESCRIPTION
329
- Downloads the given build artifact to the specified file
330
-
331
- EXAMPLES
332
- $ shipthis game build download 7a3f5c92 output.ipa
333
-
334
- $ shipthis game build download --gameId 0c179fc4 e4b9a3d7 output.apk
335
- ```
336
-
337
- _See code: [src/commands/game/build/download.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/build/download.ts)_
338
-
339
- ## `shipthis game build list`
340
-
341
- Lists the builds for successful jobs of a game.
342
-
343
- ```
344
- USAGE
345
- $ shipthis game build list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
346
-
347
- FLAGS
348
- -g, --gameId=<value> The ID of the game
349
- -o, --orderBy=<option> [default: createdAt] The field to order by
350
- <options: createdAt|updatedAt>
351
- -p, --pageNumber=<value> The page number to show (starts at 0)
352
- -r, --order=<option> [default: desc] The order to sort by
353
- <options: asc|desc>
354
- -s, --pageSize=<value> [default: 10] The number of items to show per page
355
-
356
- DESCRIPTION
357
- Lists the builds for successful jobs of a game.
358
-
359
- EXAMPLES
360
- $ shipthis game build list
361
-
362
- $ shipthis game build list --gameId 0c179fc4
363
-
364
- $ shipthis game build list --gameId 0c179fc4 --pageSize 20 --pageNumber 1
365
- ```
366
-
367
- _See code: [src/commands/game/build/list.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/build/list.ts)_
368
-
369
- ## `shipthis game create`
370
-
371
- Create a new game
372
-
373
- ```
374
- USAGE
375
- $ shipthis game create [-q] [-f] [-n <value>]
376
-
377
- FLAGS
378
- -f, --force
379
- -n, --name=<value> The name of the game
380
- -q, --quiet Avoid output except for interactions and errors
381
-
382
- DESCRIPTION
383
- Create a new game
384
-
385
- EXAMPLES
386
- $ shipthis game create
387
- ```
388
-
389
- _See code: [src/commands/game/create.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/create.ts)_
390
-
391
- ## `shipthis game details`
392
-
393
- Shows and sets the details of a game. If --gameId is not provided it will look in the current directory.
394
-
395
- ```
396
- USAGE
397
- $ shipthis game details [-g <value>] [-f] [-b <value>] [-s <value>] [-e <value>] [-v <value>] [-i <value>] [-a
398
- <value>]
399
-
400
- FLAGS
401
- -a, --androidPackageName=<value> Set the Android package name
402
- -b, --buildNumber=<value> Set the build number
403
- -e, --gameEngine=<value> Set the game engine
404
- -f, --force Force the command to run
405
- -g, --gameId=<value> The ID of the game
406
- -i, --iosBundleId=<value> Set the iOS bundle ID
407
- -s, --semanticVersion=<value> Set the semantic version
408
- -v, --gameEngineVersion=<value> Set the game engine version
409
-
410
- DESCRIPTION
411
- Shows and sets the details of a game. If --gameId is not provided it will look in the current directory.
412
-
413
- EXAMPLES
414
- $ shipthis game details
415
-
416
- $ shipthis game details --gameId 0c179fc4
417
-
418
- $ shipthis game details --buildNumber 5 --semanticVersion 1.2.3
419
-
420
- $ shipthis game details --gameEngine godot --gameEngineVersion 4.2 --force
421
- ```
422
-
423
- _See code: [src/commands/game/details.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/details.ts)_
424
-
425
- ## `shipthis game export GAME_ID`
426
-
427
- Downloads the shipthis.json file for a given game into the current directory.
428
-
429
- ```
430
- USAGE
431
- $ shipthis game export GAME_ID [-f]
432
-
433
- ARGUMENTS
434
- GAME_ID The ID of the game to export (use "list" to get the ID)
435
-
436
- FLAGS
437
- -f, --force
438
-
439
- DESCRIPTION
440
- Downloads the shipthis.json file for a given game into the current directory.
441
-
442
- EXAMPLES
443
- $ shipthis game export abcd1234
444
-
445
- $ shipthis game export abcd1234 --force
446
- ```
447
-
448
- _See code: [src/commands/game/export.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/export.ts)_
449
-
450
- ## `shipthis game ios app addTester`
451
-
452
- Adds a test user to the game in App Store Connect.
453
-
454
- ```
455
- USAGE
456
- $ shipthis game ios app addTester [-g <value>] [-e <value>] [-f <value>] [-l <value>]
457
32
 
458
- FLAGS
459
- -e, --email=<value> The email address of the tester
460
- -f, --firstName=<value> The first name of the tester
461
- -g, --gameId=<value> The ID of the game
462
- -l, --lastName=<value> The last name of the tester
463
-
464
- DESCRIPTION
465
- Adds a test user to the game in App Store Connect.
466
-
467
- EXAMPLES
468
- $ shipthis game ios app addTester
469
- ```
470
-
471
- _See code: [src/commands/game/ios/app/addTester.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/app/addTester.ts)_
472
-
473
- ## `shipthis game ios app create`
474
-
475
- Creates an App and BundleId in the Apple Developer Portal. If --gameId is not provided it will look in the current directory.
476
-
477
- ```
478
- USAGE
479
- $ shipthis game ios app create [-q] [-g <value>] [-n <value>] [-b <value>] [-f]
480
-
481
- FLAGS
482
- -b, --bundleId=<value> The BundleId in the Apple Developer Portal
483
- -f, --force
484
- -g, --gameId=<value> The ID of the game
485
- -n, --appName=<value> The name of the App in the Apple Developer Portal
486
- -q, --quiet Avoid output except for interactions and errors
487
-
488
- DESCRIPTION
489
- Creates an App and BundleId in the Apple Developer Portal. If --gameId is not provided it will look in the current
490
- directory.
491
-
492
- EXAMPLES
493
- $ shipthis game ios app create
494
- ```
495
-
496
- _See code: [src/commands/game/ios/app/create.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/app/create.ts)_
497
-
498
- ## `shipthis game ios app status`
499
-
500
- Shows the Game iOS App status. If --gameId is not provided it will look in the current directory.
501
-
502
- ```
503
- USAGE
504
- $ shipthis game ios app status [-g <value>]
505
-
506
- FLAGS
507
- -g, --gameId=<value> The ID of the game
508
-
509
- DESCRIPTION
510
- Shows the Game iOS App status. If --gameId is not provided it will look in the current directory.
511
-
512
- EXAMPLES
513
- $ shipthis game ios app status
514
- ```
515
-
516
- _See code: [src/commands/game/ios/app/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/app/status.ts)_
517
-
518
- ## `shipthis game ios app sync`
519
-
520
- Synchronies the Apple App "BundleId" with the capabilities from the local project. If --gameId is not provided it will look in the current directory.
521
-
522
- ```
523
- USAGE
524
- $ shipthis game ios app sync [-q] [-g <value>] [-f]
525
-
526
- FLAGS
527
- -f, --force
528
- -g, --gameId=<value> The ID of the game
529
- -q, --quiet Avoid output except for interactions and errors
530
-
531
- DESCRIPTION
532
- Synchronies the Apple App "BundleId" with the capabilities from the local project. If --gameId is not provided it will
533
- look in the current directory.
534
-
535
- EXAMPLES
536
- $ shipthis game ios app sync
537
- ```
538
-
539
- _See code: [src/commands/game/ios/app/sync.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/app/sync.ts)_
540
-
541
- ## `shipthis game ios profile create`
542
-
543
- Creates a Mobile Provisioning Profile in the Apple Developer Portal. If --gameId is not provided it will look in the current directory.
544
-
545
- ```
546
- USAGE
547
- $ shipthis game ios profile create [-q] [-g <value>] [-f]
548
-
549
- FLAGS
550
- -f, --force
551
- -g, --gameId=<value> The ID of the game
552
- -q, --quiet Avoid output except for interactions and errors
553
-
554
- DESCRIPTION
555
- Creates a Mobile Provisioning Profile in the Apple Developer Portal. If --gameId is not provided it will look in the
556
- current directory.
557
-
558
- EXAMPLES
559
- $ shipthis game ios profile create
560
- ```
561
-
562
- _See code: [src/commands/game/ios/profile/create.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/profile/create.ts)_
563
-
564
- ## `shipthis game ios profile export FILE`
565
-
566
- Saves the current Mobile Provisioning Profile to a ZIP file
567
-
568
- ```
569
- USAGE
570
- $ shipthis game ios profile export FILE [-g <value>] [-f]
571
-
572
- ARGUMENTS
573
- FILE Name of the ZIP file to create
574
-
575
- FLAGS
576
- -f, --force Overwrite the file if it already exists
577
- -g, --gameId=<value> The ID of the game
578
-
579
- DESCRIPTION
580
- Saves the current Mobile Provisioning Profile to a ZIP file
581
-
582
- EXAMPLES
583
- $ shipthis game ios profile export userProfile.zip
584
- ```
585
-
586
- _See code: [src/commands/game/ios/profile/export.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/profile/export.ts)_
587
-
588
- ## `shipthis game ios profile import FILE`
589
-
590
- Imports an Mobile Provisioning Profile to your ShipThis account
591
-
592
- ```
593
- USAGE
594
- $ shipthis game ios profile import FILE [-g <value>] [-f]
595
-
596
- ARGUMENTS
597
- FILE Name of the ZIP file to import (must be in the same format as the export)
598
-
599
- FLAGS
600
- -f, --force
601
- -g, --gameId=<value> The ID of the game
602
-
603
- DESCRIPTION
604
- Imports an Mobile Provisioning Profile to your ShipThis account
605
-
606
- EXAMPLES
607
- $ shipthis game ios profile import profile.zip
608
- ```
609
-
610
- _See code: [src/commands/game/ios/profile/import.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/profile/import.ts)_
611
-
612
- ## `shipthis game ios profile status`
613
-
614
- Shows the Game iOS Mobile Provisioning Profile Status. If --gameId is not provided it will look in the current directory.
615
-
616
- ```
617
- USAGE
618
- $ shipthis game ios profile status [-g <value>] [-f]
619
-
620
- FLAGS
621
- -f, --noAppleAuth
622
- -g, --gameId=<value> The ID of the game
623
-
624
- DESCRIPTION
625
- Shows the Game iOS Mobile Provisioning Profile Status. If --gameId is not provided it will look in the current
626
- directory.
627
-
628
- EXAMPLES
629
- $ shipthis game ios profile status
630
- ```
631
-
632
- _See code: [src/commands/game/ios/profile/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/profile/status.ts)_
633
-
634
- ## `shipthis game ios status`
635
-
636
- Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
637
-
638
- ```
639
- USAGE
640
- $ shipthis game ios status [-g <value>]
641
-
642
- FLAGS
643
- -g, --gameId=<value> The ID of the game
644
-
645
- DESCRIPTION
646
- Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
647
-
648
- EXAMPLES
649
- $ shipthis game ios status
650
-
651
- $ shipthis game ios status --gameId 0c179fc4
652
- ```
653
-
654
- _See code: [src/commands/game/ios/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ios/status.ts)_
655
-
656
- ## `shipthis game job list`
657
-
658
- Lists the jobs for a game. If --gameId is not provided it will look in the current directory.
659
-
660
- ```
661
- USAGE
662
- $ shipthis game job list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
663
-
664
- FLAGS
665
- -g, --gameId=<value> The ID of the game
666
- -o, --orderBy=<option> [default: createdAt] The field to order by
667
- <options: createdAt|updatedAt>
668
- -p, --pageNumber=<value> The page number to show (starts at 0)
669
- -r, --order=<option> [default: desc] The order to sort by
670
- <options: asc|desc>
671
- -s, --pageSize=<value> [default: 10] The number of items to show per page
672
-
673
- DESCRIPTION
674
- Lists the jobs for a game. If --gameId is not provided it will look in the current directory.
675
-
676
- EXAMPLES
677
- $ shipthis game job list
678
-
679
- $ shipthis game job list --gameId 0c179fc4
680
- ```
681
-
682
- _See code: [src/commands/game/job/list.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/job/list.ts)_
683
-
684
- ## `shipthis game job status JOB_ID`
685
-
686
- Shows the real-time status of a job.
687
-
688
- ```
689
- USAGE
690
- $ shipthis game job status JOB_ID [-g <value>] [-n <value>] [-f]
691
-
692
- ARGUMENTS
693
- JOB_ID The id of the job to get the status of
694
-
695
- FLAGS
696
- -f, --follow Follow the log in real-time
697
- -g, --gameId=<value> The ID of the game
698
- -n, --lines=<value> [default: 10] The number of lines to show
699
-
700
- DESCRIPTION
701
- Shows the real-time status of a job.
702
-
703
- EXAMPLES
704
- $ shipthis game job status 4d32239e
705
-
706
- $ shipthis game job status --gameId 0c179fc4 4d32239e
707
-
708
- $ shipthis game job status --gameId 0c179fc4 --lines 20 --follow 4d32239e
709
- ```
710
-
711
- _See code: [src/commands/game/job/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/job/status.ts)_
712
-
713
- ## `shipthis game list`
714
-
715
- Shows a list of all your games
716
-
717
- ```
718
- USAGE
719
- $ shipthis game list [-p <value>] [-s <value>] [-o createdAt|updatedAt|name] [-r asc|desc]
720
-
721
- FLAGS
722
- -o, --orderBy=<option> [default: createdAt] The field to order by
723
- <options: createdAt|updatedAt|name>
724
- -p, --pageNumber=<value> The page number to show (starts at 0)
725
- -r, --order=<option> [default: desc] The order to sort by
726
- <options: asc|desc>
727
- -s, --pageSize=<value> [default: 10] The number of items to show per page
728
-
729
- DESCRIPTION
730
- Shows a list of all your games
731
-
732
- EXAMPLES
733
- $ shipthis game list
734
- ```
735
-
736
- _See code: [src/commands/game/list.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/list.ts)_
737
-
738
- ## `shipthis game ship`
739
-
740
- Builds the app (for all platforms with valid credentials) and ships it to the stores
741
-
742
- ```
743
- USAGE
744
- $ shipthis game ship [-g <value>]
745
-
746
- FLAGS
747
- -g, --gameId=<value> The ID of the game
748
-
749
- DESCRIPTION
750
- Builds the app (for all platforms with valid credentials) and ships it to the stores
751
-
752
- EXAMPLES
753
- $ shipthis game ship
754
- ```
755
-
756
- _See code: [src/commands/game/ship.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/ship.ts)_
757
-
758
- ## `shipthis game status`
759
-
760
- Shows the Game status. If --gameId is not provided it will look in the current directory.
761
-
762
- ```
763
- USAGE
764
- $ shipthis game status [-g <value>]
765
-
766
- FLAGS
767
- -g, --gameId=<value> The ID of the game
768
-
769
- DESCRIPTION
770
- Shows the Game status. If --gameId is not provided it will look in the current directory.
771
-
772
- EXAMPLES
773
- $ shipthis game status
774
-
775
- $ shipthis game status --gameId 0c179fc4
776
- ```
777
-
778
- _See code: [src/commands/game/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/status.ts)_
779
-
780
- ## `shipthis game wizard`
781
-
782
- Runs all the steps for the specific platform
783
-
784
- ```
785
- USAGE
786
- $ shipthis game wizard -p ios [-f <value>]
787
-
788
- FLAGS
789
- -f, --forceStep=<value> Force a specific step to run. You can repeat this flag to force multiple steps.
790
- -p, --platform=<option> (required) The platform to run the wizard for
791
- <options: ios>
792
-
793
- DESCRIPTION
794
- Runs all the steps for the specific platform
795
-
796
- EXAMPLES
797
- $ shipthis game wizard
798
- ```
799
-
800
- _See code: [src/commands/game/wizard.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/game/wizard.ts)_
801
-
802
- ## `shipthis help [COMMAND]`
803
-
804
- Display help for shipthis.
805
-
806
- ```
807
- USAGE
808
- $ shipthis help [COMMAND...] [-n]
809
-
810
- ARGUMENTS
811
- COMMAND... Command to show help for.
812
-
813
- FLAGS
814
- -n, --nested-commands Include all nested commands in the output.
815
-
816
- DESCRIPTION
817
- Display help for shipthis.
818
- ```
819
-
820
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.10/src/commands/help.ts)_
821
-
822
- ## `shipthis login`
823
-
824
- Authenticate - will create a new account if one does not exist.
825
-
826
- ```
827
- USAGE
828
- $ shipthis login [-f] [-e <value>]
829
-
830
- FLAGS
831
- -e, --email=<value> Your email address
832
- -f, --force
833
-
834
- DESCRIPTION
835
- Authenticate - will create a new account if one does not exist.
836
-
837
- EXAMPLES
838
- $ shipthis login
839
-
840
- $ shipthis login --force --email me@email.nowhere
841
- ```
842
-
843
- _See code: [src/commands/login.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/login.ts)_
844
-
845
- ## `shipthis status`
846
-
847
- Displays the current overall status.
848
-
849
- ```
850
- USAGE
851
- $ shipthis status
852
-
853
- DESCRIPTION
854
- Displays the current overall status.
855
-
856
- EXAMPLES
857
- $ shipthis status
858
- ```
33
+ <!-- commands -->
34
+ # Command Topics
35
+
36
+ * [`shipthis apple`](./docs/apple.md) - Commands related to Apple Developer Portal
37
+ * [`shipthis apple apiKey`](docs/apple/apiKey.md) - Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis account
38
+ * [`shipthis apple apiKey create`](docs/apple/apiKey/create.md) - Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis account
39
+ * [`shipthis apple apiKey export`](docs/apple/apiKey/export.md) - Saves the current App Store Connect API Key to a ZIP file
40
+ * [`shipthis apple apiKey import`](docs/apple/apiKey/import.md) - Imports an App Store Connect API Key ZIP file into your ShipThis account
41
+ * [`shipthis apple apiKey status`](docs/apple/apiKey/status.md) - Displays the status of the App Store Connect API Keys in your Apple and ShipThis accounts. The API key is used to automatically publish your games to the App Store.
42
+ * [`shipthis apple certificate`](docs/apple/certificate.md) - Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your ShipThis account
43
+ * [`shipthis apple certificate create`](docs/apple/certificate/create.md) - Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your ShipThis account
44
+ * [`shipthis apple certificate export`](docs/apple/certificate/export.md) - Saves the current Apple Distribution Certificate to a ZIP file.
45
+ * [`shipthis apple certificate import`](docs/apple/certificate/import.md) - Imports an iOS Distribution Certificate to your ShipThis account
46
+ * [`shipthis apple certificate status`](docs/apple/certificate/status.md) - Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts. These are used to sign all of your iOS apps.
47
+ * [`shipthis apple login`](docs/apple/login.md) - Authenticate with Apple - saves the session to the auth file
48
+ * [`shipthis apple status`](docs/apple/status.md) - Shows the status of the Apple authentication and integration
49
+ * [`shipthis dashboard`](docs/dashboard.md) - Opens the web-browser to your ShipThis dashboard
50
+ * [`shipthis game`](docs/game.md) - Commands related to Game Management
51
+ * [`shipthis game build`](docs/game/build.md) - Commands related to builds for a specific game
52
+ * [`shipthis game build download`](docs/game/build/download.md) - Downloads the given build artifact to the specified file
53
+ * [`shipthis game build list`](docs/game/build/list.md) - Lists the builds for successful jobs of a game.
54
+ * [`shipthis game create`](docs/game/create.md) - Create a new game
55
+ * [`shipthis game details`](docs/game/details.md) - Shows and sets the details of a game. If --gameId is not provided it will look in the current directory.
56
+ * [`shipthis game export`](docs/game/export.md) - Downloads the shipthis.json file for a given game into the current directory.
57
+ * [`shipthis game ios`](docs/game/ios.md) - Commands related to the iOS platform for a specific game
58
+ * [`shipthis game ios app`](docs/game/ios/app.md) - Commands related to the App Store App for a specific game
59
+ * [`shipthis game ios profile`](docs/game/ios/profile.md) - Commands related to the App Store Provisioning Profiles for this Game
60
+ * [`shipthis game ios status`](docs/game/ios/status.md) - Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
61
+ * [`shipthis game job`](docs/game/job.md) - Commands related to jobs for a specific game
62
+ * [`shipthis game job list`](docs/game/job/list.md) - Lists the jobs for a game. If --gameId is not provided it will look in the current directory.
63
+ * [`shipthis game job status`](docs/game/job/status.md) - Shows the real-time status of a job.
64
+ * [`shipthis game list`](docs/game/list.md) - Shows a list of all your games
65
+ * [`shipthis game ship`](docs/game/ship.md) - Builds the app (for all platforms with valid credentials) and ships it to the stores
66
+ * [`shipthis game status`](docs/game/status.md) - Shows the Game status. If --gameId is not provided it will look in the current directory.
67
+ * [`shipthis game wizard`](docs/game/wizard.md) - Runs all the steps for the specific platform
68
+ * [`shipthis help`](docs/help.md) - Display help for shipthis.
69
+ * [`shipthis login`](docs/login.md) - Authenticate - will create a new account if one does not exist.
70
+ * [`shipthis status`](docs/status.md) - Displays the current overall status.
859
71
 
860
- _See code: [src/commands/status.ts](https://gitlab.com/shipthis.cc/shipthis-cli/blob/v0.0.8/src/commands/status.ts)_
861
72
  <!-- commandsstop -->