shipthis 0.0.8 → 0.0.20

package/docs/apple/certificate.md

@@ -0,0 +1,110 @@
+# apple certificate
+
+Commands related to App Store Certificates
+
+
+## Commands
+
+
+### apple certificate create
+
+#### Description
+
+Creates an iOS Distribution Certificate in your Apple Developer account.
+Saves the certificate with the private key to your ShipThis account
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple certificate create [-f] [-q]
+
+FLAGS
+  -f, --force
+  -q, --quiet  Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an iOS Distribution Certificate in your Apple Developer account.
+  Saves the certificate with the private key to your ShipThis account
+
+EXAMPLES
+  $ shipthis apple certificate create
+
+  $ shipthis apple certificate create --force
+```
+
+### apple certificate export
+
+#### Description
+
+Saves the current Apple Distribution Certificate to a ZIP file.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple certificate export FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to create
+
+FLAGS
+  -f, --force  Overwrite the file if it already exists
+
+DESCRIPTION
+  Saves the current Apple Distribution Certificate to a ZIP file.
+
+EXAMPLES
+  $ shipthis apple certificate export userCert.zip
+```
+
+### apple certificate import
+
+#### Description
+
+Imports an iOS Distribution Certificate to your ShipThis account
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple certificate import FILE [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to import (must be in the same format as the export)
+
+FLAGS
+  -f, --force
+
+DESCRIPTION
+  Imports an iOS Distribution Certificate to your ShipThis account
+
+EXAMPLES
+  $ shipthis apple certificate import userCert.zip
+```
+
+### apple certificate status
+
+#### Description
+
+Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.
+These are used to sign all of your iOS apps.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple certificate status [-f]
+
+FLAGS
+  -f, --noAppleAuth
+
+DESCRIPTION
+  Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.
+  These are used to sign all of your iOS apps.
+
+EXAMPLES
+  $ shipthis apple certificate status
+
+  $ shipthis apple certificate status --noAppleAuth
+```

package/docs/apple/login.md

@@ -0,0 +1,30 @@
+# apple login
+
+## Description
+
+Authenticate with Apple - saves the session to the auth file.
+
+## Example
+
+[![asciicast](https://asciinema.org/a/CsYDuIS5hfO20CBS5OHbi6VUc.svg)](https://asciinema.org/a/CsYDuIS5hfO20CBS5OHbi6VUc)
+
+
+## Help Output
+
+```bash
+USAGE
+  $ shipthis apple login [-q] [-f] [-e <value>]
+
+FLAGS
+  -e, --appleEmail=<value>  Your Apple Developer email address
+  -f, --force
+  -q, --quiet               Avoid output except for interactions and errors
+
+DESCRIPTION
+  Authenticate with Apple - saves the session to the auth file
+
+EXAMPLES
+  $ shipthis apple login
+
+  $ shipthis apple login --force --appleEmail me@email.nowhere
+```

package/docs/apple/status.md

@@ -0,0 +1,21 @@
+# apple status
+
+## Description
+
+Shows the status of the Apple authentication and integration
+
+## Example
+
+[![asciicast](https://asciinema.org/a/g4hSnl66PE7xz7FGmeMwBdqoN.svg)](https://asciinema.org/a/g4hSnl66PE7xz7FGmeMwBdqoN)
+
+## Help Output
+```
+USAGE
+  $ shipthis apple status
+
+DESCRIPTION
+  Shows the status of the Apple authentication and integration
+
+EXAMPLES
+  $ shipthis apple status
+```

package/docs/apple.md

@@ -0,0 +1,48 @@
+# Apple Commands
+
+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.
+
+## Status
+
+Display the status of your ShipThis integration with your Apple Developer account.
+
+- [`shipthis apple status`](/docs/reference/apple/status)
+
+## Login
+
+Authenticate against the Apple API and persists the session cookies so that you do not need to re-authenticate between commands.
+
+:::tip Info
+Your Apple credentials never leave your computer. ShipThis saves the cookies to `~/.shipthis.auth.json`
+
+:::
+
+- [`shipthis apple login`](/docs/reference/apple/login)
+
+# Apple Topics
+
+## API Keys
+
+Manage App Store Connect API Keys in your Apple Developer account and their corresponding the private keys in your ShipThis account
+
+:::tip Info
+App Store Connect API Keys are used to upload your game to the App Store. The same API key can be used to upload multiple games.
+:::
+
+- [`shipthis apple apiKey create`](/docs/reference/apple/apiKey#shipthis-apple-apikey-create)
+- [`shipthis apple apiKey export FILE`](/docs/reference/apple/apiKey#shipthis-apple-apikey-export-file)
+- [`shipthis apple apiKey import FILE`](/docs/reference/apple/apiKey#shipthis-apple-apikey-import-file)
+- [`shipthis apple apiKey status`](/docs/reference/apple/apiKey#shipthis-apple-apikey-status)
+
+## Certificates
+
+Manage iOS Distribution Certificates in your Apple Developer account and their corresponding private keys in your ShipThis account
+
+:::tip Info
+Your iOS Distribution Certificate is used to sign all of your games before upload to the App Store. The same certificate can be used to sign multiple games.
+:::
+
+- [`shipthis apple certificate create`](/docs/reference/apple/certificate#shipthis-apple-certificate-create)
+- [`shipthis apple certificate export FILE`](/docs/reference/apple/certificate#shipthis-apple-certificate-export-file)
+- [`shipthis apple certificate import FILE`](/docs/reference/apple/certificate#shipthis-apple-certificate-import-file)
+- [`shipthis apple certificate status`](/docs/reference/apple/certificate#shipthis-apple-certificate-status)

package/docs/dashboard.md

@@ -0,0 +1,18 @@
+# dashboard
+
+## Description
+
+Opens the web-browser to your ShipThis dashboard
+
+## Help Output
+
+```
+USAGE
+  $ shipthis dashboard
+
+DESCRIPTION
+  Opens the web-browser to your ShipThis dashboard
+
+EXAMPLES
+  $ shipthis dashboard
+```

package/docs/game/build/download.md

@@ -0,0 +1,28 @@
+# game build download
+
+## Description
+
+Downloads the given build artifact to the specified file
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game build download BUILD_ID FILE [-g <value>] [-f]
+
+ARGUMENTS
+  BUILD_ID  The ID of the build to download
+  FILE      Name of the file to output
+
+FLAGS
+  -f, --force           Overwrite the file if it already exists
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Downloads the given build artifact to the specified file
+
+EXAMPLES
+  $ shipthis game build download 7a3f5c92 output.ipa
+
+  $ shipthis game build download --gameId 0c179fc4 e4b9a3d7 output.apk
+```

package/docs/game/build/list.md

@@ -0,0 +1,31 @@
+# game build list
+
+## Description
+
+Lists the builds for successful jobs of a game.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game build list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
+
+FLAGS
+  -g, --gameId=<value>      The ID of the game
+  -o, --orderBy=<option>    [default: createdAt] The field to order by
+                            <options: createdAt|updatedAt>
+  -p, --pageNumber=<value>  The page number to show (starts at 0)
+  -r, --order=<option>      [default: desc] The order to sort by
+                            <options: asc|desc>
+  -s, --pageSize=<value>    [default: 10] The number of items to show per page
+
+DESCRIPTION
+  Lists the builds for successful jobs of a game.
+
+EXAMPLES
+  $ shipthis game build list
+
+  $ shipthis game build list --gameId 0c179fc4
+
+  $ shipthis game build list --gameId 0c179fc4 --pageSize 20 --pageNumber 1
+```

package/docs/game/build.md

@@ -0,0 +1,68 @@
+# game build
+
+Commands related to builds for a specific game
+
+
+## Commands
+
+
+### game build download
+
+#### Description
+
+Downloads the given build artifact to the specified file
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game build download BUILD_ID FILE [-g <value>] [-f]
+
+ARGUMENTS
+  BUILD_ID  The ID of the build to download
+  FILE      Name of the file to output
+
+FLAGS
+  -f, --force           Overwrite the file if it already exists
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Downloads the given build artifact to the specified file
+
+EXAMPLES
+  $ shipthis game build download 7a3f5c92 output.ipa
+
+  $ shipthis game build download --gameId 0c179fc4 e4b9a3d7 output.apk
+```
+
+### game build list
+
+#### Description
+
+Lists the builds for successful jobs of a game.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game build list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
+
+FLAGS
+  -g, --gameId=<value>      The ID of the game
+  -o, --orderBy=<option>    [default: createdAt] The field to order by
+                            <options: createdAt|updatedAt>
+  -p, --pageNumber=<value>  The page number to show (starts at 0)
+  -r, --order=<option>      [default: desc] The order to sort by
+                            <options: asc|desc>
+  -s, --pageSize=<value>    [default: 10] The number of items to show per page
+
+DESCRIPTION
+  Lists the builds for successful jobs of a game.
+
+EXAMPLES
+  $ shipthis game build list
+
+  $ shipthis game build list --gameId 0c179fc4
+
+  $ shipthis game build list --gameId 0c179fc4 --pageSize 20 --pageNumber 1
+```

package/docs/game/create.md

@@ -0,0 +1,23 @@
+# game create
+
+## Description
+
+Create a new game in ShipThis.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game create [-q] [-f] [-n <value>]
+
+FLAGS
+  -f, --force
+  -n, --name=<value>  The name of the game
+  -q, --quiet         Avoid output except for interactions and errors
+
+DESCRIPTION
+  Create a new game in ShipThis.
+
+EXAMPLES
+  $ shipthis game create
+```

package/docs/game/details.md

@@ -0,0 +1,35 @@
+# game details
+
+## Description
+
+Shows and sets the details of a game.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game details [-g <value>] [-f] [-b <value>] [-s <value>] [-e <value>] [-v <value>] [-i <value>] [-a
+    <value>]
+
+FLAGS
+  -a, --androidPackageName=<value>  Set the Android package name
+  -b, --buildNumber=<value>         Set the build number
+  -e, --gameEngine=<value>          Set the game engine
+  -f, --force                       Force the command to run
+  -g, --gameId=<value>              The ID of the game
+  -i, --iosBundleId=<value>         Set the iOS bundle ID
+  -s, --semanticVersion=<value>     Set the semantic version
+  -v, --gameEngineVersion=<value>   Set the game engine version
+
+DESCRIPTION
+  Shows and sets the details of a game.
+
+EXAMPLES
+  $ shipthis game details
+
+  $ shipthis game details --gameId 0c179fc4
+
+  $ shipthis game details --buildNumber 5 --semanticVersion 1.2.3
+
+  $ shipthis game details --gameEngine godot --gameEngineVersion 4.2 --force
+```

package/docs/game/export.md

@@ -0,0 +1,26 @@
+# game export
+
+## Description
+
+Downloads the shipthis.json file for a given game into the current directory.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game export GAME_ID [-f]
+
+ARGUMENTS
+  GAME_ID  The ID of the game to export (use "list" to get the ID)
+
+FLAGS
+  -f, --force
+
+DESCRIPTION
+  Downloads the shipthis.json file for a given game into the current directory.
+
+EXAMPLES
+  $ shipthis game export abcd1234
+
+  $ shipthis game export abcd1234 --force
+```

package/docs/game/ios/app/addTester.md

@@ -0,0 +1,24 @@
+# game ios app addTester
+
+## Description
+
+Adds a test user to the game in App Store Connect.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios app addTester [-g <value>] [-e <value>] [-f <value>] [-l <value>]
+
+FLAGS
+  -e, --email=<value>      The email address of the tester
+  -f, --firstName=<value>  The first name of the tester
+  -g, --gameId=<value>     The ID of the game
+  -l, --lastName=<value>   The last name of the tester
+
+DESCRIPTION
+  Adds a test user to the game in App Store Connect.
+
+EXAMPLES
+  $ shipthis game ios app addTester
+```

package/docs/game/ios/app/create.md

@@ -0,0 +1,25 @@
+# game ios app create
+
+## Description
+
+Creates an App and BundleId in the Apple Developer Portal.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios app create [-q] [-g <value>] [-n <value>] [-b <value>] [-f]
+
+FLAGS
+  -b, --bundleId=<value>  The BundleId in the Apple Developer Portal
+  -f, --force
+  -g, --gameId=<value>    The ID of the game
+  -n, --appName=<value>   The name of the App in the Apple Developer Portal
+  -q, --quiet             Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an App and BundleId in the Apple Developer Portal.
+
+EXAMPLES
+  $ shipthis game ios app create
+```

package/docs/game/ios/app/status.md

@@ -0,0 +1,21 @@
+# game ios app status
+
+## Description
+
+Shows the Game iOS App status. 
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios app status [-g <value>]
+
+FLAGS
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Shows the Game iOS App status.
+
+EXAMPLES
+  $ shipthis game ios app status
+```

package/docs/game/ios/app/sync.md

@@ -0,0 +1,23 @@
+# game ios app sync
+
+## Description
+
+Synchronies the Apple App "BundleId" with the capabilities from the local project.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios app sync [-q] [-g <value>] [-f]
+
+FLAGS
+  -f, --force
+  -g, --gameId=<value>  The ID of the game
+  -q, --quiet           Avoid output except for interactions and errors
+
+DESCRIPTION
+  Synchronies the Apple App "BundleId" with the capabilities from the local project.
+
+EXAMPLES
+  $ shipthis game ios app sync
+```

package/docs/game/ios/app.md

@@ -0,0 +1,104 @@
+# game ios app
+
+Commands related to the App Store App for a specific game
+
+
+## Commands
+
+
+### game ios app addTester
+
+#### Description
+
+Adds a test user to the game in App Store Connect.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios app addTester [-g <value>] [-e <value>] [-f <value>] [-l <value>]
+
+FLAGS
+  -e, --email=<value>      The email address of the tester
+  -f, --firstName=<value>  The first name of the tester
+  -g, --gameId=<value>     The ID of the game
+  -l, --lastName=<value>   The last name of the tester
+
+DESCRIPTION
+  Adds a test user to the game in App Store Connect.
+
+EXAMPLES
+  $ shipthis game ios app addTester
+```
+
+### game ios app create
+
+#### Description
+
+Creates an App and BundleId in the Apple Developer Portal.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios app create [-q] [-g <value>] [-n <value>] [-b <value>] [-f]
+
+FLAGS
+  -b, --bundleId=<value>  The BundleId in the Apple Developer Portal
+  -f, --force
+  -g, --gameId=<value>    The ID of the game
+  -n, --appName=<value>   The name of the App in the Apple Developer Portal
+  -q, --quiet             Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an App and BundleId in the Apple Developer Portal.
+
+EXAMPLES
+  $ shipthis game ios app create
+```
+
+### game ios app status
+
+#### Description
+
+Shows the Game iOS App status. 
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios app status [-g <value>]
+
+FLAGS
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Shows the Game iOS App status.
+
+EXAMPLES
+  $ shipthis game ios app status
+```
+
+### game ios app sync
+
+#### Description
+
+Synchronies the Apple App &#34;BundleId&#34; with the capabilities from the local project.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios app sync [-q] [-g <value>] [-f]
+
+FLAGS
+  -f, --force
+  -g, --gameId=<value>  The ID of the game
+  -q, --quiet           Avoid output except for interactions and errors
+
+DESCRIPTION
+  Synchronies the Apple App "BundleId" with the capabilities from the local project.
+
+EXAMPLES
+  $ shipthis game ios app sync
+```

package/docs/game/ios/profile/create.md

@@ -0,0 +1,23 @@
+# game ios profile create
+
+## Description
+
+Creates a Mobile Provisioning Profile in the Apple Developer Portal.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios profile create [-q] [-g <value>] [-f]
+
+FLAGS
+  -f, --force
+  -g, --gameId=<value>  The ID of the game
+  -q, --quiet           Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates a Mobile Provisioning Profile in the Apple Developer Portal.
+
+EXAMPLES
+  $ shipthis game ios profile create
+```

package/docs/game/ios/profile/export.md

@@ -0,0 +1,25 @@
+# game ios profile export
+
+## Description
+
+Saves the current Mobile Provisioning Profile to a ZIP file
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios profile export FILE [-g <value>] [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to create
+
+FLAGS
+  -f, --force           Overwrite the file if it already exists
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Saves the current Mobile Provisioning Profile to a ZIP file
+
+EXAMPLES
+  $ shipthis game ios profile export userProfile.zip
+```