shipthis 0.0.24 → 0.0.25

package/dist/commands/game/list.js

@@ -1,5 +1,5 @@
 import { jsxs, jsx } from 'react/jsx-runtime';
-import { render, Box, Text } from 'ink';
+import { render, Text, Box } from 'ink';
 import { Flags } from '@oclif/core';
 import { B as BaseAuthenticatedCommand, w as getProjects, f as getShortDate } from '../../baseGameCommand-B3NbuvDu.js';
 import 'path';
@@ -56,7 +56,8 @@ class GameList extends BaseAuthenticatedCommand {
     });
     render(
       /* @__PURE__ */ jsxs(App, { children: [
-        /* @__PURE__ */ jsx(Table, { data }),
+        gameListResponse.data.length === 0 && params.pageNumber == 0 && /* @__PURE__ */ jsx(Text, { children: "No games found. Create one now with $ shipthis game wizard" }),
+        gameListResponse.data.length > 0 && /* @__PURE__ */ jsx(Table, { data }),
         gameListResponse.pageCount > 1 && /* @__PURE__ */ jsxs(Box, { marginTop: 1, flexDirection: "column", children: [
           /* @__PURE__ */ jsx(Text, { children: `Showing page ${flags.pageNumber + 1} of ${gameListResponse.pageCount}.` }),
           /* @__PURE__ */ jsx(Text, { children: "Use the --pageNumber parameter to see other pages." })

package/docs/README.md

@@ -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
 

package/docs/apple/apiKey.md

@@ -1,4 +1,4 @@
-# apple apiKey
+# Topic: `apple apiKey`
 
 Commands related to App Store Connect API Keys
 

package/docs/apple/certificate.md

@@ -1,4 +1,4 @@
-# apple certificate
+# Topic: `apple certificate`
 
 Commands related to App Store Certificates
 

package/docs/apple/login.md

@@ -1,4 +1,4 @@
-# apple login
+# Command: `apple login`
 
 ## Description
 

package/docs/apple/status.md

@@ -1,4 +1,4 @@
-# apple status
+# Command: `apple status`
 
 ## Description
 

package/docs/apple.md

@@ -1,6 +1,6 @@
-# Apple Commands
+# Topic: `apple`
 
-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.
+Commands in the Apple topic are prefixed `shipthis 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.
 
 ## Status
 

package/docs/dashboard.md

@@ -1,4 +1,4 @@
-# dashboard
+# Command: `dashboard`
 
 ## Description
 

package/docs/game/build.md

@@ -1,4 +1,4 @@
-# Topic: Game Build
+# Topic: `game build`
 
 Commands in the Game Build topic are prefixed `shipthis game build`. They relate
 to managing completed builds of your game.

package/docs/game/create.md

@@ -1,4 +1,4 @@
-# game create
+# Command: `game create`
 
 ## Description
 
@@ -7,7 +7,7 @@ Creates a new game in your [ShipThis account](https://shipthis.cc/games).
 It will read the name of your game from your `project.godot` file. You will be
 prompted to confirm this name, or you can specify one with the `--name` flag. 
 
-If there is already a ShipThis game config file (`shithis.json`) in the current
+If there is already a ShipThis game config file (`shipthis.json`) in the current
 directory then you will need to use the `--force` flag to create a new game and
 overwrite this file with the config for the new game.
 

package/docs/game/details.md

@@ -1,4 +1,4 @@
-# game details
+# Command: `game details`
 
 ## Description
 

package/docs/game/export.md

@@ -1,4 +1,4 @@
-# game export
+# Command: `game export`
 
 ## Description
 

package/docs/game/ios/app.md

@@ -1,36 +1,10 @@
-# game ios app
+# Topic: `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

package/docs/game/ios/profile.md

@@ -1,4 +1,4 @@
-# game ios profile
+# Topic: `game ios profile`
 
 Commands related to the App Store Provisioning Profiles for this Game
 

package/docs/game/ios/status.md

@@ -1,4 +1,4 @@
-# game ios status
+# Command: `game ios status`
 
 ## Description
 

package/docs/game/ios.md

@@ -1,4 +1,4 @@
-# Topic: Game iOS
+# Topic: `game ios`
 
 Commands in the Game iOS topic are prefixed `shipthis game ios`. They relate to
 managing the iOS platform configuration for the game in the current directory.
@@ -11,7 +11,6 @@ these commands. To do that please run the following commands first:
 - [`shipthis apple login`](/docs/reference/apple/login)
 :::
 
-
 ## Topics
 
 - [game ios app](/docs/reference/game/ios/app)

package/docs/game/job.md

@@ -1,4 +1,4 @@
-# game job
+# Topic: `game job`
 
 Commands related to jobs for a specific game
 

package/docs/game/list.md

@@ -1,4 +1,4 @@
-# game list
+# Command: `game list`
 
 ## Description
 

package/docs/game/ship.md

@@ -1,4 +1,4 @@
-# game ship
+# Command: `game ship`
 
 ## Description
 

package/docs/game/status.md

@@ -1,4 +1,4 @@
-# game status
+# Command: `game status`
 
 ## Description
 

package/docs/game/wizard.md

@@ -1,4 +1,4 @@
-# game wizard
+# Command: `game wizard`
 
 ## Description
 

package/docs/game.md

@@ -1,6 +1,6 @@
-# Game Commands
+# Topic: `game`
 
-Commands in the Game topic are prefixed `shipthis game`. They relate to configuring
+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.

package/docs/help.md

@@ -1,4 +1,4 @@
-# help
+# Command: `help`
 
 ## Description
 

package/docs/login.md

@@ -1,4 +1,4 @@
-# login
+# Command: `login`
 
 ## Description
 

package/docs/status.md

@@ -1,4 +1,4 @@
-# status
+# Command: `status`
 
 ## Description
 

package/oclif.manifest.json

@@ -514,10 +514,10 @@
         "wizard.js"
       ]
     },
-    "apple:apiKey:create": {
+    "apple:certificate:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
+      "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -539,7 +539,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:create",
+      "id": "apple:certificate:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -549,11 +549,11 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "create.js"
       ]
     },
-    "apple:apiKey:export": {
+    "apple:certificate:export": {
       "aliases": [],
       "args": {
         "file": {
@@ -562,9 +562,9 @@
           "required": true
         }
       },
-      "description": "Saves the current App Store Connect API Key to a ZIP file",
+      "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+        "<%= config.bin %> <%= command.id %> userCert.zip"
       ],
       "flags": {
         "force": {
@@ -577,7 +577,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:export",
+      "id": "apple:certificate:export",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -588,11 +588,11 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "export.js"
       ]
     },
-    "apple:apiKey:import": {
+    "apple:certificate:import": {
       "aliases": [],
       "args": {
         "file": {
@@ -601,9 +601,9 @@
           "required": true
         }
       },
-      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
+      "description": "Imports an iOS Distribution Certificate to your ShipThis account",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+        "<%= config.bin %> <%= command.id %> userCert.zip"
       ],
       "flags": {
         "force": {
@@ -615,7 +615,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:import",
+      "id": "apple:certificate:import",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -626,14 +626,14 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "import.js"
       ]
     },
-    "apple:apiKey:status": {
+    "apple:certificate:status": {
       "aliases": [],
       "args": {},
-      "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.",
+      "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.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -648,7 +648,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:status",
+      "id": "apple:certificate:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -659,14 +659,14 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "status.js"
       ]
     },
-    "apple:certificate:create": {
+    "apple:apiKey:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
+      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -688,7 +688,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:create",
+      "id": "apple:apiKey:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -698,11 +698,11 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "create.js"
       ]
     },
-    "apple:certificate:export": {
+    "apple:apiKey:export": {
       "aliases": [],
       "args": {
         "file": {
@@ -711,9 +711,9 @@
           "required": true
         }
       },
-      "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
+      "description": "Saves the current App Store Connect API Key to a ZIP file",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userCert.zip"
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
       ],
       "flags": {
         "force": {
@@ -726,7 +726,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:export",
+      "id": "apple:apiKey:export",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -737,11 +737,11 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "export.js"
       ]
     },
-    "apple:certificate:import": {
+    "apple:apiKey:import": {
       "aliases": [],
       "args": {
         "file": {
@@ -750,9 +750,9 @@
           "required": true
         }
       },
-      "description": "Imports an iOS Distribution Certificate to your ShipThis account",
+      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userCert.zip"
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
       ],
       "flags": {
         "force": {
@@ -764,7 +764,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:import",
+      "id": "apple:apiKey:import",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -775,14 +775,14 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "import.js"
       ]
     },
-    "apple:certificate:status": {
+    "apple:apiKey:status": {
       "aliases": [],
       "args": {},
-      "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.",
+      "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.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -797,7 +797,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:status",
+      "id": "apple:apiKey:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -808,7 +808,7 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "status.js"
       ]
     },
@@ -1508,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.24"
+  "version": "0.0.25"
 }

package/package.json

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