shipthis 0.0.9 → 0.0.21

package/docs/apple/apiKey/export.md

@@ -0,0 +1,24 @@
+# apple apiKey export
+
+## Description
+
+Saves the current App Store Connect API Key to a ZIP file
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey 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 App Store Connect API Key to a ZIP file
+
+EXAMPLES
+  $ shipthis apple apiKey export userApiKey.zip
+```

package/docs/apple/apiKey/import.md

@@ -0,0 +1,24 @@
+# apple apiKey import
+
+## Description
+
+Imports an App Store Connect API Key ZIP file into your ShipThis account
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey 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 App Store Connect API Key ZIP file into your ShipThis account
+
+EXAMPLES
+  $ shipthis apple apiKey import userApiKey.zip
+```

package/docs/apple/apiKey/status.md

@@ -0,0 +1,25 @@
+# apple apiKey status
+
+## Description
+
+Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+This API key is used to automatically publish your games to the App Store.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey status [-f]
+
+FLAGS
+  -f, --noAppleAuth
+
+DESCRIPTION
+  Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+  This API key is used to automatically publish your games to the App Store.
+
+EXAMPLES
+  $ shipthis apple apiKey status
+
+  $ shipthis apple apiKey status --noAppleAuth
+```

package/docs/apple/apiKey.md

@@ -0,0 +1,110 @@
+# apple apiKey
+
+Commands related to App Store Connect API Keys
+
+
+## Commands
+
+
+### apple apiKey create
+
+#### Description
+
+Creates an App Store Connect API Key in your Apple Developer account.
+Saves the private key in your ShipThis account.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey create [-f] [-q]
+
+FLAGS
+  -f, --force
+  -q, --quiet  Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an App Store Connect API Key in your Apple Developer account.
+  Saves the private key in your ShipThis account.
+
+EXAMPLES
+  $ shipthis apple apiKey create
+
+  $ shipthis apple apiKey create --force
+```
+
+### apple apiKey export
+
+#### Description
+
+Saves the current App Store Connect API Key to a ZIP file
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey 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 App Store Connect API Key to a ZIP file
+
+EXAMPLES
+  $ shipthis apple apiKey export userApiKey.zip
+```
+
+### apple apiKey import
+
+#### Description
+
+Imports an App Store Connect API Key ZIP file into your ShipThis account
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey 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 App Store Connect API Key ZIP file into your ShipThis account
+
+EXAMPLES
+  $ shipthis apple apiKey import userApiKey.zip
+```
+
+### apple apiKey status
+
+#### Description
+
+Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+This API key is used to automatically publish your games to the App Store.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis apple apiKey status [-f]
+
+FLAGS
+  -f, --noAppleAuth
+
+DESCRIPTION
+  Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.
+  This API key is used to automatically publish your games to the App Store.
+
+EXAMPLES
+  $ shipthis apple apiKey status
+
+  $ shipthis apple apiKey status --noAppleAuth
+```

package/docs/apple/certificate/create.md

@@ -0,0 +1,26 @@
+# 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
+```

package/docs/apple/certificate/export.md

@@ -0,0 +1,24 @@
+# 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
+```

package/docs/apple/certificate/import.md

@@ -0,0 +1,24 @@
+# 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
+```

package/docs/apple/certificate/status.md

@@ -0,0 +1,25 @@
+# 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/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
+```