shipthis 0.0.23 → 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,9 +1,20 @@
-# apple login
+# Command: `apple login`
 
 ## Description
 
 Authenticate with Apple - saves the session to the auth file.
 
+:::note
+Your Apple Developer credentials never leave your local computer. We recommend
+enabling [two-factor authentication (2FA)](https://support.apple.com/kb/HT204915)
+for your Apple ID.
+:::
+
+ShipThis makes use of Apple's APIs to manage your signing certificates, API keys,
+provisioning profiles, bundleIds and apps within the Apple Developer Portal on
+your behalf. To do this, ShipThis generates temporary session cookies which it re-uses between the various
+[apple commands](/docs/reference/apple).
+
 ## Example
 
 [![asciicast](https://asciinema.org/a/h2wLhEFVy8mLA5dE6hb1gHDyD.svg)](https://asciinema.org/a/h2wLhEFVy8mLA5dE6hb1gHDyD)

package/docs/apple/status.md

@@ -1,12 +1,16 @@
-# apple status
+# Command: `apple status`
 
 ## Description
 
-Shows the status of the Apple authentication and integration
+Shows the status of the Apple authentication and integration.
+
+If you have authenticated against Apple, it will show **"YES"** for "Authenticated on Apple Developer Portal".
+
+To authenticate, please run [`shipthis apple login`](/docs/reference/apple/login).
 
 ## Example
 
-[![asciicast](https://asciinema.org/a/g4hSnl66PE7xz7FGmeMwBdqoN.svg)](https://asciinema.org/a/g4hSnl66PE7xz7FGmeMwBdqoN)
+[![asciicast](https://asciinema.org/a/PPSZ5EUxbdnd3IqCk6vtb2Bmw.svg)](https://asciinema.org/a/PPSZ5EUxbdnd3IqCk6vtb2Bmw)
 
 ## Help Output
 ```

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`) 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,8 +1,20 @@
-# dashboard
+# Command: `dashboard`
 
 ## Description
 
-Opens the web-browser to your ShipThis dashboard
+Opens the web-browser to your ShipThis dashboard.
+
+:::note
+ShipThis generates single-use links which will automatically log you into shipthis.cc in your browser.
+:::
+
+
+
+You need to have authenticated with [`shipthis login`](/docs/reference/login) first.
+
+## Example
+
+[![asciicast](https://asciinema.org/a/J7A5mafE3kCM6yGLpuVBmEQgh.svg)](https://asciinema.org/a/J7A5mafE3kCM6yGLpuVBmEQgh)
 
 ## Help Output
 

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,12 +1,25 @@
-# game create
+# Command: `game create`
+
+## Description
+
+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 (`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.
+
+ShipThis will detect the version of Godot you are using from your `project.godot`
+file. This can be changed with the [`shipthis game details`](/docs/reference/game/details)
+command.
 
 ## Example
 
 [![asciicast](https://asciinema.org/a/Oxf8qnYoVViPNVA40EXKBWG36.svg)](https://asciinema.org/a/Oxf8qnYoVViPNVA40EXKBWG36)
 
-## Description
 
-Create a new game in ShipThis.
 
 ## Help Output
 
@@ -24,4 +37,4 @@ DESCRIPTION
 
 EXAMPLES
   $ shipthis game create
-```
+``` 

package/docs/game/details.md

@@ -1,12 +1,29 @@
-# game details
+# Command: `game details`
 
-## Example
+## Description
 
-[![asciicast](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr.svg)](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr)
+Shows and sets the details of the current game.
 
-## Description
+If you run the command without any flags it will show the details of the current
+game.
+
+You can edit any of the values using the appropriate flag. After changing the
+value, it will output all the values again.
+
+The following fields can only be changed if you have the `--force` flag set:
 
-Shows and sets the details of a game.
+- `--gameEngine` - Change the Game Engine (currently only "godot" is supported)
+- `--gameEngineVersion` - Change the version of the Game Engine (currently only 3.6 and 4.3 are supported)
+- `--iosBundleId` - iOS Bundle ID
+- `--androidPackageName` Android Package Name (not currently used)
+
+:::tip
+After changing these values, you will need to trigger a new build of your game with [`shipthis game ship`](/docs/reference/game/ship)
+:::
+
+## Example
+
+[![asciicast](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr.svg)](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr)
 
 ## Help Output
 

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.
@@ -8,8 +8,8 @@ You will need to be authenticated against ShipThis (by running [`shipthis login`
 ## Topics
 
 - [game build](/docs/reference/game/build)
-- [game ios](/docs/reference/game//ios)
-- [game job](/docs/reference/game//job)
+- [game ios](/docs/reference/game/ios)
+- [game job](/docs/reference/game/job)
 
 ## Commands
 

package/docs/help.md

@@ -1,8 +1,8 @@
-# help
+# Command: `help`
 
 ## Description
 
-Display help for <%= config.bin %>.
+Display help for shipthis.
 
 ## Help Output
 

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

@@ -1508,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.23"
+  "version": "0.0.25"
 }

package/package.json

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

package/docs/apple/apiKey/create

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

package/docs/apple/apiKey/export

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

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

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

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

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

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

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

@@ -1,25 +0,0 @@
-# apple login
-
-## Description
-
-Authenticate with Apple - saves the session to the auth file
-
-## Help Output
-
-```
-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

@@ -1,18 +0,0 @@
-# apple status
-
-## Description
-
-Shows the status of the Apple authentication and integration.
-
-## Help Output
-
-```
-USAGE
-  $ shipthis apple status
-
-DESCRIPTION
-  Shows the status of the Apple authentication and integration.
-
-EXAMPLES
-  $ shipthis apple status
-```