shipthis 0.1.18 → 0.1.19

package/README.md

@@ -11,13 +11,12 @@
   </a>
 </h1>
 <p align="center">
-  <em><b>ShipThis</b> is a <b>command line tool</b> which manages building and uploading your <a href="https://godotengine.org/">Godot</a> mobile games to the <b>Apple App Store</b> and <b>Google Play</b>.</em>
+  <b>ShipThis</b> is a <b>command line tool</b> for building and uploading your <a href="https://godotengine.org/">Godot</a> mobile games to the <b>Apple App Store</b> and <b>Google Play</b>.
 </p>
 <p align="center">
-  <em><b>ShipThis compiles and uploads your Godot games in the cloud, meaning</b> you do not need to install or run Xcode or Android Studio to ship a Godot iOS/Android game.</em>
+  ShipThis compiles your game on managed cloud servers – no local build tools needed. It can be integrated with existing CI or run ad-hoc when you have a new version of your game ready.
 </p>
 
-
 <p align="center">
   <picture>
     <img height="266" width="504" alt="ShipThis Home" src="docs/assets/ship-outputx0.8.gif">
@@ -26,14 +25,25 @@
 
 ---
 
+## ❓ Why use ShipThis?
+
+- **✅ Always a free tier** – Enough usage for most solo devs.
+- **✨ One-command setup** – Our interactive [`wizard`](https://shipthis.cc/docs/reference/game/wizard) guides you through configuration.
+- **⏱ Skip the build tools** – No Xcode, Android Studio, or SDK installation required.
+- **🔐 Simplify provisioning** – We handle iOS certificates, Android keystores, app signing, and API keys.
+- **🚀 One-command deployment** – Publish to TestFlight or Google Play with a single CLI command.
+
+> [!IMPORTANT]
+> ShipThis is in public beta. While in beta, it is completely free to use. Early users will receive discounts or free access to premium features after launch.
+
 ## ⚡️ Quick start
 
 ### What you'll need
 
 - A Godot 3.6 or 4.X game
 - [Node.js](https://nodejs.org/en/download/) version 18.0 or above
-- **If you are building an iOS game** - an [Apple Developer account](https://developer.apple.com)
-- **If you are building an Android game** - a [Play Console developer account](https://play.google.com/apps/publish/signup)
+- **If you are building an iOS game** – an [Apple Developer account](https://developer.apple.com)
+- **If you are building an Android game** – a [Play Console developer account](https://play.google.com/apps/publish/signup)
 
 ### 1. Install ShipThis
 
@@ -45,6 +55,8 @@ npm install -g shipthis
 
 ### 2. Create an account
 
+> 🛠 All builds run on managed cloud servers – no need to install Xcode or Android Studio locally.
+
 Set up an account with ShipThis by logging in for the first time using the [`shipthis login`](https://shipthis.cc/docs/reference/login) command.
 
 ```bash
@@ -53,7 +65,7 @@ shipthis login
 
 ### 3. Set up your game
 
-Next, run the [wizard command](https://shipthis.cc/docs/reference/game/wizard) to configure your game on ShipThis. The command takes a platform parameter - this can be either **android** or **ios**. Run this command from within a Godot game directory (with a **project.godot** file):
+Next, run the [wizard command](https://shipthis.cc/docs/reference/game/wizard) to configure your game on ShipThis. The command takes a platform parameter – this can be either **android** or **ios**. Run this command from within a Godot game directory (with a **project.godot** file):
 
 ### Set up an Android game
 
@@ -61,6 +73,21 @@ Next, run the [wizard command](https://shipthis.cc/docs/reference/game/wizard) t
 shipthis game wizard android
 ```
 
+<details>
+<summary>Using the wizard for a published Google Play game</summary>
+
+### Published game
+
+If you have already published your game to Google Play then you will be able to skip manually creating the game in the Play Console and uploading the initial build. Once you have connected your Google Account, the wizard will be able to determine if the game exists in Google Play. Below is a recording of the wizard being run to configure a game called **ShipThis Godot Demo Game** which was previously published manually in the Play Console.
+
+<p align="center">
+  <picture>
+    <img height="862" width="1344" alt="ShipThis Home" src="docs/assets/wizard-android-existing.gif">
+  </picture>
+</p>
+
+</details>
+
 ### Set up an iOS game
 
 ```bash
@@ -69,22 +96,31 @@ shipthis game wizard ios
 
 ### 4. Ship
 
-Now you can publish new versions your game to TestFlight or Google Play with the [`shipthis game ship`](https://shipthis.cc/docs/reference/game/ship) command:
+Now you can publish new versions of your game to TestFlight or Google Play with the [`shipthis game ship`](https://shipthis.cc/docs/reference/game/ship) command:
 
 ```bash
 shipthis game ship
 ```
 
+- 💡 Having issues? Check the [Troubleshooting](https://shipthis.cc/docs/troubleshooting) or [join our Discord](https://discord.gg/gPjn3S99k4)
+- 📚 For detailed documentation, visit [shipthis.cc/docs](https://shipthis.cc/docs)
+
 ## 📖 Command Reference
 
-### Topics
+### 🗂 Topics
+
+- [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
 
-- [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.
+- [dashboard](https://shipthis.cc/docs/reference/dashboard) – Opens the web browser to your shipthis.cc dashboard
+- [login](https://shipthis.cc/docs/reference/login) – Sign in 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
 
-### Commands
+## 🌍 Community
 
-- [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
+- 💬 [Join us on Discord](https://discord.gg/gPjn3S99k4)
+- 🐛 [Report an issue](https://github.com/shipth-is/cli/issues)
+- 📣 Feature ideas? Feedback? We’d love to hear from you – email support@shipthis.cc

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "shipthis",
-  "version": "0.1.18",
+  "version": "0.1.19",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "shipthis",
-      "version": "0.1.18",
+      "version": "0.1.19",
       "license": "MIT",
       "dependencies": {
         "@expo/apple-utils": "2.0.3",

package/oclif.manifest.json

@@ -695,10 +695,10 @@
         "readme.js"
       ]
     },
-    "apple:apiKey:create": {
+    "apple:certificate:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
+      "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -720,7 +720,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:create",
+      "id": "apple:certificate:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -730,11 +730,11 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "create.js"
       ]
     },
-    "apple:apiKey:export": {
+    "apple:certificate:export": {
       "aliases": [],
       "args": {
         "file": {
@@ -743,9 +743,9 @@
           "required": true
         }
       },
-      "description": "Saves the current App Store Connect API Key to a ZIP file",
+      "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+        "<%= config.bin %> <%= command.id %> userCert.zip"
       ],
       "flags": {
         "force": {
@@ -758,7 +758,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:export",
+      "id": "apple:certificate:export",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -769,11 +769,11 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "export.js"
       ]
     },
-    "apple:apiKey:import": {
+    "apple:certificate:import": {
       "aliases": [],
       "args": {
         "file": {
@@ -782,9 +782,9 @@
           "required": true
         }
       },
-      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
+      "description": "Imports an iOS Distribution Certificate to your ShipThis account",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+        "<%= config.bin %> <%= command.id %> userCert.zip"
       ],
       "flags": {
         "force": {
@@ -796,7 +796,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:import",
+      "id": "apple:certificate:import",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -807,14 +807,14 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "import.js"
       ]
     },
-    "apple:apiKey:status": {
+    "apple:certificate:status": {
       "aliases": [],
       "args": {},
-      "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
+      "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -829,7 +829,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:apiKey:status",
+      "id": "apple:certificate:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -840,14 +840,14 @@
         "dist",
         "commands",
         "apple",
-        "apiKey",
+        "certificate",
         "status.js"
       ]
     },
-    "apple:certificate:create": {
+    "apple:apiKey:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
+      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -869,7 +869,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:create",
+      "id": "apple:apiKey:create",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -879,11 +879,11 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "create.js"
       ]
     },
-    "apple:certificate:export": {
+    "apple:apiKey:export": {
       "aliases": [],
       "args": {
         "file": {
@@ -892,9 +892,9 @@
           "required": true
         }
       },
-      "description": "Saves the current Apple Distribution Certificate to a ZIP file.",
+      "description": "Saves the current App Store Connect API Key to a ZIP file",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userCert.zip"
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
       ],
       "flags": {
         "force": {
@@ -907,7 +907,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:export",
+      "id": "apple:apiKey:export",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -918,11 +918,11 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "export.js"
       ]
     },
-    "apple:certificate:import": {
+    "apple:apiKey:import": {
       "aliases": [],
       "args": {
         "file": {
@@ -931,9 +931,9 @@
           "required": true
         }
       },
-      "description": "Imports an iOS Distribution Certificate to your ShipThis account",
+      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
       "examples": [
-        "<%= config.bin %> <%= command.id %> userCert.zip"
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
       ],
       "flags": {
         "force": {
@@ -945,7 +945,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:import",
+      "id": "apple:apiKey:import",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -956,14 +956,14 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "import.js"
       ]
     },
-    "apple:certificate:status": {
+    "apple:apiKey:status": {
       "aliases": [],
       "args": {},
-      "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.",
+      "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -978,7 +978,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "apple:certificate:status",
+      "id": "apple:apiKey:status",
       "pluginAlias": "shipthis",
       "pluginName": "shipthis",
       "pluginType": "core",
@@ -989,7 +989,7 @@
         "dist",
         "commands",
         "apple",
-        "certificate",
+        "apiKey",
         "status.js"
       ]
     },
@@ -2238,5 +2238,5 @@
       ]
     }
   },
-  "version": "0.1.18"
+  "version": "0.1.19"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "ShipThis manages building and uploading your Godot games to the App Store and Google Play.",
-  "version": "0.1.18",
+  "version": "0.1.19",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"