From 537cc30ff7011b49cb5497f45165499f44f6c6b7 Mon Sep 17 00:00:00 2001 From: David Sutherland Date: Thu, 6 Aug 2026 15:12:53 +0100 Subject: [PATCH] docs: fixing typos, missing links and small omissions --- README.md | 10 ++++++++- docs/README.md | 6 +++--- docs/apiKey.md | 2 +- docs/apiKey/create.md | 2 +- docs/apple.md | 21 +++++++++++-------- docs/apple/apiKey/create.md | 2 +- docs/apple/apiKey/export.md | 2 +- docs/apple/apiKey/import.md | 2 +- docs/apple/apiKey/status.md | 2 +- docs/apple/certificate.md | 2 +- docs/apple/certificate/create.md | 2 +- docs/apple/certificate/export.md | 2 +- docs/apple/certificate/import.md | 2 +- docs/apple/certificate/status.md | 2 +- docs/apple/status.md | 2 +- docs/game.md | 1 + docs/game/android/apiKey.md | 4 ++-- docs/game/android/apiKey/connect.md | 2 +- docs/game/android/apiKey/create.md | 2 +- docs/game/android/apiKey/export.md | 4 ++-- docs/game/android/apiKey/import.md | 4 ++-- docs/game/android/keyStore.md | 11 +++++----- docs/game/android/keyStore/export.md | 2 +- docs/game/android/keyStore/import.md | 11 +++++----- docs/game/build.md | 2 +- docs/game/build/download.md | 2 +- docs/game/build/list.md | 4 ++-- docs/game/details.md | 4 ++-- docs/game/ios.md | 2 +- docs/game/ios/app.md | 4 ++-- docs/game/ios/app/addTester.md | 2 +- docs/game/ios/app/create.md | 4 ++-- docs/game/ios/app/status.md | 2 +- docs/game/ios/app/sync.md | 8 +++---- docs/game/ios/profile.md | 12 +++++------ docs/game/ios/profile/create.md | 4 ++-- docs/game/ios/profile/export.md | 4 ++-- docs/game/ios/profile/import.md | 8 +++---- docs/game/ios/profile/status.md | 2 +- docs/game/job.md | 6 +++--- docs/game/job/list.md | 4 ++-- docs/game/job/status.md | 4 ++-- docs/game/list.md | 2 +- docs/game/ship.md | 4 +++- docs/game/status.md | 2 +- docs/help.md | 2 +- docs/login.md | 3 +-- package.json | 2 +- src/commands/game/android/apiKey/export.tsx | 2 +- src/commands/game/android/apiKey/import.tsx | 2 +- src/commands/game/android/keyStore/import.tsx | 3 ++- src/commands/game/ios/app/sync.tsx | 2 +- src/commands/game/ios/profile/import.tsx | 2 +- src/commands/internal/readme.tsx | 4 ++-- 54 files changed, 113 insertions(+), 97 deletions(-) diff --git a/README.md b/README.md index 97e6897d..7dda99b0 100644 --- a/README.md +++ b/README.md @@ -256,12 +256,20 @@ The iOS steps are described in the [iOS setup guide](https://shipth.is/docs/ios) 1. Synchronize Permissions (Capabilities) - ShipThis reads `export_presets.cfg` and enables supported capabilities in the Apple Developer Portal (currently Access WiFi, Push Notifications). + ShipThis reads `export_presets.cfg` and enables supported capabilities in the Apple Developer Portal (Access WiFi, Increased Memory Limit, Game Center, Push Notifications, plus known keys from `entitlements/additional`). See the [`game ios app sync` reference](https://shipth.is/docs/reference/game/ios/app?ref=github_readme#game-ios-app-sync) for the full table. ```bash shipthis game ios app sync ``` +1. Add yourself as a TestFlight tester + + ShipThis adds your Apple ID to the internal test group, so that you receive the builds you publish. + + ```bash + shipthis game ios app addTester --self + ``` + 1. Create a Provisioning Profile Required to run on devices and for distribution. You can view profiles at Apple’s portal: https://developer.apple.com/account/resources/profiles/list diff --git a/docs/README.md b/docs/README.md index 52c5f3d5..93a5c03d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,15 +8,15 @@ Begin with our [Quickstart Guide](https://shipth.is/docs/guides/quick-start). ## Topics -- [apiKey](https://shipth.is/docs/reference/apiKey) - Commands that relate to ShipThis API keys +- [apiKey](https://shipth.is/docs/reference/apiKey) - Commands related to ShipThis API Keys - [apple](https://shipth.is/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account - [game](https://shipth.is/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory -- [util](https://shipth.is/docs/reference/util) - Utility commands that do not require login +- [util](https://shipth.is/docs/reference/util) - Utility commands that do not require authentication ## Commands - [autocomplete](https://shipth.is/docs/reference/autocomplete) - Set up shell tab-completion for commands, topics, and flags - [dashboard](https://shipth.is/docs/reference/dashboard) - Opens the web browser to your shipth.is dashboard -- [login](https://shipth.is/docs/reference/login) - Signin or create a new account +- [login](https://shipth.is/docs/reference/login) - Sign in or create a new account - [status](https://shipth.is/docs/reference/status) - Display your overall ShipThis account status - [help](https://shipth.is/docs/reference/help) - Display help for a specific topic or command diff --git a/docs/apiKey.md b/docs/apiKey.md index cc9420e7..fa38cbfb 100644 --- a/docs/apiKey.md +++ b/docs/apiKey.md @@ -26,7 +26,7 @@ Create a new API key for your ShipThis account. ```help USAGE - $ shipthis apiKey create [-n ] [-d ] [-q] + $ shipthis apiKey create [-d ] [-n ] [-q] FLAGS -d, --durationDays= [default: 365] duration of the API key in days diff --git a/docs/apiKey/create.md b/docs/apiKey/create.md index cd149417..1d0851a6 100644 --- a/docs/apiKey/create.md +++ b/docs/apiKey/create.md @@ -8,7 +8,7 @@ Create a new API key for your ShipThis account. ```help USAGE - $ shipthis apiKey create [-n ] [-d ] [-q] + $ shipthis apiKey create [-d ] [-n ] [-q] FLAGS -d, --durationDays= [default: 365] duration of the API key in days diff --git a/docs/apple.md b/docs/apple.md index f6bc88b2..45efe852 100644 --- a/docs/apple.md +++ b/docs/apple.md @@ -23,16 +23,17 @@ Your Apple credentials never leave your computer. ShipThis saves the cookies to ## API Keys -Manage App Store Connect API Keys in your Apple Developer account and their corresponding the private keys in your ShipThis account +Manage App Store Connect API Keys in your Apple Developer account and their corresponding private keys in your ShipThis account :::tip Info App Store Connect API Keys are used to upload your game to the App Store. The same API key can be used to upload multiple games. ::: -- [`shipthis apple apiKey create`](/docs/reference/apple/apiKey#shipthis-apple-apikey-create) -- [`shipthis apple apiKey export FILE`](/docs/reference/apple/apiKey#shipthis-apple-apikey-export-file) -- [`shipthis apple apiKey import FILE`](/docs/reference/apple/apiKey#shipthis-apple-apikey-import-file) -- [`shipthis apple apiKey status`](/docs/reference/apple/apiKey#shipthis-apple-apikey-status) +- [`shipthis apple apiKey create`](/docs/reference/apple/apiKey#apple-apikey-create) +- [`shipthis apple apiKey delete`](/docs/reference/apple/apiKey#apple-apikey-delete) +- [`shipthis apple apiKey export FILE`](/docs/reference/apple/apiKey#apple-apikey-export) +- [`shipthis apple apiKey import FILE`](/docs/reference/apple/apiKey#apple-apikey-import) +- [`shipthis apple apiKey status`](/docs/reference/apple/apiKey#apple-apikey-status) ## Certificates @@ -42,7 +43,9 @@ Manage iOS Distribution Certificates in your Apple Developer account and their c Your iOS Distribution Certificate is used to sign all of your games before upload to the App Store. The same certificate can be used to sign multiple games. ::: -- [`shipthis apple certificate create`](/docs/reference/apple/certificate#shipthis-apple-certificate-create) -- [`shipthis apple certificate export FILE`](/docs/reference/apple/certificate#shipthis-apple-certificate-export-file) -- [`shipthis apple certificate import FILE`](/docs/reference/apple/certificate#shipthis-apple-certificate-import-file) -- [`shipthis apple certificate status`](/docs/reference/apple/certificate#shipthis-apple-certificate-status) +- [`shipthis apple certificate create`](/docs/reference/apple/certificate#apple-certificate-create) +- [`shipthis apple certificate delete`](/docs/reference/apple/certificate#apple-certificate-delete) +- [`shipthis apple certificate export FILE`](/docs/reference/apple/certificate#apple-certificate-export) +- [`shipthis apple certificate import FILE`](/docs/reference/apple/certificate#apple-certificate-import) +- [`shipthis apple certificate show`](/docs/reference/apple/certificate#apple-certificate-show) +- [`shipthis apple certificate status`](/docs/reference/apple/certificate#apple-certificate-status) diff --git a/docs/apple/apiKey/create.md b/docs/apple/apiKey/create.md index 88ff5190..a5d27579 100644 --- a/docs/apple/apiKey/create.md +++ b/docs/apple/apiKey/create.md @@ -1,4 +1,4 @@ -# apple apiKey create +# Command: `apple apiKey create` ## Description diff --git a/docs/apple/apiKey/export.md b/docs/apple/apiKey/export.md index 56cf3536..442b812d 100644 --- a/docs/apple/apiKey/export.md +++ b/docs/apple/apiKey/export.md @@ -1,4 +1,4 @@ -# apple apiKey export +# Command: `apple apiKey export` ## Description diff --git a/docs/apple/apiKey/import.md b/docs/apple/apiKey/import.md index 30c720ad..c7221d9d 100644 --- a/docs/apple/apiKey/import.md +++ b/docs/apple/apiKey/import.md @@ -1,4 +1,4 @@ -# apple apiKey import +# Command: `apple apiKey import` ## Description diff --git a/docs/apple/apiKey/status.md b/docs/apple/apiKey/status.md index 46c0283d..bc1cbb6e 100644 --- a/docs/apple/apiKey/status.md +++ b/docs/apple/apiKey/status.md @@ -1,4 +1,4 @@ -# apple apiKey status +# Command: `apple apiKey status` ## Description diff --git a/docs/apple/certificate.md b/docs/apple/certificate.md index b5ba0d53..3fca590e 100644 --- a/docs/apple/certificate.md +++ b/docs/apple/certificate.md @@ -6,7 +6,7 @@ Commands in the apple certificate topic are prefixed `shipthis apple certificate These commands relate to iOS Distribution Certificates within your Apple Developer account. - You can view the Distribution Certificates in the [Apple Developer Portal](https://developer.apple.com/account/resources/certificates/list). -- You can more about Certificates in the [Apple Documentation](https://developer.apple.com/help/account/create-certificates/certificates-overview/). +- You can read more about Certificates in the [Apple Documentation](https://developer.apple.com/help/account/create-certificates/certificates-overview/). - You can view the Certificates which ShipThis uses in the [ShipThis Dashboard](https://shipth.is/credentials). :::info diff --git a/docs/apple/certificate/create.md b/docs/apple/certificate/create.md index 20afd10f..5a6345b2 100644 --- a/docs/apple/certificate/create.md +++ b/docs/apple/certificate/create.md @@ -1,4 +1,4 @@ -# apple certificate create +# Command: `apple certificate create` ## Description diff --git a/docs/apple/certificate/export.md b/docs/apple/certificate/export.md index 8c3fe596..b2e3aed7 100644 --- a/docs/apple/certificate/export.md +++ b/docs/apple/certificate/export.md @@ -1,4 +1,4 @@ -# apple certificate export +# Command: `apple certificate export` ## Description diff --git a/docs/apple/certificate/import.md b/docs/apple/certificate/import.md index fead7240..370d00d9 100644 --- a/docs/apple/certificate/import.md +++ b/docs/apple/certificate/import.md @@ -1,4 +1,4 @@ -# apple certificate import +# Command: `apple certificate import` ## Description diff --git a/docs/apple/certificate/status.md b/docs/apple/certificate/status.md index 326acf79..d928c8b1 100644 --- a/docs/apple/certificate/status.md +++ b/docs/apple/certificate/status.md @@ -1,4 +1,4 @@ -# apple certificate status +# Command: `apple certificate status` ## Description diff --git a/docs/apple/status.md b/docs/apple/status.md index 8cc79da2..34162809 100644 --- a/docs/apple/status.md +++ b/docs/apple/status.md @@ -19,7 +19,7 @@ USAGE $ shipthis apple status DESCRIPTION - Shows the status of the Apple authentication and integration + Shows the status of the Apple authentication and integration. EXAMPLES $ shipthis apple status diff --git a/docs/game.md b/docs/game.md index ef69f530..8d0c9f1a 100644 --- a/docs/game.md +++ b/docs/game.md @@ -13,6 +13,7 @@ You will need to be authenticated against ShipThis before you can use these comm ## Topics +- [game android](/docs/reference/game/android) - [game build](/docs/reference/game/build) - [game ios](/docs/reference/game/ios) - [game job](/docs/reference/game/job) diff --git a/docs/game/android/apiKey.md b/docs/game/android/apiKey.md index 0aabf79d..60beef0f 100644 --- a/docs/game/android/apiKey.md +++ b/docs/game/android/apiKey.md @@ -109,7 +109,7 @@ DESCRIPTION Saves the current Android Service Account API Key to a ZIP file EXAMPLES - $ shipthis game android apiKey export keyStore.zip + $ shipthis game android apiKey export apiKey.zip ``` ### `game android apiKey import` @@ -135,7 +135,7 @@ DESCRIPTION Imports an Android Service Account API Key to your ShipThis account for the specified game. EXAMPLES - $ shipthis game android apiKey import + $ shipthis game android apiKey import apiKey.zip ``` ### `game android apiKey invite` diff --git a/docs/game/android/apiKey/connect.md b/docs/game/android/apiKey/connect.md index ffaf8293..f8e9f00d 100644 --- a/docs/game/android/apiKey/connect.md +++ b/docs/game/android/apiKey/connect.md @@ -8,7 +8,7 @@ Connects ShipThis with Google for managing Service Account API Keys for an Andro ```help USAGE - $ shipthis game android apiKey connect [-g ] [-f] [-d] + $ shipthis game android apiKey connect [-g ] [-d] [-f] FLAGS -d, --disconnect diff --git a/docs/game/android/apiKey/create.md b/docs/game/android/apiKey/create.md index 5b88b54e..df296ee1 100644 --- a/docs/game/android/apiKey/create.md +++ b/docs/game/android/apiKey/create.md @@ -8,7 +8,7 @@ Creates a new Android Service Account API Key for a game ```help USAGE - $ shipthis game android apiKey create [-g ] [-w] [-f] + $ shipthis game android apiKey create [-g ] [-f] [-w] FLAGS -f, --force diff --git a/docs/game/android/apiKey/export.md b/docs/game/android/apiKey/export.md index 1b53b8ae..240df71f 100644 --- a/docs/game/android/apiKey/export.md +++ b/docs/game/android/apiKey/export.md @@ -8,7 +8,7 @@ Saves the current Android Service Account API Key to a ZIP file ```help USAGE - $ shipthis game android apiKey export FILE [-g ] [-f] + $ shipthis game android apiKey export FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to create @@ -21,5 +21,5 @@ DESCRIPTION Saves the current Android Service Account API Key to a ZIP file EXAMPLES - $ shipthis game android apiKey export keyStore.zip + $ shipthis game android apiKey export apiKey.zip ``` \ No newline at end of file diff --git a/docs/game/android/apiKey/import.md b/docs/game/android/apiKey/import.md index 60f4507b..1f04fc35 100644 --- a/docs/game/android/apiKey/import.md +++ b/docs/game/android/apiKey/import.md @@ -8,7 +8,7 @@ Imports an Android Service Account API Key to your ShipThis account for the spec ```help USAGE - $ shipthis game android apiKey import FILE [-g ] [-f] + $ shipthis game android apiKey import FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to import (must be in the same format as the export) @@ -21,5 +21,5 @@ DESCRIPTION Imports an Android Service Account API Key to your ShipThis account for the specified game. EXAMPLES - $ shipthis game android apiKey import + $ shipthis game android apiKey import apiKey.zip ``` \ No newline at end of file diff --git a/docs/game/android/keyStore.md b/docs/game/android/keyStore.md index dc287b7d..2d33d7f4 100644 --- a/docs/game/android/keyStore.md +++ b/docs/game/android/keyStore.md @@ -77,7 +77,7 @@ Saves the current Android Keystore to a ZIP file ```help USAGE - $ shipthis game android keyStore export FILE [-g ] [-f] + $ shipthis game android keyStore export FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to create @@ -103,11 +103,11 @@ Imports an Android Keystore to your ShipThis account for the specified game. You ```help USAGE - $ shipthis game android keyStore import [FILE] [-g ] [-f] [--jksFile ] [--keyPassword ] [--keystorePassword ] - + $ shipthis game android keyStore import [FILE] [-g ] [-f] [--jksFile ] [--keyPassword ] [--keystorePassword + ] ARGUMENTS - FILE Path to the ZIP file to import (must be in the same format as the export) + [FILE] Path to the ZIP file to import (must be in the same format as the export) FLAGS -f, --force Overwrite any existing keystore without confirmation @@ -117,7 +117,8 @@ FLAGS --keystorePassword= Keystore password (required when using --jksFile) DESCRIPTION - Imports an Android Keystore to your ShipThis account for the specified game. + Imports an Android Keystore to your ShipThis account for the specified game. You can import as JKS and password + parameters or as a ZIP file. EXAMPLES $ shipthis game android keyStore import path/to/import.zip -g abfd5b00 diff --git a/docs/game/android/keyStore/export.md b/docs/game/android/keyStore/export.md index 937100cd..cd631ffb 100644 --- a/docs/game/android/keyStore/export.md +++ b/docs/game/android/keyStore/export.md @@ -8,7 +8,7 @@ Saves the current Android Keystore to a ZIP file ```help USAGE - $ shipthis game android keyStore export FILE [-g ] [-f] + $ shipthis game android keyStore export FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to create diff --git a/docs/game/android/keyStore/import.md b/docs/game/android/keyStore/import.md index 75ba1060..0bf99ea2 100644 --- a/docs/game/android/keyStore/import.md +++ b/docs/game/android/keyStore/import.md @@ -2,17 +2,17 @@ ## Description -Imports an Android Keystore to your ShipThis account for the specified game. +Imports an Android Keystore to your ShipThis account for the specified game. You can import as JKS and password parameters or as a ZIP file. ## Help Output ```help USAGE - $ shipthis game android keyStore import [FILE] [-g ] [--jksFile ] [--keystorePassword ] [--keyPassword - ] [-f] + $ shipthis game android keyStore import [FILE] [-g ] [-f] [--jksFile ] [--keyPassword ] [--keystorePassword + ] ARGUMENTS - FILE Path to the ZIP file to import (must be in the same format as the export) + [FILE] Path to the ZIP file to import (must be in the same format as the export) FLAGS -f, --force Overwrite any existing keystore without confirmation @@ -22,7 +22,8 @@ FLAGS --keystorePassword= Keystore password (required when using --jksFile) DESCRIPTION - Imports an Android Keystore to your ShipThis account for the specified game. + Imports an Android Keystore to your ShipThis account for the specified game. You can import as JKS and password + parameters or as a ZIP file. EXAMPLES $ shipthis game android keyStore import path/to/import.zip -g abfd5b00 diff --git a/docs/game/build.md b/docs/game/build.md index f7a165d1..961d4806 100644 --- a/docs/game/build.md +++ b/docs/game/build.md @@ -57,7 +57,7 @@ Lists the builds for successful jobs of a game. ```help USAGE - $ shipthis game build list [-g ] [-p ] [-s ] [-o createdAt|updatedAt] [-r asc|desc] + $ shipthis game build list [-g ] [-r asc|desc] [-o createdAt|updatedAt] [-p ] [-s ] FLAGS -g, --gameId= The ID of the game diff --git a/docs/game/build/download.md b/docs/game/build/download.md index c27711a0..37e60f0e 100644 --- a/docs/game/build/download.md +++ b/docs/game/build/download.md @@ -1,4 +1,4 @@ -# game build download +# Command: `game build download` ## Description diff --git a/docs/game/build/list.md b/docs/game/build/list.md index fe191f26..99d5c9fe 100644 --- a/docs/game/build/list.md +++ b/docs/game/build/list.md @@ -1,4 +1,4 @@ -# game build list +# Command: `game build list` ## Description @@ -8,7 +8,7 @@ Lists the builds for successful jobs of a game. ```help USAGE - $ shipthis game build list [-g ] [-p ] [-s ] [-o createdAt|updatedAt] [-r asc|desc] + $ shipthis game build list [-g ] [-r asc|desc] [-o createdAt|updatedAt] [-p ] [-s ] FLAGS -g, --gameId= The ID of the game diff --git a/docs/game/details.md b/docs/game/details.md index eaf552f7..1193776c 100644 --- a/docs/game/details.md +++ b/docs/game/details.md @@ -2,7 +2,7 @@ ## Description -Shows and sets the details of the current game. These details are used by when your game is built on our cloud servers. +Shows and sets the details of the current game. These details are used when your game is built on our cloud servers. If you run the command without any flags it will show the details of the current game. @@ -15,7 +15,7 @@ The following fields can only be changed if you have the `--force` flag set: - **gameEngine** - Change the Game Engine (currently only "godot" is supported) - **gameEngineVersion** - Change the version of the Game Engine (all stable Godot versions since 3.6 are supported, up to 4.7) - **iosBundleId** - iOS Bundle ID -- **androidPackageName** Android Package Name (not currently used) +- **androidPackageName** - Android Package Name (used to sign and publish your Android builds) :::tip After changing these values, you will need to trigger a new build of your game with [`shipthis game ship`](/docs/reference/game/ship) diff --git a/docs/game/ios.md b/docs/game/ios.md index 3ff386ca..e01db3f4 100644 --- a/docs/game/ios.md +++ b/docs/game/ios.md @@ -2,7 +2,7 @@ Commands in the `game ios` topic are prefixed `shipthis game ios`. They relate to managing the iOS platform configuration for a specific game (generally in the -currently directory). +current directory). :::tip Info You will need to be authenticated against ShipThis and Apple before you can use diff --git a/docs/game/ios/app.md b/docs/game/ios/app.md index 173ad388..4bf420c1 100644 --- a/docs/game/ios/app.md +++ b/docs/game/ios/app.md @@ -1,6 +1,6 @@ # Topic: `game ios app` -Commands in the `game ios app` topic are prefixed `shipthis game ios app`. They relate to the App Store App and BundleId for a specific game (generally in the currently directory). +Commands in the `game ios app` topic are prefixed `shipthis game ios app`. They relate to the App Store App and BundleId for a specific game (generally in the current directory). :::info An **App Store App** is the public-facing application available in the App Store. It includes metadata like descriptions, screenshots, and submission details, representing the final product users download. @@ -158,7 +158,7 @@ FLAGS -q, --quiet Avoid output except for interactions and errors DESCRIPTION - Synchronies the Apple App "BundleId" with the capabilities from the local project. + Synchronizes the Apple App "BundleId" with the capabilities from the local project. EXAMPLES $ shipthis game ios app sync diff --git a/docs/game/ios/app/addTester.md b/docs/game/ios/app/addTester.md index 2e4c84b0..d1f74c86 100644 --- a/docs/game/ios/app/addTester.md +++ b/docs/game/ios/app/addTester.md @@ -1,4 +1,4 @@ -# game ios app addTester +# Command: `game ios app addTester` ## Description diff --git a/docs/game/ios/app/create.md b/docs/game/ios/app/create.md index 2ef926c1..5ea06592 100644 --- a/docs/game/ios/app/create.md +++ b/docs/game/ios/app/create.md @@ -1,4 +1,4 @@ -# game ios app create +# Command: `game ios app create` ## Description @@ -8,7 +8,7 @@ Creates an App and BundleId in the Apple Developer Portal. ```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 diff --git a/docs/game/ios/app/status.md b/docs/game/ios/app/status.md index 36f76f15..b61ea27c 100644 --- a/docs/game/ios/app/status.md +++ b/docs/game/ios/app/status.md @@ -1,4 +1,4 @@ -# game ios app status +# Command: `game ios app status` ## Description diff --git a/docs/game/ios/app/sync.md b/docs/game/ios/app/sync.md index b772016f..9b7a0ea1 100644 --- a/docs/game/ios/app/sync.md +++ b/docs/game/ios/app/sync.md @@ -1,14 +1,14 @@ -# game ios app sync +# Command: `game ios app sync` ## Description -Synchronies the Apple App "BundleId" with the capabilities from the local project. +Synchronizes the Apple App "BundleId" with the capabilities from the local project. ## Help Output ```help USAGE - $ shipthis game ios app sync [-q] [-g ] [-f] + $ shipthis game ios app sync [-f] [-g ] [-q] FLAGS -f, --force @@ -16,7 +16,7 @@ FLAGS -q, --quiet Avoid output except for interactions and errors DESCRIPTION - Synchronies the Apple App "BundleId" with the capabilities from the local project. + Synchronizes the Apple App "BundleId" with the capabilities from the local project. EXAMPLES $ shipthis game ios app sync diff --git a/docs/game/ios/profile.md b/docs/game/ios/profile.md index 3d8c952f..59ebcfca 100644 --- a/docs/game/ios/profile.md +++ b/docs/game/ios/profile.md @@ -1,6 +1,6 @@ # Topic: `game ios profile` -Commands in the `game ios profile` topic are prefixed `shipthis game ios profile`. They relate to the App Store Mobile Provisioning Profiles for a specific game (generally in the currently directory). +Commands in the `game ios profile` topic are prefixed `shipthis game ios profile`. They relate to the App Store Mobile Provisioning Profiles for a specific game (generally in the current directory). :::info A **Provisioning Profile** authorizes your app to run on devices and access Apple services. It is a digitally signed XML file issued by Apple that combines your App ID, developer certificate, entitlements, and device identifiers. It’s essential for development and distribution. @@ -42,7 +42,7 @@ Provisioning profile. To do that please run: ```help USAGE - $ shipthis game ios profile create [-q] [-g ] [-f] + $ shipthis game ios profile create [-f] [-g ] [-q] FLAGS -f, --force @@ -93,7 +93,7 @@ Saves the current Mobile Provisioning Profile to a ZIP file ```help USAGE - $ shipthis game ios profile export FILE [-g ] [-f] + $ shipthis game ios profile export FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to create @@ -113,13 +113,13 @@ EXAMPLES #### Description -Imports an Mobile Provisioning Profile to your ShipThis account +Imports a Mobile Provisioning Profile to your ShipThis account #### Help Output ```help USAGE - $ shipthis game ios profile import FILE [-g ] [-f] + $ shipthis game ios profile import FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to import (must be in the same format as the export) @@ -129,7 +129,7 @@ FLAGS -g, --gameId= The ID of the game DESCRIPTION - Imports an Mobile Provisioning Profile to your ShipThis account + Imports a Mobile Provisioning Profile to your ShipThis account EXAMPLES $ shipthis game ios profile import profile.zip diff --git a/docs/game/ios/profile/create.md b/docs/game/ios/profile/create.md index a4d45d09..586298e5 100644 --- a/docs/game/ios/profile/create.md +++ b/docs/game/ios/profile/create.md @@ -1,4 +1,4 @@ -# game ios profile create +# Command: `game ios profile create` ## Description @@ -8,7 +8,7 @@ Creates a Mobile Provisioning Profile in the Apple Developer Portal. ```help USAGE - $ shipthis game ios profile create [-q] [-g ] [-f] + $ shipthis game ios profile create [-f] [-g ] [-q] FLAGS -f, --force diff --git a/docs/game/ios/profile/export.md b/docs/game/ios/profile/export.md index 2713ee59..78a18b15 100644 --- a/docs/game/ios/profile/export.md +++ b/docs/game/ios/profile/export.md @@ -1,4 +1,4 @@ -# game ios profile export +# Command: `game ios profile export` ## Description @@ -8,7 +8,7 @@ Saves the current Mobile Provisioning Profile to a ZIP file ```help USAGE - $ shipthis game ios profile export FILE [-g ] [-f] + $ shipthis game ios profile export FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to create diff --git a/docs/game/ios/profile/import.md b/docs/game/ios/profile/import.md index 23bdfae0..6c2e18fb 100644 --- a/docs/game/ios/profile/import.md +++ b/docs/game/ios/profile/import.md @@ -1,14 +1,14 @@ -# game ios profile import +# Command: `game ios profile import` ## Description -Imports an Mobile Provisioning Profile to your ShipThis account +Imports a Mobile Provisioning Profile to your ShipThis account ## Help Output ```help USAGE - $ shipthis game ios profile import FILE [-g ] [-f] + $ shipthis game ios profile import FILE [-f] [-g ] ARGUMENTS FILE Name of the ZIP file to import (must be in the same format as the export) @@ -18,7 +18,7 @@ FLAGS -g, --gameId= The ID of the game DESCRIPTION - Imports an Mobile Provisioning Profile to your ShipThis account + Imports a Mobile Provisioning Profile to your ShipThis account EXAMPLES $ shipthis game ios profile import profile.zip diff --git a/docs/game/ios/profile/status.md b/docs/game/ios/profile/status.md index 54b73583..b6e8e756 100644 --- a/docs/game/ios/profile/status.md +++ b/docs/game/ios/profile/status.md @@ -1,4 +1,4 @@ -# game ios profile status +# Command: `game ios profile status` ## Description diff --git a/docs/game/job.md b/docs/game/job.md index f2939e9d..984d0edc 100644 --- a/docs/game/job.md +++ b/docs/game/job.md @@ -1,6 +1,6 @@ # Topic: `game job` -Commands in the `game job` topic are prefixed `shipthis game job`. They relate to jobs for a specific game (generally in the currently directory). +Commands in the `game job` topic are prefixed `shipthis game job`. They relate to jobs for a specific game (generally in the current directory). :::info A **job** is a set of work done to create a new build of your game. You can create a new job by running the command: @@ -28,7 +28,7 @@ Lists the jobs for a game. ```help USAGE - $ shipthis game job list [-g ] [-p ] [-s ] [-o createdAt|updatedAt] [-r asc|desc] + $ shipthis game job list [-g ] [-r asc|desc] [-o createdAt|updatedAt] [-p ] [-s ] FLAGS -g, --gameId= The ID of the game @@ -89,7 +89,7 @@ Shows the real-time status of a job. ```help USAGE - $ shipthis game job status JOB_ID [-g ] [-n ] [-f] + $ shipthis game job status JOB_ID [-g ] [-f] [-n ] ARGUMENTS JOB_ID The id of the job to get the status of diff --git a/docs/game/job/list.md b/docs/game/job/list.md index 669bdcc1..4fbca492 100644 --- a/docs/game/job/list.md +++ b/docs/game/job/list.md @@ -1,4 +1,4 @@ -# game job list +# Command: `game job list` ## Description @@ -8,7 +8,7 @@ Lists the jobs for a game. ```help USAGE - $ shipthis game job list [-g ] [-p ] [-s ] [-o createdAt|updatedAt] [-r asc|desc] + $ shipthis game job list [-g ] [-r asc|desc] [-o createdAt|updatedAt] [-p ] [-s ] FLAGS -g, --gameId= The ID of the game diff --git a/docs/game/job/status.md b/docs/game/job/status.md index f6d0371c..3b8eb597 100644 --- a/docs/game/job/status.md +++ b/docs/game/job/status.md @@ -1,4 +1,4 @@ -# game job status +# Command: `game job status` ## Description @@ -8,7 +8,7 @@ Shows the real-time status of a job. ```help USAGE - $ shipthis game job status JOB_ID [-g ] [-n ] [-f] + $ shipthis game job status JOB_ID [-g ] [-f] [-n ] ARGUMENTS JOB_ID The id of the job to get the status of diff --git a/docs/game/list.md b/docs/game/list.md index 19558e0c..ee97083a 100644 --- a/docs/game/list.md +++ b/docs/game/list.md @@ -12,7 +12,7 @@ Shows a list of all your games. ```help USAGE - $ shipthis game list [-p ] [-s ] [-o createdAt|updatedAt|name] [-r asc|desc] + $ shipthis game list [-r asc|desc] [-o createdAt|updatedAt|name] [-p ] [-s ] FLAGS -o, --orderBy=