From 7c613d0f74a08ab7a53f8e102c5991ce05d2dbf7 Mon Sep 17 00:00:00 2001 From: David Sutherland Date: Thu, 16 Jul 2026 16:09:00 +0100 Subject: [PATCH 1/3] docs: updating flags and descriptions for many commands --- docs/apple/login.md | 10 ++++++++-- docs/autocomplete.md | 2 +- docs/game/create.md | 24 ++++++++++++++---------- docs/game/details.md | 4 +++- docs/game/ios.md | 1 + docs/game/ios/app.md | 34 ++++++++++++++++++++++++++++++++-- docs/game/ios/app/addTester.md | 15 ++++++++++----- docs/game/ship.md | 8 ++++++-- docs/game/status.md | 8 ++++++-- docs/game/wizard.md | 7 ++----- 10 files changed, 83 insertions(+), 30 deletions(-) diff --git a/docs/apple/login.md b/docs/apple/login.md index ae840389..8bce4ff6 100644 --- a/docs/apple/login.md +++ b/docs/apple/login.md @@ -24,18 +24,24 @@ your behalf. To do this, ShipThis generates temporary session cookies which it r ```help USAGE - $ shipthis apple login [-q] [-f] [-e ] + $ shipthis apple login [-e ] [-f] [-q] [-l] FLAGS -e, --appleEmail= Your Apple Developer email address -f, --force + -l, --logout Forget the saved Apple session (log out) -q, --quiet Avoid output except for interactions and errors DESCRIPTION - Authenticate with Apple - saves the session to the auth file + Authenticate with Apple - saves the session to the auth file. + + Your Apple password is sent only to Apple, never to ShipThis. Only the resulting session cookies are saved locally. + Read the source: https://github.com/shipth-is/cli/blob/main/src/commands/apple/login.ts EXAMPLES $ shipthis apple login $ shipthis apple login --force --appleEmail me@email.nowhere + + $ shipthis apple login --logout ``` \ No newline at end of file diff --git a/docs/autocomplete.md b/docs/autocomplete.md index dd17b5a4..0fb36513 100644 --- a/docs/autocomplete.md +++ b/docs/autocomplete.md @@ -43,7 +43,7 @@ USAGE $ shipthis autocomplete [SHELL] [-r] ARGUMENTS - SHELL (zsh|bash|powershell) Shell type + [SHELL] (zsh|bash|powershell) Shell type FLAGS -r, --refresh-cache Refresh cache (ignores displaying instructions) diff --git a/docs/game/create.md b/docs/game/create.md index 89a3d560..da54575b 100644 --- a/docs/game/create.md +++ b/docs/game/create.md @@ -28,19 +28,23 @@ command. ```help USAGE - $ shipthis game create [-q] [-f] [-n ] [-b ] [-s ] [-e ] [-v ] [-i ] - [-a ] + $ shipthis game create [-f] [-q] [-a ] [-b ] [-e ] [-v ] [-g ] [-c ] + [-i ] [-l ] [-n ] [-s ] [-d ] FLAGS - -a, --androidPackageName= Set the Android package name - -b, --buildNumber= Set the build number - -e, --gameEngine= Set the game engine + -a, --androidPackageName= Set the Android package name + -b, --buildNumber= Set the build number + -c, --gcpServiceAccountId= Set the GCP service account ID + -d, --useDemoCredentials= Use demo credentials for this project + -e, --gameEngine= Set the game engine -f, --force - -i, --iosBundleId= Set the iOS bundle ID - -n, --name= The name of the game - -q, --quiet Avoid output except for interactions and errors - -s, --semanticVersion= Set the semantic version - -v, --gameEngineVersion= Set the game engine version + -g, --gcpProjectId= Set the GCP project ID + -i, --iosBundleId= Set the iOS bundle ID + -l, --liquidGlassIconPath= Set the Liquid Glass icon path + -n, --name= The name of the game + -q, --quiet Avoid output except for interactions and errors + -s, --semanticVersion= Set the semantic version + -v, --gameEngineVersion= Set the game engine version DESCRIPTION Create a new game in ShipThis. diff --git a/docs/game/details.md b/docs/game/details.md index c2b7131a..39e0c84f 100644 --- a/docs/game/details.md +++ b/docs/game/details.md @@ -29,7 +29,8 @@ After changing these values, you will need to trigger a new build of your game w ```help USAGE - $ shipthis game details [-g ] [-f] [-a ] [-b ] [-e ] [-v ] [-g ] [-c ] [-i ] [-n ] [-s ] [-d ] + $ shipthis game details [-g ] [-f] [-a ] [-b ] [-e ] [-v ] [-g ] [-c + ] [-i ] [-l ] [-n ] [-s ] [-d ] FLAGS -a, --androidPackageName= Set the Android package name @@ -41,6 +42,7 @@ FLAGS -g, --gameId= The ID of the game -g, --gcpProjectId= Set the GCP project ID -i, --iosBundleId= Set the iOS bundle ID + -l, --liquidGlassIconPath= Set the Liquid Glass icon path -n, --name= The name of the game -s, --semanticVersion= Set the semantic version -v, --gameEngineVersion= Set the game engine version diff --git a/docs/game/ios.md b/docs/game/ios.md index 0453d325..3ff386ca 100644 --- a/docs/game/ios.md +++ b/docs/game/ios.md @@ -21,4 +21,5 @@ these commands. To do that please run the following commands first: ## Commands - [game ios status](/docs/reference/game/ios/status) +- [game ios wizard](/docs/reference/game/ios/wizard) diff --git a/docs/game/ios/app.md b/docs/game/ios/app.md index 882bee48..173ad388 100644 --- a/docs/game/ios/app.md +++ b/docs/game/ios/app.md @@ -22,6 +22,36 @@ these commands. To do that please run the following commands first: ## Commands +### `game ios app addTester` + +#### Description + +Adds a test user to the game in App Store Connect. + +#### Help Output + +```help +USAGE + $ shipthis game ios app addTester [-e ] [-f ] [-g ] [-l ] [-q] [-s] [-t ] + +FLAGS + -e, --email= The email address of the tester + -f, --firstName= The first name of the tester + -g, --gameId= The ID of the game + -l, --lastName= The last name of the tester + -q, --quiet Avoid output except for interactions and errors + -s, --self Add yourself as a tester (uses your Apple ID email and name) + -t, --testGroupName= [default: ShipThis Test Group (Internal)] The name of the internal test group + +DESCRIPTION + Adds a test user to the game in App Store Connect. + +EXAMPLES + $ shipthis game ios app addTester + + $ shipthis game ios app addTester --testGroupName "Testers" +``` + ### `game ios app create` #### Description @@ -42,7 +72,7 @@ to be unique within the Apple ecosystem. ShipThis will suggest values for these. ```help USAGE - $ shipthis game ios app create [-q] [-g ] [-n ] [-b ] [-f] + $ shipthis game ios app create [-n ] [-b ] [-f] [-g ] [-q] FLAGS -b, --bundleId= The BundleId in the Apple Developer Portal @@ -120,7 +150,7 @@ ShipThis will use default values for this file if it does not exist. ```help USAGE - $ shipthis game ios app sync [-q] [-g ] [-f] + $ shipthis game ios app sync [-f] [-g ] [-q] FLAGS -f, --force diff --git a/docs/game/ios/app/addTester.md b/docs/game/ios/app/addTester.md index 7bda1b14..2e4c84b0 100644 --- a/docs/game/ios/app/addTester.md +++ b/docs/game/ios/app/addTester.md @@ -8,17 +8,22 @@ Adds a test user to the game in App Store Connect. ```help USAGE - $ shipthis game ios app addTester [-g ] [-e ] [-f ] [-l ] + $ shipthis game ios app addTester [-e ] [-f ] [-g ] [-l ] [-q] [-s] [-t ] FLAGS - -e, --email= The email address of the tester - -f, --firstName= The first name of the tester - -g, --gameId= The ID of the game - -l, --lastName= The last name of the tester + -e, --email= The email address of the tester + -f, --firstName= The first name of the tester + -g, --gameId= The ID of the game + -l, --lastName= The last name of the tester + -q, --quiet Avoid output except for interactions and errors + -s, --self Add yourself as a tester (uses your Apple ID email and name) + -t, --testGroupName= [default: ShipThis Test Group (Internal)] The name of the internal test group DESCRIPTION Adds a test user to the game in App Store Connect. EXAMPLES $ shipthis game ios app addTester + + $ shipthis game ios app addTester --testGroupName "Testers" ``` \ No newline at end of file diff --git a/docs/game/ship.md b/docs/game/ship.md index 8f7114c2..7f30c0e9 100644 --- a/docs/game/ship.md +++ b/docs/game/ship.md @@ -55,13 +55,15 @@ shipthis game ship --platform android --follow --gameEngineVersion 4.5.1 --downl ```help USAGE - $ shipthis game ship [-g ] [--download --platform android|ios] [--downloadAPK ] [--follow ] [--skipPublish] [--verbose] [--useDemoCredentials ] - [--gameEngineVersion ] + $ shipthis game ship [-g ] [--download --platform android|ios] [--downloadAPK ] + [--follow ] [--skipPublish] [--verbose] [--useDemoCredentials ] [--gameEngineVersion ] [--dryRun] FLAGS -g, --gameId= The ID of the game --download= Download the build artifact to the specified file --downloadAPK= Download the APK artifact (if available) to the specified file + --dryRun Dry run - lists the files that would be shipped without executing the build or + publish steps --follow Follow the job logs in real-time (requires --platform) --gameEngineVersion= Override the specified game engine version for this build --platform=