shipthis 0.1.33 → 0.1.35

package/docs/apiKey.md

@@ -0,0 +1,103 @@
+# Topic: `apiKey`
+
+## Description
+
+Commands in the **apiKey** topic are prefixed with `shipthis apiKey`. These commands let you create new keys, list existing ones, and revoke keys you no longer need.
+
+:::info
+ShipThis API keys are securely generated, random tokens used to authenticate requests to the ShipThis API. They are intended for automated environments, like CI pipelines, where manual login is not practical.  
+The raw key is only shown once when created, so make sure to copy and store it securely.
+:::
+
+
+## Example
+
+[![asciicast](https://asciinema.org/a/bfCPQIvDNt5zlgcEQhcs7o6Fr.svg)](https://asciinema.org/a/bfCPQIvDNt5zlgcEQhcs7o6Fr#shipthis-col80row24)
+
+## Commands
+
+### `apiKey create`
+
+#### Description
+
+Create a new API key for your ShipThis account.
+
+#### Help Output
+
+```help
+USAGE
+  $ shipthis apiKey create [-n <value>] [-d <value>] [-q]
+
+FLAGS
+  -d, --durationDays=<value>  [default: 365] duration of the API key in days
+  -n, --name=<value>          name to apply to the API key (if not provided, a random name will be generated)
+  -q, --quiet                 Outputs just the secret value
+
+DESCRIPTION
+  Create a new API key for your ShipThis account.
+
+EXAMPLES
+  $ shipthis apiKey create --durationDays 30
+
+  $ shipthis apiKey create --name ci-key --durationDays 90
+
+  $ shipthis apiKey create --name ci-key-headless --durationDays 365 --quiet
+```
+
+### `apiKey list`
+
+#### Description
+
+Displays a list of your ShipThis API keys.
+
+#### Help Output
+
+```help
+USAGE
+  $ shipthis apiKey list [-r asc|desc] [-o createdAt|updatedAt|name] [-p <value>] [-s <value>]
+
+FLAGS
+  -o, --orderBy=<option>    [default: createdAt] The field to order by
+                            <options: createdAt|updatedAt|name>
+  -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
+  Displays a list of your ShipThis API keys.
+
+EXAMPLES
+  $ shipthis apiKey list
+
+  $ shipthis apiKey list --pageNumber 1
+
+  $ shipthis apiKey list --orderBy createdAt --order asc
+```
+
+### `apiKey revoke`
+
+#### Description
+
+Revokes a specific ShipThis API key.
+
+#### Help Output
+
+```help
+USAGE
+  $ shipthis apiKey revoke APIKEYID [-q]
+
+ARGUMENTS
+  APIKEYID  The ID of the API key to revoke
+
+FLAGS
+  -q, --quiet  Suppress output except for errors
+
+DESCRIPTION
+  Revokes a specific ShipThis API key.
+
+EXAMPLES
+  $ shipthis apiKey revoke abcd1234
+
+  $ shipthis apiKey revoke abcd1234 --quiet
+```

package/docs/game/android/apiKey/policy.md

@@ -0,0 +1,28 @@
+# Command: `game android apiKey policy`
+
+## Description
+
+Gets and sets the iam.disableServiceAccountKeyCreation policy for your Google Organization
+
+## Help Output
+
+```help
+USAGE
+  $ shipthis game android apiKey policy [-g <value>] [-e | -r] [-w]
+
+FLAGS
+  -e, --enforce         Enforces the policy
+  -g, --gameId=<value>  The ID of the game
+  -r, --revoke          Revokes the policy
+  -w, --waitForAuth     Wait for Google Authentication (10 mins).
+
+DESCRIPTION
+  Gets and sets the iam.disableServiceAccountKeyCreation policy for your Google Organization
+
+EXAMPLES
+  $ shipthis game android apiKey policy
+
+  $ shipthis game android apiKey policy --enforce
+
+  $ shipthis game android apiKey policy --revoke
+```

package/docs/game/android/keyStore.md

@@ -1,10 +1,20 @@
 # Topic: `game android keyStore`
 
+## Description
+
 Commands related to the Android KeyStore for a specific game
 
+:::info
+An Android **keystore** is a secure file where you keep the private key that signs your app. When you build and publish an APK or AAB, this key proves to Google Play (and your users) that the app really comes from you.  
 
-## Commands
+If you have already published your game on Google Play, you will need to [import](#game-android-keystore-import) the same keystore you used before.
+:::
+
+## Example
 
+[![asciicast](https://asciinema.org/a/S3R73FuaGMCwu2C0dHSC0BrJB.svg)](https://asciinema.org/a/S3R73FuaGMCwu2C0dHSC0BrJB#shipthis-col80row24)
+
+## Commands
 
 ### `game android keyStore create`
 
@@ -61,14 +71,14 @@ EXAMPLES
 
 #### Description
 
-Imports an Android Keystore to your ShipThis account for the specified game.
+Imports an Android Keystore to your ShipThis account for the specified game. You can import as JKS and password parameters or as a ZIP file.
 
 #### Help Output
 
 ```help
 USAGE
-  $ shipthis game android keyStore import [FILE] [-g <value>] [--jksFile <value>] [--keystorePassword <value>] [--keyPassword
-    <value>] [-f]
+  $ shipthis game android keyStore import [FILE] [-g <value>] [-f] [--jksFile <value>] [--keyPassword <value>] [--keystorePassword <value>]
+
 
 ARGUMENTS
   FILE  Path to the ZIP file to import (must be in the same format as the export)

package/docs/game/android/status.md

@@ -4,6 +4,10 @@
 
 Shows the status of the setup for the Android platform for a specific game.
 
+## Example
+
+[![asciicast](https://asciinema.org/a/SiTSwpQgQtPIcd56v8hYA7zo8.svg)](https://asciinema.org/a/SiTSwpQgQtPIcd56v8hYA7zo8#shipthis-col80row24)
+
 ## Help Output
 
 ```help

package/docs/game/android.md

@@ -1,316 +1,20 @@
 # Topic: `game android`
 
-Commands related to the Android platform for a specific game
+Commands in the `game android` topic are prefixed `shipthis game android`. They relate to managing the Android platform configuration for a specific game (generally in the current directory).
 
-## Topics
-
-
-# Topic: `game android apiKey`
-
-Commands related to they Android Service Account API Key for a specific game
-
-
-## Commands
-
-
-### `game android apiKey connect`
-
-#### Description
-
-Connects ShipThis with Google for managing Service Account API Keys for an Android game
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android apiKey connect [-g <value>] [-f] [-d]
-
-FLAGS
-  -d, --disconnect
-  -f, --force
-  -g, --gameId=<value>  The ID of the game
-
-DESCRIPTION
-  Connects ShipThis with Google for managing Service Account API Keys for an Android game
-
-EXAMPLES
-  $ shipthis game android apiKey connect
-
-  $ shipthis game android apiKey connect --force
-
-  $ shipthis game android apiKey connect --disconnect
-```
-
-### `game android apiKey create`
-
-#### Description
-
-Creates a new Android Service Account API Key for a game
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android apiKey create [-g <value>] [-w] [-f]
-
-FLAGS
-  -f, --force
-  -g, --gameId=<value>  The ID of the game
-  -w, --waitForAuth     Wait for Google Authentication (10 mins).
-
-DESCRIPTION
-  Creates a new Android Service Account API Key for a game
-
-EXAMPLES
-  $ shipthis game android apiKey create
-
-  $ shipthis game android apiKey create --gameId 0c179fc4
-```
-
-### `game android apiKey export`
-
-#### Description
-
-Saves the current Android Service Account API Key to a ZIP file
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android apiKey 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 Android Service Account API Key to a ZIP file
-
-EXAMPLES
-  $ shipthis game android apiKey export keyStore.zip
-```
-
-### `game android apiKey import`
-
-#### Description
-
-Imports an Android Service Account API Key to your ShipThis account for the specified game.
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android apiKey import FILE [-g <value>] [-f]
-
-ARGUMENTS
-  FILE  Name of the ZIP file to import (must be in the same format as the export)
-
-FLAGS
-  -f, --force
-  -g, --gameId=<value>  The ID of the game
-
-DESCRIPTION
-  Imports an Android Service Account API Key to your ShipThis account for the specified game.
-
-EXAMPLES
-  $ shipthis game android apiKey import
-```
-
-### `game android apiKey invite`
-
-#### Description
-
-Invites the Service Account to your Google Play Account.
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android apiKey invite [ACCOUNTID] [-g <value>] [-p] [-p] [-w]
-
-ARGUMENTS
-  ACCOUNTID  The Google Play Account ID
-
-FLAGS
-  -g, --gameId=<value>    The ID of the game
-  -p, --prompt            Prompt for the Google Play Account ID
-  -p, --waitForGoogleApp  Waits for the Google Play app to be created (10 mins).
-  -w, --waitForAuth       Wait for Google Authentication (10 mins).
-
-DESCRIPTION
-  Invites the Service Account to your Google Play Account.
-
-EXAMPLES
-  $ shipthis game android apiKey invite
-```
-
-### `game android apiKey status`
-
-#### Description
-
-Displays the status of the Android Service Account API Key for a specific game.
+:::tip
+You will need to be authenticated against ShipThis before you can use these commands. To do that please run the following command first:
 
-#### Help Output
+- [`shipthis login`](/docs/reference/login)
 
-```help
-USAGE
-  $ shipthis game android apiKey status [-g <value>]
+:::
 
-FLAGS
-  -g, --gameId=<value>  The ID of the game
 
-DESCRIPTION
-  Displays the status of the Android Service Account API Key for a specific game.
-
-EXAMPLES
-  $ shipthis game android apiKey status
-
-  $ shipthis game android apiKey status --gameId 0c179fc4
-```
-
-
-# Topic: `game android keyStore`
-
-Commands related to the Android KeyStore for a specific game
-
-
-## Commands
-
-
-### `game android keyStore create`
-
-#### Description
-
-Creates a new Android Keystore for a game
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android keyStore create [-g <value>] [-f]
-
-FLAGS
-  -f, --force
-  -g, --gameId=<value>  The ID of the game
-
-DESCRIPTION
-  Creates a new Android Keystore for a game
-
-EXAMPLES
-  $ shipthis game android keyStore create
-
-  $ shipthis game android keyStore create --gameId 0c179fc4
-```
-
-### `game android keyStore export`
-
-#### Description
-
-Saves the current Android Keystore to a ZIP file
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android keyStore 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 Android Keystore to a ZIP file
-
-EXAMPLES
-  $ shipthis game android keyStore export keyStore.zip
-```
-
-### `game android keyStore import`
-
-#### Description
-
-Imports an Android Keystore to your ShipThis account for the specified game.
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android keyStore import [FILE] [-g <value>] [--jksFile <value>] [--keystorePassword <value>] [--keyPassword
-    <value>] [-f]
-
-ARGUMENTS
-  FILE  Path to the ZIP file to import (must be in the same format as the export)
-
-FLAGS
-  -f, --force                     Overwrite any existing keystore without confirmation
-  -g, --gameId=<value>            The ID of the game
-      --jksFile=<value>           Path to the JKS file to import (requires passwords)
-      --keyPassword=<value>       Key alias password (required when using --jksFile)
-      --keystorePassword=<value>  Keystore password (required when using --jksFile)
-
-DESCRIPTION
-  Imports an Android Keystore to your ShipThis account for the specified game.
-
-EXAMPLES
-  $ shipthis game android keyStore import path/to/import.zip -g abfd5b00
-
-  $ shipthis game android keyStore import --jksFile path/to/file.jks --keystorePassword yourpass --keyPassword yourkeypass
-```
-
-### `game android keyStore status`
-
-#### Description
-
-Displays the status of the Android Keystore for a specific game.
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android keyStore status [-g <value>]
-
-FLAGS
-  -g, --gameId=<value>  The ID of the game
-
-DESCRIPTION
-  Displays the status of the Android Keystore for a specific game.
-
-EXAMPLES
-  $ shipthis game android keyStore status
-
-  $ shipthis game android keyStore status --gameId 0c179fc4
-```
+## Topics
 
+- [game android apiKey](/docs/reference/game/android/apiKey)
+- [game android keyStore](/docs/reference/game/android/keyStore)
 
 ## Commands
 
-
-### `game android status`
-
-#### Description
-
-Shows the status of the setup for the Android platform for a specific game.
-
-#### Help Output
-
-```help
-USAGE
-  $ shipthis game android status [-g <value>]
-
-FLAGS
-  -g, --gameId=<value>  The ID of the game
-
-DESCRIPTION
-  Shows the status of the setup for the Android platform for a specific game.
-
-EXAMPLES
-  $ shipthis game android status
-
-  $ shipthis game android status --gameId 0c179fc4
-```
+- [game android status](/docs/reference/game/android/status)

package/docs/game/ship.md

@@ -2,35 +2,67 @@
 
 ## Description
 
-Builds the app (for all platforms with valid credentials) and ships it to the stores.
-
-After uploading the files to the ShipThis backend. it will run the [`shipthis game job status`](/docs/reference/game/job#game-job-status) command with the `--follow` flag so that you can watch the job output in **real-time**.
+The `shipthis game ship` command starts the process of building and publishing your game.
 
 :::info
-This command creates a new job. A **job** is a set of work done to create a new
-build of your game.
+This command creates one or more "jobs". A **job** is a set of work done to create a new build of your game on one platform.
 
-To do this, it uploads the code in the current directory to the ShipThis backend.
+When this command is run, ShipThis uploads the code in the current directory to the ShipThis backend.
 To control which files are uploaded, in the **shipthis.json** file there are two [glob](https://en.wikipedia.org/wiki/Glob_(programming)) arrays **shippedFilesGlobs** and **ignoredFilesGlobs**.
 :::
 
+## Examples
+
+### Standard use
+
+When run without any flags, the command will try to run the full build and publish pipelines for each of the platforms that you have configured.
+
+When run like this, pressing **L** will show or hide the last few lines of the logs, pressing **B** will open the job log in your browser.
+
+[![asciicast](https://asciinema.org/a/7e1jPMx5i69VyM6TynkeFU0dI.svg)](https://asciinema.org/a/7e1jPMx5i69VyM6TynkeFU0dI#shipthis-col80row24)
+
+
+### Follow mode
+
+When using ShipThis in a CI environment, it is most useful to use the `--follow` to collect the full output. This flag requires you to specify the `--platform` flag too.
+
+[![asciicast](https://asciinema.org/a/gKmZ0E1rJ4oiT9SyuSivXBZfY.svg)](https://asciinema.org/a/gKmZ0E1rJ4oiT9SyuSivXBZfY#shipthis-col80row24)
 
-## Example
 
-[![asciicast](https://asciinema.org/a/97iHQ7Vv1qcz0I3jntMmECqLJ.svg)](https://asciinema.org/a/97iHQ7Vv1qcz0I3jntMmECqLJ#shipthis-col160row32)
+### Advanced usage - follow, do not publish, and then download APK
+
+[![asciicast](https://asciinema.org/a/GNf0t8niOlrMDsgPKqmBcuqQh.svg)](https://asciinema.org/a/GNf0t8niOlrMDsgPKqmBcuqQh#shipthis-col80row24)
+
 
 ## Help Output
 
 ```help
+Builds the app (for all platforms with valid credentials) and ships it to the stores.
+
 USAGE
-  $ shipthis game ship [-g <value>]
+  $ shipthis game ship [-g <value>] [--download <value> --platform android|ios] [--downloadAPK <value> ] [--follow ] [--skipPublish]
 
 FLAGS
-  -g, --gameId=<value>  The ID of the game
+  -g, --gameId=<value>       The ID of the game
+      --download=<value>     Download the build artifact to the specified file
+      --downloadAPK=<value>  Download the APK artifact (if available) to the specified file
+      --follow               Follow the job logs in real-time. Requires --platform to be specified.
+      --platform=<option>    The platform to ship the game to. This can be "android" or "ios"
+                             <options: android|ios>
+      --skipPublish          Skip the publish step
 
 DESCRIPTION
   Builds the app (for all platforms with valid credentials) and ships it to the stores.
 
 EXAMPLES
   $ shipthis game ship
-```
+
+  $ shipthis game ship --platform ios
+
+  $ shipthis game ship --platform android --skipPublish
+
+  $ shipthis game ship --platform android --download game.aab
+
+  $ shipthis game ship --platform android --follow --downloadAPK game.apk
+
+```

package/docs/game.md

@@ -3,7 +3,13 @@
 Commands in the game topic are prefixed `shipthis game`. They relate to configuring
 the specific game in the current working directory.
 
-You will need to be authenticated against ShipThis (by running [`shipthis login`](login)) before running the Game commands.
+:::tip
+You will need to be authenticated against ShipThis before you can use these commands. To do that please run the following command first:
+
+- [`shipthis login`](/docs/reference/login)
+
+:::
+
 
 ## Topics
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "ShipThis manages building and uploading your Godot games to the App Store and Google Play.",
-  "version": "0.1.33",
+  "version": "0.1.35",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"
@@ -116,6 +116,7 @@
     "./dist/commands/apple/certificate/import.js",
     "./dist/commands/apple/login.js",
     "./dist/commands/game/list.js",
+    "./dist/commands/game/ship.js",
     "./dist/commands/game/ios/app/create.js",
     "./dist/commands/game/ios/app/status.js",
     "./dist/commands/game/ios/app/sync.js",
@@ -127,8 +128,6 @@
     "./dist/commands/game/ios/profile/status.js",
     "./dist/commands/game/ios/profile/import.js",
     "./dist/commands/game/create.js",
-    "./dist/commands/game/ship.js",
-    "./dist/commands/game/wizard.js",
     "./dist/commands/game/job/list.js",
     "./dist/commands/game/job/status.js",
     "./dist/commands/game/status.js",
@@ -141,14 +140,19 @@
     "./dist/commands/game/android/keyStore/import.js",
     "./dist/commands/game/android/apiKey/export.js",
     "./dist/commands/game/android/apiKey/create.js",
+    "./dist/commands/game/android/apiKey/policy.js",
     "./dist/commands/game/android/apiKey/status.js",
     "./dist/commands/game/android/apiKey/import.js",
     "./dist/commands/game/android/apiKey/invite.js",
     "./dist/commands/game/android/apiKey/connect.js",
     "./dist/commands/game/android/status.js",
+    "./dist/commands/game/wizard.js",
     "./dist/commands/game/export.js",
     "./dist/commands/internal/readme.js",
     "./dist/commands/internal/fastlane.js",
+    "./dist/commands/apiKey/list.js",
+    "./dist/commands/apiKey/create.js",
+    "./dist/commands/apiKey/revoke.js",
     "./dist/commands/status.js",
     "./dist/commands/dashboard.js",
     "./dist/commands/login.js"
@@ -166,6 +170,9 @@
       "internal": {
         "description": "Internal commands"
       },
+      "apiKey": {
+        "description": "Commands related to ShipThis API Keys"
+      },
       "apple": {
         "description": "Commands related to Apple Developer Portal"
       },
@@ -210,6 +217,7 @@
     "build-tsc-alias": "shx rm -rf dist && npx tsc --build && npx tsc-alias -p tsconfig.json",
     "build": "pkgroll --clean-dist",
     "lint": "eslint . --ext .ts,.tsx",
+    "lint-fix": "eslint . --ext .ts,.tsx --fix",
     "posttest": "npm run lint",
     "prepack": "cp package-lock.json package-lock.dev.json || true && npm run readme && oclif manifest && npm shrinkwrap",
     "postpack": "mv package-lock.dev.json package-lock.json || true && shx rm -f oclif.manifest.json && shx rm -f npm-shrinkwrap.json",