shipthis 0.0.23 → 0.0.24

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 (44) hide show
  1. package/docs/apple/login.md +11 -0
  2. package/docs/apple/status.md +6 -2
  3. package/docs/apple.md +1 -1
  4. package/docs/dashboard.md +13 -1
  5. package/docs/game/create.md +16 -3
  6. package/docs/game/details.md +21 -4
  7. package/docs/game.md +2 -2
  8. package/docs/help.md +1 -1
  9. package/oclif.manifest.json +37 -37
  10. package/package.json +1 -1
  11. package/docs/apple/apiKey/create +0 -26
  12. package/docs/apple/apiKey/export +0 -24
  13. package/docs/apple/apiKey/import +0 -24
  14. package/docs/apple/apiKey/status +0 -25
  15. package/docs/apple/certificate/create +0 -26
  16. package/docs/apple/certificate/export +0 -24
  17. package/docs/apple/certificate/import +0 -24
  18. package/docs/apple/certificate/status +0 -25
  19. package/docs/apple/login +0 -25
  20. package/docs/apple/status +0 -18
  21. package/docs/dashboard +0 -18
  22. package/docs/game/build/download +0 -28
  23. package/docs/game/build/list +0 -31
  24. package/docs/game/create +0 -23
  25. package/docs/game/details +0 -35
  26. package/docs/game/export +0 -26
  27. package/docs/game/ios/app/addTester +0 -24
  28. package/docs/game/ios/app/create +0 -25
  29. package/docs/game/ios/app/status +0 -21
  30. package/docs/game/ios/app/sync +0 -23
  31. package/docs/game/ios/profile/create +0 -23
  32. package/docs/game/ios/profile/export +0 -25
  33. package/docs/game/ios/profile/import +0 -25
  34. package/docs/game/ios/profile/status +0 -22
  35. package/docs/game/ios/status +0 -23
  36. package/docs/game/job/list +0 -29
  37. package/docs/game/job/status +0 -30
  38. package/docs/game/list +0 -26
  39. package/docs/game/ship +0 -21
  40. package/docs/game/status +0 -23
  41. package/docs/game/wizard +0 -23
  42. package/docs/help +0 -21
  43. package/docs/login +0 -24
  44. package/docs/status +0 -18
@@ -4,6 +4,17 @@
4
4
 
5
5
  Authenticate with Apple - saves the session to the auth file.
6
6
 
7
+ :::note
8
+ Your Apple Developer credentials never leave your local computer. We recommend
9
+ enabling [two-factor authentication (2FA)](https://support.apple.com/kb/HT204915)
10
+ for your Apple ID.
11
+ :::
12
+
13
+ ShipThis makes use of Apple's APIs to manage your signing certificates, API keys,
14
+ provisioning profiles, bundleIds and apps within the Apple Developer Portal on
15
+ your behalf. To do this, ShipThis generates temporary session cookies which it re-uses between the various
16
+ [apple commands](/docs/reference/apple).
17
+
7
18
  ## Example
8
19
 
9
20
  [![asciicast](https://asciinema.org/a/h2wLhEFVy8mLA5dE6hb1gHDyD.svg)](https://asciinema.org/a/h2wLhEFVy8mLA5dE6hb1gHDyD)
@@ -2,11 +2,15 @@
2
2
 
3
3
  ## Description
4
4
 
5
- Shows the status of the Apple authentication and integration
5
+ Shows the status of the Apple authentication and integration.
6
+
7
+ If you have authenticated against Apple, it will show **"YES"** for "Authenticated on Apple Developer Portal".
8
+
9
+ To authenticate, please run [`shipthis apple login`](/docs/reference/apple/login).
6
10
 
7
11
  ## Example
8
12
 
9
- [![asciicast](https://asciinema.org/a/g4hSnl66PE7xz7FGmeMwBdqoN.svg)](https://asciinema.org/a/g4hSnl66PE7xz7FGmeMwBdqoN)
13
+ [![asciicast](https://asciinema.org/a/PPSZ5EUxbdnd3IqCk6vtb2Bmw.svg)](https://asciinema.org/a/PPSZ5EUxbdnd3IqCk6vtb2Bmw)
10
14
 
11
15
  ## Help Output
12
16
  ```
package/docs/apple.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Apple Commands
2
2
 
3
- Commands in the Apple topic are prefixed `shithis apple`. They relate to linking your ShipThis account with your Apple Developer Account. You need to be authenticated against ShipThis (by running `shipthis login`) before running the Apple commands.
3
+ Commands in the Apple topic are prefixed `shithis apple`. They relate to linking your ShipThis account with your Apple Developer Account. You need to be authenticated against ShipThis (by running [`shipthis login`](/docs/reference/login)) before running the Apple commands.
4
4
 
5
5
  ## Status
6
6
 
package/docs/dashboard.md CHANGED
@@ -2,7 +2,19 @@
2
2
 
3
3
  ## Description
4
4
 
5
- Opens the web-browser to your ShipThis dashboard
5
+ Opens the web-browser to your ShipThis dashboard.
6
+
7
+ :::note
8
+ ShipThis generates single-use links which will automatically log you into shipthis.cc in your browser.
9
+ :::
10
+
11
+
12
+
13
+ You need to have authenticated with [`shipthis login`](/docs/reference/login) first.
14
+
15
+ ## Example
16
+
17
+ [![asciicast](https://asciinema.org/a/J7A5mafE3kCM6yGLpuVBmEQgh.svg)](https://asciinema.org/a/J7A5mafE3kCM6yGLpuVBmEQgh)
6
18
 
7
19
  ## Help Output
8
20
 
@@ -1,12 +1,25 @@
1
1
  # game create
2
2
 
3
+ ## Description
4
+
5
+ Creates a new game in your [ShipThis account](https://shipthis.cc/games).
6
+
7
+ It will read the name of your game from your `project.godot` file. You will be
8
+ prompted to confirm this name, or you can specify one with the `--name` flag.
9
+
10
+ If there is already a ShipThis game config file (`shithis.json`) in the current
11
+ directory then you will need to use the `--force` flag to create a new game and
12
+ overwrite this file with the config for the new game.
13
+
14
+ ShipThis will detect the version of Godot you are using from your `project.godot`
15
+ file. This can be changed with the [`shipthis game details`](/docs/reference/game/details)
16
+ command.
17
+
3
18
  ## Example
4
19
 
5
20
  [![asciicast](https://asciinema.org/a/Oxf8qnYoVViPNVA40EXKBWG36.svg)](https://asciinema.org/a/Oxf8qnYoVViPNVA40EXKBWG36)
6
21
 
7
- ## Description
8
22
 
9
- Create a new game in ShipThis.
10
23
 
11
24
  ## Help Output
12
25
 
@@ -24,4 +37,4 @@ DESCRIPTION
24
37
 
25
38
  EXAMPLES
26
39
  $ shipthis game create
27
- ```
40
+ ```
@@ -1,12 +1,29 @@
1
1
  # game details
2
2
 
3
- ## Example
3
+ ## Description
4
4
 
5
- [![asciicast](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr.svg)](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr)
5
+ Shows and sets the details of the current game.
6
6
 
7
- ## Description
7
+ If you run the command without any flags it will show the details of the current
8
+ game.
9
+
10
+ You can edit any of the values using the appropriate flag. After changing the
11
+ value, it will output all the values again.
12
+
13
+ The following fields can only be changed if you have the `--force` flag set:
8
14
 
9
- Shows and sets the details of a game.
15
+ - `--gameEngine` - Change the Game Engine (currently only "godot" is supported)
16
+ - `--gameEngineVersion` - Change the version of the Game Engine (currently only 3.6 and 4.3 are supported)
17
+ - `--iosBundleId` - iOS Bundle ID
18
+ - `--androidPackageName` Android Package Name (not currently used)
19
+
20
+ :::tip
21
+ After changing these values, you will need to trigger a new build of your game with [`shipthis game ship`](/docs/reference/game/ship)
22
+ :::
23
+
24
+ ## Example
25
+
26
+ [![asciicast](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr.svg)](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr)
10
27
 
11
28
  ## Help Output
12
29
 
package/docs/game.md CHANGED
@@ -8,8 +8,8 @@ You will need to be authenticated against ShipThis (by running [`shipthis login`
8
8
  ## Topics
9
9
 
10
10
  - [game build](/docs/reference/game/build)
11
- - [game ios](/docs/reference/game//ios)
12
- - [game job](/docs/reference/game//job)
11
+ - [game ios](/docs/reference/game/ios)
12
+ - [game job](/docs/reference/game/job)
13
13
 
14
14
  ## Commands
15
15
 
package/docs/help.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Description
4
4
 
5
- Display help for <%= config.bin %>.
5
+ Display help for shipthis.
6
6
 
7
7
  ## Help Output
8
8
 
@@ -514,10 +514,10 @@
514
514
  "wizard.js"
515
515
  ]
516
516
  },
517
- "apple:certificate:create": {
517
+ "apple:apiKey:create": {
518
518
  "aliases": [],
519
519
  "args": {},
520
- "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
520
+ "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
521
521
  "examples": [
522
522
  "<%= config.bin %> <%= command.id %>",
523
523
  "<%= config.bin %> <%= command.id %> --force"
@@ -539,7 +539,7 @@
539
539
  },
540
540
  "hasDynamicHelp": false,
541
541
  "hiddenAliases": [],
542
- "id": "apple:certificate:create",
542
+ "id": "apple:apiKey:create",
543
543
  "pluginAlias": "shipthis",
544
544
  "pluginName": "shipthis",
545
545
  "pluginType": "core",
@@ -549,11 +549,11 @@
549
549
  "dist",
550
550
  "commands",
551
551
  "apple",
552
- "certificate",
552
+ "apiKey",
553
553
  "create.js"
554
554
  ]
555
555
  },
556
- "apple:certificate:export": {
556
+ "apple:apiKey:export": {
557
557
  "aliases": [],
558
558
  "args": {
559
559
  "file": {
@@ -562,9 +562,9 @@
562
562
  "required": true
563
563
  }
564
564
  },
565
- "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
565
+ "description": "Saves the current App Store Connect API Key to a ZIP file",
566
566
  "examples": [
567
- "<%= config.bin %> <%= command.id %> userCert.zip"
567
+ "<%= config.bin %> <%= command.id %> userApiKey.zip"
568
568
  ],
569
569
  "flags": {
570
570
  "force": {
@@ -577,7 +577,7 @@
577
577
  },
578
578
  "hasDynamicHelp": false,
579
579
  "hiddenAliases": [],
580
- "id": "apple:certificate:export",
580
+ "id": "apple:apiKey:export",
581
581
  "pluginAlias": "shipthis",
582
582
  "pluginName": "shipthis",
583
583
  "pluginType": "core",
@@ -588,11 +588,11 @@
588
588
  "dist",
589
589
  "commands",
590
590
  "apple",
591
- "certificate",
591
+ "apiKey",
592
592
  "export.js"
593
593
  ]
594
594
  },
595
- "apple:certificate:import": {
595
+ "apple:apiKey:import": {
596
596
  "aliases": [],
597
597
  "args": {
598
598
  "file": {
@@ -601,9 +601,9 @@
601
601
  "required": true
602
602
  }
603
603
  },
604
- "description": "Imports an iOS Distribution Certificate to your ShipThis account",
604
+ "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
605
605
  "examples": [
606
- "<%= config.bin %> <%= command.id %> userCert.zip"
606
+ "<%= config.bin %> <%= command.id %> userApiKey.zip"
607
607
  ],
608
608
  "flags": {
609
609
  "force": {
@@ -615,7 +615,7 @@
615
615
  },
616
616
  "hasDynamicHelp": false,
617
617
  "hiddenAliases": [],
618
- "id": "apple:certificate:import",
618
+ "id": "apple:apiKey:import",
619
619
  "pluginAlias": "shipthis",
620
620
  "pluginName": "shipthis",
621
621
  "pluginType": "core",
@@ -626,14 +626,14 @@
626
626
  "dist",
627
627
  "commands",
628
628
  "apple",
629
- "certificate",
629
+ "apiKey",
630
630
  "import.js"
631
631
  ]
632
632
  },
633
- "apple:certificate:status": {
633
+ "apple:apiKey:status": {
634
634
  "aliases": [],
635
635
  "args": {},
636
- "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.",
636
+ "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
637
637
  "examples": [
638
638
  "<%= config.bin %> <%= command.id %>",
639
639
  "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -648,7 +648,7 @@
648
648
  },
649
649
  "hasDynamicHelp": false,
650
650
  "hiddenAliases": [],
651
- "id": "apple:certificate:status",
651
+ "id": "apple:apiKey:status",
652
652
  "pluginAlias": "shipthis",
653
653
  "pluginName": "shipthis",
654
654
  "pluginType": "core",
@@ -659,14 +659,14 @@
659
659
  "dist",
660
660
  "commands",
661
661
  "apple",
662
- "certificate",
662
+ "apiKey",
663
663
  "status.js"
664
664
  ]
665
665
  },
666
- "apple:apiKey:create": {
666
+ "apple:certificate:create": {
667
667
  "aliases": [],
668
668
  "args": {},
669
- "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
669
+ "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
670
670
  "examples": [
671
671
  "<%= config.bin %> <%= command.id %>",
672
672
  "<%= config.bin %> <%= command.id %> --force"
@@ -688,7 +688,7 @@
688
688
  },
689
689
  "hasDynamicHelp": false,
690
690
  "hiddenAliases": [],
691
- "id": "apple:apiKey:create",
691
+ "id": "apple:certificate:create",
692
692
  "pluginAlias": "shipthis",
693
693
  "pluginName": "shipthis",
694
694
  "pluginType": "core",
@@ -698,11 +698,11 @@
698
698
  "dist",
699
699
  "commands",
700
700
  "apple",
701
- "apiKey",
701
+ "certificate",
702
702
  "create.js"
703
703
  ]
704
704
  },
705
- "apple:apiKey:export": {
705
+ "apple:certificate:export": {
706
706
  "aliases": [],
707
707
  "args": {
708
708
  "file": {
@@ -711,9 +711,9 @@
711
711
  "required": true
712
712
  }
713
713
  },
714
- "description": "Saves the current App Store Connect API Key to a ZIP file",
714
+ "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
715
715
  "examples": [
716
- "<%= config.bin %> <%= command.id %> userApiKey.zip"
716
+ "<%= config.bin %> <%= command.id %> userCert.zip"
717
717
  ],
718
718
  "flags": {
719
719
  "force": {
@@ -726,7 +726,7 @@
726
726
  },
727
727
  "hasDynamicHelp": false,
728
728
  "hiddenAliases": [],
729
- "id": "apple:apiKey:export",
729
+ "id": "apple:certificate:export",
730
730
  "pluginAlias": "shipthis",
731
731
  "pluginName": "shipthis",
732
732
  "pluginType": "core",
@@ -737,11 +737,11 @@
737
737
  "dist",
738
738
  "commands",
739
739
  "apple",
740
- "apiKey",
740
+ "certificate",
741
741
  "export.js"
742
742
  ]
743
743
  },
744
- "apple:apiKey:import": {
744
+ "apple:certificate:import": {
745
745
  "aliases": [],
746
746
  "args": {
747
747
  "file": {
@@ -750,9 +750,9 @@
750
750
  "required": true
751
751
  }
752
752
  },
753
- "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
753
+ "description": "Imports an iOS Distribution Certificate to your ShipThis account",
754
754
  "examples": [
755
- "<%= config.bin %> <%= command.id %> userApiKey.zip"
755
+ "<%= config.bin %> <%= command.id %> userCert.zip"
756
756
  ],
757
757
  "flags": {
758
758
  "force": {
@@ -764,7 +764,7 @@
764
764
  },
765
765
  "hasDynamicHelp": false,
766
766
  "hiddenAliases": [],
767
- "id": "apple:apiKey:import",
767
+ "id": "apple:certificate:import",
768
768
  "pluginAlias": "shipthis",
769
769
  "pluginName": "shipthis",
770
770
  "pluginType": "core",
@@ -775,14 +775,14 @@
775
775
  "dist",
776
776
  "commands",
777
777
  "apple",
778
- "apiKey",
778
+ "certificate",
779
779
  "import.js"
780
780
  ]
781
781
  },
782
- "apple:apiKey:status": {
782
+ "apple:certificate:status": {
783
783
  "aliases": [],
784
784
  "args": {},
785
- "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
785
+ "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.",
786
786
  "examples": [
787
787
  "<%= config.bin %> <%= command.id %>",
788
788
  "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -797,7 +797,7 @@
797
797
  },
798
798
  "hasDynamicHelp": false,
799
799
  "hiddenAliases": [],
800
- "id": "apple:apiKey:status",
800
+ "id": "apple:certificate:status",
801
801
  "pluginAlias": "shipthis",
802
802
  "pluginName": "shipthis",
803
803
  "pluginType": "core",
@@ -808,7 +808,7 @@
808
808
  "dist",
809
809
  "commands",
810
810
  "apple",
811
- "apiKey",
811
+ "certificate",
812
812
  "status.js"
813
813
  ]
814
814
  },
@@ -1508,5 +1508,5 @@
1508
1508
  ]
1509
1509
  }
1510
1510
  },
1511
- "version": "0.0.23"
1511
+ "version": "0.0.24"
1512
1512
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "shipthis",
3
3
  "description": "Game Shipping Tool",
4
- "version": "0.0.23",
4
+ "version": "0.0.24",
5
5
  "author": "Hello Invent Ltd",
6
6
  "bin": {
7
7
  "shipthis": "./bin/run.js"
@@ -1,26 +0,0 @@
1
- # apple apiKey create
2
-
3
- ## Description
4
-
5
- Creates an App Store Connect API Key in your Apple Developer account.
6
- Saves the private key in your ShipThis account.
7
-
8
- ## Help Output
9
-
10
- ```
11
- USAGE
12
- $ shipthis apple apiKey create [-f] [-q]
13
-
14
- FLAGS
15
- -f, --force
16
- -q, --quiet Avoid output except for interactions and errors
17
-
18
- DESCRIPTION
19
- Creates an App Store Connect API Key in your Apple Developer account.
20
- Saves the private key in your ShipThis account.
21
-
22
- EXAMPLES
23
- $ shipthis apple apiKey create
24
-
25
- $ shipthis apple apiKey create --force
26
- ```
@@ -1,24 +0,0 @@
1
- # apple apiKey export
2
-
3
- ## Description
4
-
5
- Saves the current App Store Connect API Key to a ZIP file
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis apple apiKey export FILE [-f]
12
-
13
- ARGUMENTS
14
- FILE Name of the ZIP file to create
15
-
16
- FLAGS
17
- -f, --force Overwrite the file if it already exists
18
-
19
- DESCRIPTION
20
- Saves the current App Store Connect API Key to a ZIP file
21
-
22
- EXAMPLES
23
- $ shipthis apple apiKey export userApiKey.zip
24
- ```
@@ -1,24 +0,0 @@
1
- # apple apiKey import
2
-
3
- ## Description
4
-
5
- Imports an App Store Connect API Key ZIP file into your ShipThis account
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis apple apiKey import FILE [-f]
12
-
13
- ARGUMENTS
14
- FILE Name of the ZIP file to import (must be in the same format as the export)
15
-
16
- FLAGS
17
- -f, --force
18
-
19
- DESCRIPTION
20
- Imports an App Store Connect API Key ZIP file into your ShipThis account
21
-
22
- EXAMPLES
23
- $ shipthis apple apiKey import userApiKey.zip
24
- ```
@@ -1,25 +0,0 @@
1
- # apple apiKey status
2
-
3
- ## Description
4
-
5
- Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
6
- This API key is used to automatically publish your games to the App Store.
7
-
8
- ## Help Output
9
-
10
- ```
11
- USAGE
12
- $ shipthis apple apiKey status [-f]
13
-
14
- FLAGS
15
- -f, --noAppleAuth
16
-
17
- DESCRIPTION
18
- Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
19
- This API key is used to automatically publish your games to the App Store.
20
-
21
- EXAMPLES
22
- $ shipthis apple apiKey status
23
-
24
- $ shipthis apple apiKey status --noAppleAuth
25
- ```
@@ -1,26 +0,0 @@
1
- # apple certificate create
2
-
3
- ## Description
4
-
5
- Creates an iOS Distribution Certificate in your Apple Developer account.
6
- Saves the certificate with the private key to your ShipThis account
7
-
8
- ## Help Output
9
-
10
- ```
11
- USAGE
12
- $ shipthis apple certificate create [-f] [-q]
13
-
14
- FLAGS
15
- -f, --force
16
- -q, --quiet Avoid output except for interactions and errors
17
-
18
- DESCRIPTION
19
- Creates an iOS Distribution Certificate in your Apple Developer account.
20
- Saves the certificate with the private key to your ShipThis account
21
-
22
- EXAMPLES
23
- $ shipthis apple certificate create
24
-
25
- $ shipthis apple certificate create --force
26
- ```
@@ -1,24 +0,0 @@
1
- # apple certificate export
2
-
3
- ## Description
4
-
5
- Saves the current Apple Distribution Certificate to a ZIP file.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis apple certificate export FILE [-f]
12
-
13
- ARGUMENTS
14
- FILE Name of the ZIP file to create
15
-
16
- FLAGS
17
- -f, --force Overwrite the file if it already exists
18
-
19
- DESCRIPTION
20
- Saves the current Apple Distribution Certificate to a ZIP file.
21
-
22
- EXAMPLES
23
- $ shipthis apple certificate export userCert.zip
24
- ```
@@ -1,24 +0,0 @@
1
- # apple certificate import
2
-
3
- ## Description
4
-
5
- Imports an iOS Distribution Certificate to your ShipThis account
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis apple certificate import FILE [-f]
12
-
13
- ARGUMENTS
14
- FILE Name of the ZIP file to import (must be in the same format as the export)
15
-
16
- FLAGS
17
- -f, --force
18
-
19
- DESCRIPTION
20
- Imports an iOS Distribution Certificate to your ShipThis account
21
-
22
- EXAMPLES
23
- $ shipthis apple certificate import userCert.zip
24
- ```
@@ -1,25 +0,0 @@
1
- # apple certificate status
2
-
3
- ## Description
4
-
5
- Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.
6
- These are used to sign all of your iOS apps.
7
-
8
- ## Help Output
9
-
10
- ```
11
- USAGE
12
- $ shipthis apple certificate status [-f]
13
-
14
- FLAGS
15
- -f, --noAppleAuth
16
-
17
- DESCRIPTION
18
- Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.
19
- These are used to sign all of your iOS apps.
20
-
21
- EXAMPLES
22
- $ shipthis apple certificate status
23
-
24
- $ shipthis apple certificate status --noAppleAuth
25
- ```
package/docs/apple/login DELETED
@@ -1,25 +0,0 @@
1
- # apple login
2
-
3
- ## Description
4
-
5
- Authenticate with Apple - saves the session to the auth file
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis apple login [-q] [-f] [-e <value>]
12
-
13
- FLAGS
14
- -e, --appleEmail=<value> Your Apple Developer email address
15
- -f, --force
16
- -q, --quiet Avoid output except for interactions and errors
17
-
18
- DESCRIPTION
19
- Authenticate with Apple - saves the session to the auth file
20
-
21
- EXAMPLES
22
- $ shipthis apple login
23
-
24
- $ shipthis apple login --force --appleEmail me@email.nowhere
25
- ```
package/docs/apple/status DELETED
@@ -1,18 +0,0 @@
1
- # apple status
2
-
3
- ## Description
4
-
5
- Shows the status of the Apple authentication and integration.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis apple status
12
-
13
- DESCRIPTION
14
- Shows the status of the Apple authentication and integration.
15
-
16
- EXAMPLES
17
- $ shipthis apple status
18
- ```
package/docs/dashboard DELETED
@@ -1,18 +0,0 @@
1
- # dashboard
2
-
3
- ## Description
4
-
5
- Opens the web-browser to your ShipThis dashboard
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis dashboard
12
-
13
- DESCRIPTION
14
- Opens the web-browser to your ShipThis dashboard
15
-
16
- EXAMPLES
17
- $ shipthis dashboard
18
- ```
@@ -1,28 +0,0 @@
1
- # game build download
2
-
3
- ## Description
4
-
5
- Downloads the given build artifact to the specified file
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game build download BUILD_ID FILE [-g <value>] [-f]
12
-
13
- ARGUMENTS
14
- BUILD_ID The ID of the build to download
15
- FILE Name of the file to output
16
-
17
- FLAGS
18
- -f, --force Overwrite the file if it already exists
19
- -g, --gameId=<value> The ID of the game
20
-
21
- DESCRIPTION
22
- Downloads the given build artifact to the specified file
23
-
24
- EXAMPLES
25
- $ shipthis game build download 7a3f5c92 output.ipa
26
-
27
- $ shipthis game build download --gameId 0c179fc4 e4b9a3d7 output.apk
28
- ```
@@ -1,31 +0,0 @@
1
- # game build list
2
-
3
- ## Description
4
-
5
- Lists the builds for successful jobs of a game.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game build list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
12
-
13
- FLAGS
14
- -g, --gameId=<value> The ID of the game
15
- -o, --orderBy=<option> [default: createdAt] The field to order by
16
- <options: createdAt|updatedAt>
17
- -p, --pageNumber=<value> The page number to show (starts at 0)
18
- -r, --order=<option> [default: desc] The order to sort by
19
- <options: asc|desc>
20
- -s, --pageSize=<value> [default: 10] The number of items to show per page
21
-
22
- DESCRIPTION
23
- Lists the builds for successful jobs of a game.
24
-
25
- EXAMPLES
26
- $ shipthis game build list
27
-
28
- $ shipthis game build list --gameId 0c179fc4
29
-
30
- $ shipthis game build list --gameId 0c179fc4 --pageSize 20 --pageNumber 1
31
- ```
package/docs/game/create DELETED
@@ -1,23 +0,0 @@
1
- # game create
2
-
3
- ## Description
4
-
5
- Create a new game in ShipThis.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game create [-q] [-f] [-n <value>]
12
-
13
- FLAGS
14
- -f, --force
15
- -n, --name=<value> The name of the game
16
- -q, --quiet Avoid output except for interactions and errors
17
-
18
- DESCRIPTION
19
- Create a new game in ShipThis.
20
-
21
- EXAMPLES
22
- $ shipthis game create
23
- ```
package/docs/game/details DELETED
@@ -1,35 +0,0 @@
1
- # game details
2
-
3
- ## Description
4
-
5
- Shows and sets the details of a game.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game details [-g <value>] [-f] [-b <value>] [-s <value>] [-e <value>] [-v <value>] [-i <value>] [-a
12
- <value>]
13
-
14
- FLAGS
15
- -a, --androidPackageName=<value> Set the Android package name
16
- -b, --buildNumber=<value> Set the build number
17
- -e, --gameEngine=<value> Set the game engine
18
- -f, --force Force the command to run
19
- -g, --gameId=<value> The ID of the game
20
- -i, --iosBundleId=<value> Set the iOS bundle ID
21
- -s, --semanticVersion=<value> Set the semantic version
22
- -v, --gameEngineVersion=<value> Set the game engine version
23
-
24
- DESCRIPTION
25
- Shows and sets the details of a game.
26
-
27
- EXAMPLES
28
- $ shipthis game details
29
-
30
- $ shipthis game details --gameId 0c179fc4
31
-
32
- $ shipthis game details --buildNumber 5 --semanticVersion 1.2.3
33
-
34
- $ shipthis game details --gameEngine godot --gameEngineVersion 4.2 --force
35
- ```
package/docs/game/export DELETED
@@ -1,26 +0,0 @@
1
- # game export
2
-
3
- ## Description
4
-
5
- Downloads the shipthis.json file for a given game into the current directory.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game export GAME_ID [-f]
12
-
13
- ARGUMENTS
14
- GAME_ID The ID of the game to export (use "list" to get the ID)
15
-
16
- FLAGS
17
- -f, --force
18
-
19
- DESCRIPTION
20
- Downloads the shipthis.json file for a given game into the current directory.
21
-
22
- EXAMPLES
23
- $ shipthis game export abcd1234
24
-
25
- $ shipthis game export abcd1234 --force
26
- ```
@@ -1,24 +0,0 @@
1
- # game ios app addTester
2
-
3
- ## Description
4
-
5
- Adds a test user to the game in App Store Connect.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios app addTester [-g <value>] [-e <value>] [-f <value>] [-l <value>]
12
-
13
- FLAGS
14
- -e, --email=<value> The email address of the tester
15
- -f, --firstName=<value> The first name of the tester
16
- -g, --gameId=<value> The ID of the game
17
- -l, --lastName=<value> The last name of the tester
18
-
19
- DESCRIPTION
20
- Adds a test user to the game in App Store Connect.
21
-
22
- EXAMPLES
23
- $ shipthis game ios app addTester
24
- ```
@@ -1,25 +0,0 @@
1
- # game ios app create
2
-
3
- ## Description
4
-
5
- Creates an App and BundleId in the Apple Developer Portal.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios app create [-q] [-g <value>] [-n <value>] [-b <value>] [-f]
12
-
13
- FLAGS
14
- -b, --bundleId=<value> The BundleId in the Apple Developer Portal
15
- -f, --force
16
- -g, --gameId=<value> The ID of the game
17
- -n, --appName=<value> The name of the App in the Apple Developer Portal
18
- -q, --quiet Avoid output except for interactions and errors
19
-
20
- DESCRIPTION
21
- Creates an App and BundleId in the Apple Developer Portal.
22
-
23
- EXAMPLES
24
- $ shipthis game ios app create
25
- ```
@@ -1,21 +0,0 @@
1
- # game ios app status
2
-
3
- ## Description
4
-
5
- Shows the Game iOS App status.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios app status [-g <value>]
12
-
13
- FLAGS
14
- -g, --gameId=<value> The ID of the game
15
-
16
- DESCRIPTION
17
- Shows the Game iOS App status.
18
-
19
- EXAMPLES
20
- $ shipthis game ios app status
21
- ```
@@ -1,23 +0,0 @@
1
- # game ios app sync
2
-
3
- ## Description
4
-
5
- Synchronies the Apple App &#34;BundleId&#34; with the capabilities from the local project.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios app sync [-q] [-g <value>] [-f]
12
-
13
- FLAGS
14
- -f, --force
15
- -g, --gameId=<value> The ID of the game
16
- -q, --quiet Avoid output except for interactions and errors
17
-
18
- DESCRIPTION
19
- Synchronies the Apple App "BundleId" with the capabilities from the local project.
20
-
21
- EXAMPLES
22
- $ shipthis game ios app sync
23
- ```
@@ -1,23 +0,0 @@
1
- # game ios profile create
2
-
3
- ## Description
4
-
5
- Creates a Mobile Provisioning Profile in the Apple Developer Portal.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios profile create [-q] [-g <value>] [-f]
12
-
13
- FLAGS
14
- -f, --force
15
- -g, --gameId=<value> The ID of the game
16
- -q, --quiet Avoid output except for interactions and errors
17
-
18
- DESCRIPTION
19
- Creates a Mobile Provisioning Profile in the Apple Developer Portal.
20
-
21
- EXAMPLES
22
- $ shipthis game ios profile create
23
- ```
@@ -1,25 +0,0 @@
1
- # game ios profile export
2
-
3
- ## Description
4
-
5
- Saves the current Mobile Provisioning Profile to a ZIP file
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios profile export FILE [-g <value>] [-f]
12
-
13
- ARGUMENTS
14
- FILE Name of the ZIP file to create
15
-
16
- FLAGS
17
- -f, --force Overwrite the file if it already exists
18
- -g, --gameId=<value> The ID of the game
19
-
20
- DESCRIPTION
21
- Saves the current Mobile Provisioning Profile to a ZIP file
22
-
23
- EXAMPLES
24
- $ shipthis game ios profile export userProfile.zip
25
- ```
@@ -1,25 +0,0 @@
1
- # game ios profile import
2
-
3
- ## Description
4
-
5
- Imports an Mobile Provisioning Profile to your ShipThis account
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios profile import FILE [-g <value>] [-f]
12
-
13
- ARGUMENTS
14
- FILE Name of the ZIP file to import (must be in the same format as the export)
15
-
16
- FLAGS
17
- -f, --force
18
- -g, --gameId=<value> The ID of the game
19
-
20
- DESCRIPTION
21
- Imports an Mobile Provisioning Profile to your ShipThis account
22
-
23
- EXAMPLES
24
- $ shipthis game ios profile import profile.zip
25
- ```
@@ -1,22 +0,0 @@
1
- # game ios profile status
2
-
3
- ## Description
4
-
5
- Shows the Game iOS Mobile Provisioning Profile Status.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios profile status [-g <value>] [-f]
12
-
13
- FLAGS
14
- -f, --noAppleAuth
15
- -g, --gameId=<value> The ID of the game
16
-
17
- DESCRIPTION
18
- Shows the Game iOS Mobile Provisioning Profile Status.
19
-
20
- EXAMPLES
21
- $ shipthis game ios profile status
22
- ```
@@ -1,23 +0,0 @@
1
- # game ios status
2
-
3
- ## Description
4
-
5
- Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ios status [-g <value>]
12
-
13
- FLAGS
14
- -g, --gameId=<value> The ID of the game
15
-
16
- DESCRIPTION
17
- Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
18
-
19
- EXAMPLES
20
- $ shipthis game ios status
21
-
22
- $ shipthis game ios status --gameId 0c179fc4
23
- ```
@@ -1,29 +0,0 @@
1
- # game job list
2
-
3
- ## Description
4
-
5
- Lists the jobs for a game.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game job list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
12
-
13
- FLAGS
14
- -g, --gameId=<value> The ID of the game
15
- -o, --orderBy=<option> [default: createdAt] The field to order by
16
- <options: createdAt|updatedAt>
17
- -p, --pageNumber=<value> The page number to show (starts at 0)
18
- -r, --order=<option> [default: desc] The order to sort by
19
- <options: asc|desc>
20
- -s, --pageSize=<value> [default: 10] The number of items to show per page
21
-
22
- DESCRIPTION
23
- Lists the jobs for a game.
24
-
25
- EXAMPLES
26
- $ shipthis game job list
27
-
28
- $ shipthis game job list --gameId 0c179fc4
29
- ```
@@ -1,30 +0,0 @@
1
- # game job status
2
-
3
- ## Description
4
-
5
- Shows the real-time status of a job.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game job status JOB_ID [-g <value>] [-n <value>] [-f]
12
-
13
- ARGUMENTS
14
- JOB_ID The id of the job to get the status of
15
-
16
- FLAGS
17
- -f, --follow Follow the log in real-time
18
- -g, --gameId=<value> The ID of the game
19
- -n, --lines=<value> [default: 10] The number of lines to show
20
-
21
- DESCRIPTION
22
- Shows the real-time status of a job.
23
-
24
- EXAMPLES
25
- $ shipthis game job status 4d32239e
26
-
27
- $ shipthis game job status --gameId 0c179fc4 4d32239e
28
-
29
- $ shipthis game job status --gameId 0c179fc4 --lines 20 --follow 4d32239e
30
- ```
package/docs/game/list DELETED
@@ -1,26 +0,0 @@
1
- # game list
2
-
3
- ## Description
4
-
5
- Shows a list of all your games.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game list [-p <value>] [-s <value>] [-o createdAt|updatedAt|name] [-r asc|desc]
12
-
13
- FLAGS
14
- -o, --orderBy=<option> [default: createdAt] The field to order by
15
- <options: createdAt|updatedAt|name>
16
- -p, --pageNumber=<value> The page number to show (starts at 0)
17
- -r, --order=<option> [default: desc] The order to sort by
18
- <options: asc|desc>
19
- -s, --pageSize=<value> [default: 10] The number of items to show per page
20
-
21
- DESCRIPTION
22
- Shows a list of all your games.
23
-
24
- EXAMPLES
25
- $ shipthis game list
26
- ```
package/docs/game/ship DELETED
@@ -1,21 +0,0 @@
1
- # game ship
2
-
3
- ## Description
4
-
5
- Builds the app (for all platforms with valid credentials) and ships it to the stores.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game ship [-g <value>]
12
-
13
- FLAGS
14
- -g, --gameId=<value> The ID of the game
15
-
16
- DESCRIPTION
17
- Builds the app (for all platforms with valid credentials) and ships it to the stores.
18
-
19
- EXAMPLES
20
- $ shipthis game ship
21
- ```
package/docs/game/status DELETED
@@ -1,23 +0,0 @@
1
- # game status
2
-
3
- ## Description
4
-
5
- Shows the status of the current game.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game status [-g <value>]
12
-
13
- FLAGS
14
- -g, --gameId=<value> The ID of the game
15
-
16
- DESCRIPTION
17
- Shows the status of the current game.
18
-
19
- EXAMPLES
20
- $ shipthis game status
21
-
22
- $ shipthis game status --gameId 0c179fc4
23
- ```
package/docs/game/wizard DELETED
@@ -1,23 +0,0 @@
1
- # game wizard
2
-
3
- ## Description
4
-
5
- Runs all the steps for the specific platform
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis game wizard [-f <value>] [-p ios]
12
-
13
- FLAGS
14
- -f, --forceStep=<value> Force a specific step to run.
15
- -p, --platform=<option> [default: ios] The platform to run the wizard for
16
- <options: ios>
17
-
18
- DESCRIPTION
19
- Runs all the steps for the specific platform
20
-
21
- EXAMPLES
22
- $ shipthis game wizard
23
- ```
package/docs/help DELETED
@@ -1,21 +0,0 @@
1
- # help
2
-
3
- ## Description
4
-
5
- Display help for &lt;%= config.bin %&gt;.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis help [COMMAND...] [-n]
12
-
13
- ARGUMENTS
14
- COMMAND... Command to show help for.
15
-
16
- FLAGS
17
- -n, --nested-commands Include all nested commands in the output.
18
-
19
- DESCRIPTION
20
- Display help for shipthis.
21
- ```
package/docs/login DELETED
@@ -1,24 +0,0 @@
1
- # login
2
-
3
- ## Description
4
-
5
- Authenticate - will create a new account if one does not exist.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis login [-f] [-e <value>]
12
-
13
- FLAGS
14
- -e, --email=<value> Your email address
15
- -f, --force
16
-
17
- DESCRIPTION
18
- Authenticate - will create a new account if one does not exist.
19
-
20
- EXAMPLES
21
- $ shipthis login
22
-
23
- $ shipthis login --force --email me@email.nowhere
24
- ```
package/docs/status DELETED
@@ -1,18 +0,0 @@
1
- # status
2
-
3
- ## Description
4
-
5
- Displays the current overall status.
6
-
7
- ## Help Output
8
-
9
- ```
10
- USAGE
11
- $ shipthis status
12
-
13
- DESCRIPTION
14
- Displays the current overall status.
15
-
16
- EXAMPLES
17
- $ shipthis status
18
- ```