shipthis 0.0.25 → 0.0.26

package/README.md

@@ -1,4 +1,4 @@
-# ShipThis CLI
+# ShipThis CLI Reference
 
 ## Introduction
 
@@ -6,7 +6,56 @@ ShipThis is a platform that helps you manage shipping your [Godot](https://godot
 
 This is all done with an easy to use command line tool called `shipthis`.
 
-You can discover **ShipThis in less than 5 minutes** via our [Quick Start Guide](https://shipthis.cc/docs/quickstart).
+## Quickstart
+
+Let's discover **ShipThis in less than 5 minutes**.
+
+### Getting Started
+
+ShipThis is a platform that helps you manage shipping your [Godot](https://godotengine.org/) games to the App Store.
+
+#### What you'll need
+
+- A Godot game
+- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
+  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+- An [Apple Developer](https://developer.apple.com) account
+
+### 1. Install ShipThis
+
+    ShipThis can be installed as a package via the [NPM package manager](https://www.npmjs.com/). Run the following at the command line:
+
+```
+npm install -g shipthis
+```
+
+### 2. Create an account
+
+Set up an account with ShipThis by logging in for the first time using the [`shipthis login`](https://shipthis.cc/docs/reference/login) command.
+
+```
+shipthis login
+```
+
+### 3. Configure your game
+
+Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard):
+
+```
+shipthis game wizard
+```
+
+### 4. Ship
+
+Now you can publish your game to TestFlight with the [`shipthis game ship`](https://shipthis.cc/docs/reference/game/ship) command:
+
+```
+shipthis game ship
+```
+
+Once you are happy with the build you can submit it to Apple using [App Store
+Connect](https://appstoreconnect.apple.com/).
+
 
 ## Topics
 
@@ -19,3 +68,4 @@ You can discover **ShipThis in less than 5 minutes** via our [Quick Start Guide]
 - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
 - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
 - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
+

package/oclif.manifest.json

@@ -1117,14 +1117,21 @@
         "status.js"
       ]
     },
-    "game:ios:app:addTester": {
+    "game:ios:profile:create": {
       "aliases": [],
       "args": {},
-      "description": "Adds a test user to the game in App Store Connect.",
+      "description": "Creates a Mobile Provisioning Profile in the Apple Developer Portal.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
+        "quiet": {
+          "char": "q",
+          "description": "Avoid output except for interactions and errors",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "gameId": {
           "char": "g",
           "description": "The ID of the game",
@@ -1133,34 +1140,16 @@
           "multiple": false,
           "type": "option"
         },
-        "email": {
-          "char": "e",
-          "description": "The email address of the tester",
-          "name": "email",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "firstName": {
+        "force": {
           "char": "f",
-          "description": "The first name of the tester",
-          "name": "firstName",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "lastName": {
-          "char": "l",
-          "description": "The last name of the tester",
-          "name": "lastName",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:app:addTester",
+      "id": "game:ios:profile:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1172,25 +1161,24 @@
         "commands",
         "game",
         "ios",
-        "app",
-        "addTester.js"
+        "profile",
+        "create.js"
       ]
     },
-    "game:ios:app:create": {
+    "game:ios:profile:export": {
       "aliases": [],
-      "args": {},
-      "description": "Creates an App and BundleId in the Apple Developer Portal.",
+      "args": {
+        "file": {
+          "description": "Name of the ZIP file to create",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Saves the current Mobile Provisioning Profile to a ZIP file",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %> userProfile.zip"
       ],
       "flags": {
-        "quiet": {
-          "char": "q",
-          "description": "Avoid output except for interactions and errors",
-          "name": "quiet",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "gameId": {
           "char": "g",
           "description": "The ID of the game",
@@ -1199,24 +1187,9 @@
           "multiple": false,
           "type": "option"
         },
-        "appName": {
-          "char": "n",
-          "description": "The name of the App in the Apple Developer Portal",
-          "name": "appName",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "bundleId": {
-          "char": "b",
-          "description": "The BundleId in the Apple Developer Portal",
-          "name": "bundleId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "force": {
           "char": "f",
+          "description": "Overwrite the file if it already exists",
           "name": "force",
           "allowNo": false,
           "type": "boolean"
@@ -1224,7 +1197,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:app:create",
+      "id": "game:ios:profile:export",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1236,16 +1209,22 @@
         "commands",
         "game",
         "ios",
-        "app",
-        "create.js"
+        "profile",
+        "export.js"
       ]
     },
-    "game:ios:app:status": {
+    "game:ios:profile:import": {
       "aliases": [],
-      "args": {},
-      "description": "Shows the Game iOS App status. ",
+      "args": {
+        "file": {
+          "description": "Name of the ZIP file to import (must be in the same format as the export)",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Imports an Mobile Provisioning Profile to your ShipThis account",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %> profile.zip"
       ],
       "flags": {
         "gameId": {
@@ -1255,11 +1234,17 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:app:status",
+      "id": "game:ios:profile:import",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1271,25 +1256,18 @@
         "commands",
         "game",
         "ios",
-        "app",
-        "status.js"
+        "profile",
+        "import.js"
       ]
     },
-    "game:ios:app:sync": {
+    "game:ios:profile:status": {
       "aliases": [],
       "args": {},
-      "description": "Synchronies the Apple App \"BundleId\" with the capabilities from the local project.",
+      "description": "Shows the Game iOS Mobile Provisioning Profile Status.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
-        "quiet": {
-          "char": "q",
-          "description": "Avoid output except for interactions and errors",
-          "name": "quiet",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "gameId": {
           "char": "g",
           "description": "The ID of the game",
@@ -1298,16 +1276,16 @@
           "multiple": false,
           "type": "option"
         },
-        "force": {
+        "noAppleAuth": {
           "char": "f",
-          "name": "force",
+          "name": "noAppleAuth",
           "allowNo": false,
           "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:app:sync",
+      "id": "game:ios:profile:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1319,25 +1297,18 @@
         "commands",
         "game",
         "ios",
-        "app",
-        "sync.js"
+        "profile",
+        "status.js"
       ]
     },
-    "game:ios:profile:create": {
+    "game:ios:app:addTester": {
       "aliases": [],
       "args": {},
-      "description": "Creates a Mobile Provisioning Profile in the Apple Developer Portal.",
+      "description": "Adds a test user to the game in App Store Connect.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
-        "quiet": {
-          "char": "q",
-          "description": "Avoid output except for interactions and errors",
-          "name": "quiet",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "gameId": {
           "char": "g",
           "description": "The ID of the game",
@@ -1346,16 +1317,34 @@
           "multiple": false,
           "type": "option"
         },
-        "force": {
+        "email": {
+          "char": "e",
+          "description": "The email address of the tester",
+          "name": "email",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "firstName": {
           "char": "f",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
+          "description": "The first name of the tester",
+          "name": "firstName",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "lastName": {
+          "char": "l",
+          "description": "The last name of the tester",
+          "name": "lastName",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:profile:create",
+      "id": "game:ios:app:addTester",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1367,24 +1356,25 @@
         "commands",
         "game",
         "ios",
-        "profile",
-        "create.js"
+        "app",
+        "addTester.js"
       ]
     },
-    "game:ios:profile:export": {
+    "game:ios:app:create": {
       "aliases": [],
-      "args": {
-        "file": {
-          "description": "Name of the ZIP file to create",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Saves the current Mobile Provisioning Profile to a ZIP file",
+      "args": {},
+      "description": "Creates an App and BundleId in the Apple Developer Portal.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userProfile.zip"
+        "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
+        "quiet": {
+          "char": "q",
+          "description": "Avoid output except for interactions and errors",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "gameId": {
           "char": "g",
           "description": "The ID of the game",
@@ -1393,9 +1383,24 @@
           "multiple": false,
           "type": "option"
         },
+        "appName": {
+          "char": "n",
+          "description": "The name of the App in the Apple Developer Portal",
+          "name": "appName",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "bundleId": {
+          "char": "b",
+          "description": "The BundleId in the Apple Developer Portal",
+          "name": "bundleId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "force": {
           "char": "f",
-          "description": "Overwrite the file if it already exists",
           "name": "force",
           "allowNo": false,
           "type": "boolean"
@@ -1403,7 +1408,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:profile:export",
+      "id": "game:ios:app:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1415,22 +1420,16 @@
         "commands",
         "game",
         "ios",
-        "profile",
-        "export.js"
+        "app",
+        "create.js"
       ]
     },
-    "game:ios:profile:import": {
+    "game:ios:app:status": {
       "aliases": [],
-      "args": {
-        "file": {
-          "description": "Name of the ZIP file to import (must be in the same format as the export)",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Imports an Mobile Provisioning Profile to your ShipThis account",
+      "args": {},
+      "description": "Shows the Game iOS App status. ",
       "examples": [
-        "<%= config.bin %> <%= command.id %> profile.zip"
+        "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
         "gameId": {
@@ -1440,17 +1439,11 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "force": {
-          "char": "f",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:profile:import",
+      "id": "game:ios:app:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1462,18 +1455,25 @@
         "commands",
         "game",
         "ios",
-        "profile",
-        "import.js"
+        "app",
+        "status.js"
       ]
     },
-    "game:ios:profile:status": {
+    "game:ios:app:sync": {
       "aliases": [],
       "args": {},
-      "description": "Shows the Game iOS Mobile Provisioning Profile Status.",
+      "description": "Synchronies the Apple App \"BundleId\" with the capabilities from the local project.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
+        "quiet": {
+          "char": "q",
+          "description": "Avoid output except for interactions and errors",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "gameId": {
           "char": "g",
           "description": "The ID of the game",
@@ -1482,16 +1482,16 @@
           "multiple": false,
           "type": "option"
         },
-        "noAppleAuth": {
+        "force": {
           "char": "f",
-          "name": "noAppleAuth",
+          "name": "force",
           "allowNo": false,
           "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "game:ios:profile:status",
+      "id": "game:ios:app:sync",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -1503,10 +1503,10 @@
         "commands",
         "game",
         "ios",
-        "profile",
-        "status.js"
+        "app",
+        "sync.js"
       ]
     }
   },
-  "version": "0.0.25"
+  "version": "0.0.26"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "Game Shipping Tool",
-  "version": "0.0.25",
+  "version": "0.0.26",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"