shipthis 0.0.21 → 0.0.23

package/README.md

@@ -1,72 +1,21 @@
-shipthis
-=================
+# ShipThis CLI
 
-# Introduction
+## Introduction
 
-Mobile Game Shipping Tool
+ShipThis is a platform that helps you manage shipping your [Godot](https://godotengine.org/) games on iOS to the App Store.
 
-[![Version](https://img.shields.io/npm/v/shipthis.svg)](https://npmjs.org/package/shipthis)
-[![Downloads/week](https://img.shields.io/npm/dw/shipthis.svg)](https://npmjs.org/package/shipthis)
+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).
 
-<!-- toc -->
-* [Introduction](#introduction)
-* [Usage](#usage)
-* [Command Topics](#command-topics)
-<!-- tocstop -->
+## Topics
 
-# Usage
-<!-- usage -->
-```sh-session
-$ npm install -g shipthis
-$ shipthis COMMAND
-running command...
-$ shipthis (--version)
-shipthis/0.0.9 linux-x64 node-v20.17.0
-$ shipthis --help [COMMAND]
-USAGE
-  $ shipthis COMMAND
-...
-```
-<!-- usagestop -->
+- [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
+- [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
 
-<!-- commands -->
-# Command Topics
+## Commands
 
-* [`shipthis apple`](./docs/apple.md) - Commands related to Apple Developer Portal
-* [`shipthis apple apiKey`](docs/apple/apiKey.md) - Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis account
-* [`shipthis apple apiKey create`](docs/apple/apiKey/create.md) - Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis account
-* [`shipthis apple apiKey export`](docs/apple/apiKey/export.md) - Saves the current App Store Connect API Key to a ZIP file
-* [`shipthis apple apiKey import`](docs/apple/apiKey/import.md) - Imports an App Store Connect API Key ZIP file into your ShipThis account
-* [`shipthis apple apiKey status`](docs/apple/apiKey/status.md) - Displays the status of the App Store Connect API Keys in your Apple and ShipThis accounts. The API key is used to automatically publish your games to the App Store.
-* [`shipthis apple certificate`](docs/apple/certificate.md) - Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your ShipThis account
-* [`shipthis apple certificate create`](docs/apple/certificate/create.md) - Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your ShipThis account
-* [`shipthis apple certificate export`](docs/apple/certificate/export.md) - Saves the current Apple Distribution Certificate to a ZIP file.
-* [`shipthis apple certificate import`](docs/apple/certificate/import.md) - Imports an iOS Distribution Certificate to your ShipThis account
-* [`shipthis apple certificate status`](docs/apple/certificate/status.md) - Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts. These are used to sign all of your iOS apps.
-* [`shipthis apple login`](docs/apple/login.md) - Authenticate with Apple - saves the session to the auth file
-* [`shipthis apple status`](docs/apple/status.md) - Shows the status of the Apple authentication and integration
-* [`shipthis dashboard`](docs/dashboard.md) - Opens the web-browser to your ShipThis dashboard
-* [`shipthis game`](docs/game.md) - Commands related to Game Management
-* [`shipthis game build`](docs/game/build.md) - Commands related to builds for a specific game
-* [`shipthis game build download`](docs/game/build/download.md) - Downloads the given build artifact to the specified file
-* [`shipthis game build list`](docs/game/build/list.md) - Lists the builds for successful jobs of a game.
-* [`shipthis game create`](docs/game/create.md) - Create a new game
-* [`shipthis game details`](docs/game/details.md) - Shows and sets the details of a game. If --gameId is not provided it will look in the current directory.
-* [`shipthis game export`](docs/game/export.md) - Downloads the shipthis.json file for a given game into the current directory.
-* [`shipthis game ios`](docs/game/ios.md) - Commands related to the iOS platform for a specific game
-* [`shipthis game ios app`](docs/game/ios/app.md) - Commands related to the App Store App for a specific game
-* [`shipthis game ios profile`](docs/game/ios/profile.md) - Commands related to the App Store Provisioning Profiles for this Game
-* [`shipthis game ios status`](docs/game/ios/status.md) - Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
-* [`shipthis game job`](docs/game/job.md) - Commands related to jobs for a specific game
-* [`shipthis game job list`](docs/game/job/list.md) - Lists the jobs for a game. If --gameId is not provided it will look in the current directory.
-* [`shipthis game job status`](docs/game/job/status.md) - Shows the real-time status of a job.
-* [`shipthis game list`](docs/game/list.md) - Shows a list of all your games
-* [`shipthis game ship`](docs/game/ship.md) - Builds the app (for all platforms with valid credentials) and ships it to the stores
-* [`shipthis game status`](docs/game/status.md) - Shows the Game status. If --gameId is not provided it will look in the current directory.
-* [`shipthis game wizard`](docs/game/wizard.md) - Runs all the steps for the specific platform
-* [`shipthis help`](docs/help.md) - Display help for shipthis.
-* [`shipthis login`](docs/login.md) - Authenticate - will create a new account if one does not exist.
-* [`shipthis status`](docs/status.md) - Displays the current overall status.
-
-<!-- commandsstop -->
+- [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
+- [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/docs/README.md

@@ -1,20 +1,22 @@
-# CLI Reference
+# ShipThis CLI Reference
 
-# Intro
+## Introduction
 
-ShipThis is a platform that helps you manage shipping your [Godot](https://godotengine.org/) Games to the app
-stores. Currently it supports the Apple App Store however more platforms being developed.
+ShipThis is a platform that helps you manage shipping your [Godot](https://godotengine.org/) games on iOS to the App Store.
 
 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).
 
 ## Topics
-- [apple](apple.md)
-- [game](game.md)
+
+- [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
+- [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
 
 ## Commands
-- [dashboard](dashboard.md)
-- [login](login.md)
-- [status](status.md)
-- [help](help.md)
+
+- [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
+- [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/docs/apple/apiKey/create

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

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

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

@@ -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/certificate/create

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

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

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

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

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

@@ -6,7 +6,7 @@ Authenticate with Apple - saves the session to the auth file.
 
 ## Example
 
-[![asciicast](https://asciinema.org/a/CsYDuIS5hfO20CBS5OHbi6VUc.svg)](https://asciinema.org/a/CsYDuIS5hfO20CBS5OHbi6VUc)
+[![asciicast](https://asciinema.org/a/h2wLhEFVy8mLA5dE6hb1gHDyD.svg)](https://asciinema.org/a/h2wLhEFVy8mLA5dE6hb1gHDyD)
 
 
 ## Help Output

package/docs/apple/status

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

package/docs/dashboard

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

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

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

@@ -1,10 +1,15 @@
-# game build
+# Topic: Game Build
 
-Commands related to builds for a specific game
+Commands in the Game Build topic are prefixed `shipthis game build`. They relate
+to managing completed builds of your game.
 
+ShipThis allows you to list and download your builds.
 
-## Commands
+## Example 
+
+[![asciicast](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ.svg)](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ)
 
+## Commands
 
 ### game build download
 

package/docs/game/create

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

package/docs/game/create.md

@@ -1,5 +1,9 @@
 # game create
 
+## Example
+
+[![asciicast](https://asciinema.org/a/Oxf8qnYoVViPNVA40EXKBWG36.svg)](https://asciinema.org/a/Oxf8qnYoVViPNVA40EXKBWG36)
+
 ## Description
 
 Create a new game in ShipThis.

package/docs/game/details

@@ -0,0 +1,35 @@
+# game details
+
+## Description
+
+Shows and sets the details of a game.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game details [-g <value>] [-f] [-b <value>] [-s <value>] [-e <value>] [-v <value>] [-i <value>] [-a
+    <value>]
+
+FLAGS
+  -a, --androidPackageName=<value>  Set the Android package name
+  -b, --buildNumber=<value>         Set the build number
+  -e, --gameEngine=<value>          Set the game engine
+  -f, --force                       Force the command to run
+  -g, --gameId=<value>              The ID of the game
+  -i, --iosBundleId=<value>         Set the iOS bundle ID
+  -s, --semanticVersion=<value>     Set the semantic version
+  -v, --gameEngineVersion=<value>   Set the game engine version
+
+DESCRIPTION
+  Shows and sets the details of a game.
+
+EXAMPLES
+  $ shipthis game details
+
+  $ shipthis game details --gameId 0c179fc4
+
+  $ shipthis game details --buildNumber 5 --semanticVersion 1.2.3
+
+  $ shipthis game details --gameEngine godot --gameEngineVersion 4.2 --force
+```

package/docs/game/details.md

@@ -1,5 +1,9 @@
 # game details
 
+## Example
+
+[![asciicast](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr.svg)](https://asciinema.org/a/5eIVmJYQ6MxDAlFVoVKXhGkYr)
+
 ## Description
 
 Shows and sets the details of a game.

package/docs/game/export

@@ -0,0 +1,26 @@
+# game export
+
+## Description
+
+Downloads the shipthis.json file for a given game into the current directory.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game export GAME_ID [-f]
+
+ARGUMENTS
+  GAME_ID  The ID of the game to export (use "list" to get the ID)
+
+FLAGS
+  -f, --force
+
+DESCRIPTION
+  Downloads the shipthis.json file for a given game into the current directory.
+
+EXAMPLES
+  $ shipthis game export abcd1234
+
+  $ shipthis game export abcd1234 --force
+```

package/docs/game/ios/app/addTester

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

package/docs/game/ios/app/create

@@ -0,0 +1,25 @@
+# game ios app create
+
+## Description
+
+Creates an App and BundleId in the Apple Developer Portal.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios app create [-q] [-g <value>] [-n <value>] [-b <value>] [-f]
+
+FLAGS
+  -b, --bundleId=<value>  The BundleId in the Apple Developer Portal
+  -f, --force
+  -g, --gameId=<value>    The ID of the game
+  -n, --appName=<value>   The name of the App in the Apple Developer Portal
+  -q, --quiet             Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates an App and BundleId in the Apple Developer Portal.
+
+EXAMPLES
+  $ shipthis game ios app create
+```

package/docs/game/ios/app/status

@@ -0,0 +1,21 @@
+# game ios app status
+
+## Description
+
+Shows the Game iOS App status. 
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ios app status [-g <value>]
+
+FLAGS
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Shows the Game iOS App status.
+
+EXAMPLES
+  $ shipthis game ios app status
+```