shipthis 0.0.9 → 0.0.21

package/docs/game/ios.md

@@ -0,0 +1,247 @@
+# game ios
+
+Commands related to the iOS platform for a specific game
+
+## Topics
+
+
+# game ios app
+
+Commands related to the App Store App for a specific game
+
+
+## Commands
+
+
+### 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
+```
+
+### 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
+```
+
+### 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
+```
+
+### game ios app sync
+
+#### Description
+
+Synchronies the Apple App &#34;BundleId&#34; with the capabilities from the local project.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios app sync [-q] [-g <value>] [-f]
+
+FLAGS
+  -f, --force
+  -g, --gameId=<value>  The ID of the game
+  -q, --quiet           Avoid output except for interactions and errors
+
+DESCRIPTION
+  Synchronies the Apple App "BundleId" with the capabilities from the local project.
+
+EXAMPLES
+  $ shipthis game ios app sync
+```
+
+
+# game ios profile
+
+Commands related to the App Store Provisioning Profiles for this Game
+
+
+## Commands
+
+
+### game ios profile create
+
+#### Description
+
+Creates a Mobile Provisioning Profile in the Apple Developer Portal.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios profile create [-q] [-g <value>] [-f]
+
+FLAGS
+  -f, --force
+  -g, --gameId=<value>  The ID of the game
+  -q, --quiet           Avoid output except for interactions and errors
+
+DESCRIPTION
+  Creates a Mobile Provisioning Profile in the Apple Developer Portal.
+
+EXAMPLES
+  $ shipthis game ios profile create
+```
+
+### game ios profile export
+
+#### Description
+
+Saves the current Mobile Provisioning Profile to a ZIP file
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios profile export FILE [-g <value>] [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to create
+
+FLAGS
+  -f, --force           Overwrite the file if it already exists
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Saves the current Mobile Provisioning Profile to a ZIP file
+
+EXAMPLES
+  $ shipthis game ios profile export userProfile.zip
+```
+
+### game ios profile import
+
+#### Description
+
+Imports an Mobile Provisioning Profile to your ShipThis account
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios profile import FILE [-g <value>] [-f]
+
+ARGUMENTS
+  FILE  Name of the ZIP file to import (must be in the same format as the export)
+
+FLAGS
+  -f, --force
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Imports an Mobile Provisioning Profile to your ShipThis account
+
+EXAMPLES
+  $ shipthis game ios profile import profile.zip
+```
+
+### game ios profile status
+
+#### Description
+
+Shows the Game iOS Mobile Provisioning Profile Status.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios profile status [-g <value>] [-f]
+
+FLAGS
+  -f, --noAppleAuth
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Shows the Game iOS Mobile Provisioning Profile Status.
+
+EXAMPLES
+  $ shipthis game ios profile status
+```
+
+
+## Commands
+
+
+### game ios status
+
+#### Description
+
+Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game ios status [-g <value>]
+
+FLAGS
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Shows the Game iOS Platform status. If --gameId is not provided it will look in the current directory.
+
+EXAMPLES
+  $ shipthis game ios status
+
+  $ shipthis game ios status --gameId 0c179fc4
+```

package/docs/game/job/list.md

@@ -0,0 +1,29 @@
+# game job list
+
+## Description
+
+Lists the jobs for a game.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game job 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 jobs for a game.
+
+EXAMPLES
+  $ shipthis game job list
+
+  $ shipthis game job list --gameId 0c179fc4
+```

package/docs/game/job/status.md

@@ -0,0 +1,30 @@
+# game job status
+
+## Description
+
+Shows the real-time status of a job.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game job status JOB_ID [-g <value>] [-n <value>] [-f]
+
+ARGUMENTS
+  JOB_ID  The id of the job to get the status of
+
+FLAGS
+  -f, --follow          Follow the log in real-time
+  -g, --gameId=<value>  The ID of the game
+  -n, --lines=<value>   [default: 10] The number of lines to show
+
+DESCRIPTION
+  Shows the real-time status of a job.
+
+EXAMPLES
+  $ shipthis game job status 4d32239e
+
+  $ shipthis game job status --gameId 0c179fc4 4d32239e
+
+  $ shipthis game job status --gameId 0c179fc4 --lines 20 --follow 4d32239e
+```

package/docs/game/job.md

@@ -0,0 +1,68 @@
+# game job
+
+Commands related to jobs for a specific game
+
+
+## Commands
+
+
+### game job list
+
+#### Description
+
+Lists the jobs for a game.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game job 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 jobs for a game.
+
+EXAMPLES
+  $ shipthis game job list
+
+  $ shipthis game job list --gameId 0c179fc4
+```
+
+### game job status
+
+#### Description
+
+Shows the real-time status of a job.
+
+#### Help Output
+
+```
+USAGE
+  $ shipthis game job status JOB_ID [-g <value>] [-n <value>] [-f]
+
+ARGUMENTS
+  JOB_ID  The id of the job to get the status of
+
+FLAGS
+  -f, --follow          Follow the log in real-time
+  -g, --gameId=<value>  The ID of the game
+  -n, --lines=<value>   [default: 10] The number of lines to show
+
+DESCRIPTION
+  Shows the real-time status of a job.
+
+EXAMPLES
+  $ shipthis game job status 4d32239e
+
+  $ shipthis game job status --gameId 0c179fc4 4d32239e
+
+  $ shipthis game job status --gameId 0c179fc4 --lines 20 --follow 4d32239e
+```

package/docs/game/list.md

@@ -0,0 +1,26 @@
+# game list
+
+## Description
+
+Shows a list of all your games.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game list [-p <value>] [-s <value>] [-o createdAt|updatedAt|name] [-r asc|desc]
+
+FLAGS
+  -o, --orderBy=<option>    [default: createdAt] The field to order by
+                            <options: createdAt|updatedAt|name>
+  -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
+  Shows a list of all your games.
+
+EXAMPLES
+  $ shipthis game list
+```

package/docs/game/ship.md

@@ -0,0 +1,21 @@
+# game ship
+
+## Description
+
+Builds the app (for all platforms with valid credentials) and ships it to the stores.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game ship [-g <value>]
+
+FLAGS
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Builds the app (for all platforms with valid credentials) and ships it to the stores.
+
+EXAMPLES
+  $ shipthis game ship
+```

package/docs/game/status.md

@@ -0,0 +1,23 @@
+# game status
+
+## Description
+
+Shows the status of the current game.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game status [-g <value>]
+
+FLAGS
+  -g, --gameId=<value>  The ID of the game
+
+DESCRIPTION
+  Shows the status of the current game.
+
+EXAMPLES
+  $ shipthis game status
+
+  $ shipthis game status --gameId 0c179fc4
+```

package/docs/game/wizard.md

@@ -0,0 +1,23 @@
+# game wizard
+
+## Description
+
+Runs all the steps for the specific platform
+
+## Help Output
+
+```
+USAGE
+  $ shipthis game wizard [-f <value>] [-p ios]
+
+FLAGS
+  -f, --forceStep=<value>  Force a specific step to run.
+  -p, --platform=<option>  [default: ios] The platform to run the wizard for
+                           <options: ios>
+
+DESCRIPTION
+  Runs all the steps for the specific platform
+
+EXAMPLES
+  $ shipthis game wizard
+```

package/docs/game.md

@@ -0,0 +1,19 @@
+# game
+
+Commands related to Game Management
+
+## Topics
+
+- [game:build](game/build.md)
+- [game:ios](game/ios.md)
+- [game:job](game/job.md)
+
+## Commands
+
+- [game create](game/create.md)
+- [game details](game/details.md)
+- [game export](game/export.md)
+- [game list](game/list.md)
+- [game ship](game/ship.md)
+- [game status](game/status.md)
+- [game wizard](game/wizard.md)

package/docs/help.md

@@ -0,0 +1,21 @@
+# help
+
+## Description
+
+Display help for <%= config.bin %>.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for shipthis.
+```

package/docs/login.md

@@ -0,0 +1,28 @@
+# login
+
+## Description
+
+Authenticate - will create a new account if one does not exist.
+
+## Example
+
+[![asciicast](https://asciinema.org/a/sbE3KOpIzgh72lLVdZEXlQZFd.svg)](https://asciinema.org/a/sbE3KOpIzgh72lLVdZEXlQZFd)
+
+## Help Output
+
+```
+USAGE
+  $ shipthis login [-f] [-e <value>]
+
+FLAGS
+  -e, --email=<value>  Your email address
+  -f, --force
+
+DESCRIPTION
+  Authenticate - will create a new account if one does not exist.
+
+EXAMPLES
+  $ shipthis login
+
+  $ shipthis login --force --email me@email.nowhere
+```

package/docs/status.md

@@ -0,0 +1,33 @@
+# status
+
+## Example
+
+[![asciicast](https://asciinema.org/a/zK1v4E15evLKt5NYidnlGZSim.svg)](https://asciinema.org/a/zK1v4E15evLKt5NYidnlGZSim)
+
+## Description
+
+Displays the current overall status.
+
+- **Logged in**
+  - Will be "YES" once you are authenticated
+  - Run `shipthis login` to authenticate
+- **Godot project detected**
+  - Will be "YES" if there is a file named project.godot in the current directory
+- **ShipThis project configured**
+  - Will be "YES" if there is a valid shipthis.json file in the current directory
+- **Git repository detected (not required)**
+  - Will be "YES" if ShipThis detects that there is an active git project
+  - ShipThis will tag your uploads with the current git information (branch and commit hash)
+
+## Help Output
+
+```
+USAGE
+  $ shipthis status
+
+DESCRIPTION
+  Displays the current overall status.
+
+EXAMPLES
+  $ shipthis status
+```