Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/apiKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Create a new API key for your ShipThis account.

```help
USAGE
$ shipthis apiKey create [-n <value>] [-d <value>] [-q]
$ shipthis apiKey create [-d <value>] [-n <value>] [-q]

FLAGS
-d, --durationDays=<value> [default: 365] duration of the API key in days
Expand Down
2 changes: 1 addition & 1 deletion docs/apiKey/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Create a new API key for your ShipThis account.

```help
USAGE
$ shipthis apiKey create [-n <value>] [-d <value>] [-q]
$ shipthis apiKey create [-d <value>] [-n <value>] [-q]

FLAGS
-d, --durationDays=<value> [default: 365] duration of the API key in days
Expand Down
21 changes: 12 additions & 9 deletions docs/apple.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
2 changes: 1 addition & 1 deletion docs/apple/apiKey/create.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple apiKey create
# Command: `apple apiKey create`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/apiKey/export.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple apiKey export
# Command: `apple apiKey export`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/apiKey/import.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple apiKey import
# Command: `apple apiKey import`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/apiKey/status.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple apiKey status
# Command: `apple apiKey status`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/apple/certificate/create.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple certificate create
# Command: `apple certificate create`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/certificate/export.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple certificate export
# Command: `apple certificate export`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/certificate/import.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple certificate import
# Command: `apple certificate import`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/certificate/status.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# apple certificate status
# Command: `apple certificate status`

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/apple/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/game.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions docs/game/android/apiKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion docs/game/android/apiKey/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <value>] [-f] [-d]
$ shipthis game android apiKey connect [-g <value>] [-d] [-f]

FLAGS
-d, --disconnect
Expand Down
2 changes: 1 addition & 1 deletion docs/game/android/apiKey/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Creates a new Android Service Account API Key for a game

```help
USAGE
$ shipthis game android apiKey create [-g <value>] [-w] [-f]
$ shipthis game android apiKey create [-g <value>] [-f] [-w]

FLAGS
-f, --force
Expand Down
4 changes: 2 additions & 2 deletions docs/game/android/apiKey/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <value>] [-f]
$ shipthis game android apiKey export FILE [-f] [-g <value>]

ARGUMENTS
FILE Name of the ZIP file to create
Expand All @@ -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
```
4 changes: 2 additions & 2 deletions docs/game/android/apiKey/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <value>] [-f]
$ shipthis game android apiKey import FILE [-f] [-g <value>]

ARGUMENTS
FILE Name of the ZIP file to import (must be in the same format as the export)
Expand All @@ -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
```
11 changes: 6 additions & 5 deletions docs/game/android/keyStore.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Saves the current Android Keystore to a ZIP file

```help
USAGE
$ shipthis game android keyStore export FILE [-g <value>] [-f]
$ shipthis game android keyStore export FILE [-f] [-g <value>]

ARGUMENTS
FILE Name of the ZIP file to create
Expand All @@ -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 <value>] [-f] [--jksFile <value>] [--keyPassword <value>] [--keystorePassword <value>]

$ shipthis game android keyStore import [FILE] [-g <value>] [-f] [--jksFile <value>] [--keyPassword <value>] [--keystorePassword
<value>]

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
Expand All @@ -117,7 +117,8 @@ FLAGS
--keystorePassword=<value> 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
Expand Down
2 changes: 1 addition & 1 deletion docs/game/android/keyStore/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Saves the current Android Keystore to a ZIP file

```help
USAGE
$ shipthis game android keyStore export FILE [-g <value>] [-f]
$ shipthis game android keyStore export FILE [-f] [-g <value>]

ARGUMENTS
FILE Name of the ZIP file to create
Expand Down
11 changes: 6 additions & 5 deletions docs/game/android/keyStore/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <value>] [--jksFile <value>] [--keystorePassword <value>] [--keyPassword
<value>] [-f]
$ shipthis game android keyStore import [FILE] [-g <value>] [-f] [--jksFile <value>] [--keyPassword <value>] [--keystorePassword
<value>]

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
Expand All @@ -22,7 +22,8 @@ FLAGS
--keystorePassword=<value> 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
Expand Down
2 changes: 1 addition & 1 deletion docs/game/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Lists the builds for successful jobs of a game.

```help
USAGE
$ shipthis game build list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
$ shipthis game build list [-g <value>] [-r asc|desc] [-o createdAt|updatedAt] [-p <value>] [-s <value>]

FLAGS
-g, --gameId=<value> The ID of the game
Expand Down
2 changes: 1 addition & 1 deletion docs/game/build/download.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# game build download
# Command: `game build download`

## Description

Expand Down
4 changes: 2 additions & 2 deletions docs/game/build/list.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# game build list
# Command: `game build list`

## Description

Expand All @@ -8,7 +8,7 @@ Lists the builds for successful jobs of a game.

```help
USAGE
$ shipthis game build list [-g <value>] [-p <value>] [-s <value>] [-o createdAt|updatedAt] [-r asc|desc]
$ shipthis game build list [-g <value>] [-r asc|desc] [-o createdAt|updatedAt] [-p <value>] [-s <value>]

FLAGS
-g, --gameId=<value> The ID of the game
Expand Down
4 changes: 2 additions & 2 deletions docs/game/details.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/game/ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/game/ios/app.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/game/ios/app/addTester.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# game ios app addTester
# Command: `game ios app addTester`

## Description

Expand Down
Loading