App Store Connect API • CLI

App Store Connect API access using your private API key. The great power of this tool is that it can operate on all apps of one or multiple teams (is you wish to), e.g. it is super easy to print the live versions of all of your apps, even across multiple teams:

asc app-store-versions list -k <key_id_1> \
asc app-store-versions list -k <key_id_2> \
asc app-store-versions list -k <key_id_3>

Installation

Via Homebrew

brew tap Blackjacx/asc
brew install asc

Via Mint

Just install Mint using with Homebrew via brew install mint.

mint install Blackjacx/Assist

You can also run command line tools with mint without installing them first. Mint will automatically clone and install it.

mint run git@github.com:Blackjacx/Assist.git asc apps

Via Command Line

git clone https://github.com/blackjacx/assist.git AppStoreConnect
cd AppStoreConnect
swift run asc -h

Authentication

Authentication is handled by the tool itself. The only thing needed is your private API key. Generate one at App Store Connect account and execute the following command which will just store the exact parameters you provide in the user defaults.

asc api-keys register -n "name" -k "key-id" -i "issuer-id" -p "path-to-private-key-file"

⚠️ No key generation performed here. The JWT is just generated on demand when using this tool. If you have multiple keys registered the tool will ask you which one you want to use.

Sub Commands

Executing one of the following sub commands is as easy as appending it with its parameters to the base command:

# list all registered API keys
asc api-keys list

# register API key for specific team
asc api-keys register -n "name" -k "key-id" -i "issuer-id" -p "path-to-private-key-file"

# delete API key for specific team
asc api-keys delete -k "key-id"



# list is the default 
asc beta-groups                                

# list only beta groups with a specific name
asc beta-groups -g "group-name"



# list apps of your team
asc apps



# add beta tester to all groups matching `group-name`
asc beta-testers add -e "john@doe.com" -n "John" -l "Doe" -g "group-name"

# add beta tester to all groups matching all specified group names
asc beta-testers add -e "john@doe.com" -n "John" -l "Doe" -g "group-name-1" -g "group-name-2"



# delete beta tester from all groups found
asc beta-testers delete -e "john@doe.com"



# lists all your teams apps with their live version or if not live with their current status
asc app-store-versions

`api-keys`

OVERVIEW: Lists, registers and deletes App Store Connect API keys on your Mac.

USAGE: asc api-keys <subcommand>

OPTIONS:
--version               Show the version.
-h, --help              Show help information.

SUBCOMMANDS:
list (default)          List locally stored App Store Connect API keys keys.
register                Registers App Store Connect API keys locally.
delete                  Delete locally stored App Store Connect API keys.

See 'asc help api-keys <subcommand>' for detailed help.

`beta-groups`

OVERVIEW: Manage groups of beta testers that have access to one or more builds.

USAGE: asc beta-groups <subcommand>

OPTIONS:
--version               Show the version.
-h, --help              Show help information.

SUBCOMMANDS:
list (default)          Find and list beta testers for all apps, builds, and beta groups.

See 'asc help beta-groups <subcommand>' for detailed help.

`beta-testers`

OVERVIEW: Manage people who can install and test prerelease builds.

USAGE: asc beta-testers <subcommand>

OPTIONS:
--version               Show the version.
-h, --help              Show help information.

SUBCOMMANDS:
list (default)          Find and list beta testers for all apps, builds, and
beta groups.
invite                  Send or resend an invitation to a beta tester to test
specified apps.
add                     Create a beta tester assigned to a group, a build, or
an app.
delete                  Remove a beta tester's ability to test all or
specific apps.

See 'asc help beta-testers <subcommand>' for detailed help.

`apps`

OVERVIEW: Manage your apps in App Store Connect.

USAGE: asc apps <subcommand>

OPTIONS:
--version               Show the version.
-h, --help              Show help information.

SUBCOMMANDS:
list (default)          Find and list apps added in App Store Connect.

See 'asc help apps <subcommand>' for detailed help.

`app-store-versions`

OVERVIEW: Manage versions of your app that are available in App Store.

USAGE: asc app-store-versions <subcommand>

OPTIONS:
--version               Show the version.
-h, --help              Show help information.

SUBCOMMANDS:
list (default)          Get a list of all App Store versions of an app across
all platforms.

See 'asc help app-store-versions <subcommand>' for detailed help.

`builds`

OVERVIEW: Manage builds for testers and submit builds for review.

USAGE: asc builds <subcommand>

OPTIONS:
--version               Show the version.
-h, --help              Show help information.

SUBCOMMANDS:
list (default)          Find and list builds for all apps in App Store Connect.

See 'asc help builds <subcommand>' for detailed help.

`bundle-ids`

OVERVIEW: Manage the bundle IDs that uniquely identify your apps.

USAGE: asc bundle-ids <subcommand>

OPTIONS:
  --version               Show the version.
  -h, --help              Show help information.

SUBCOMMANDS:
  list (default)          Find and list bundle IDs that are registered to your
                          team.
  register                Register a new bundle ID for app development.

  See 'asc help bundle-ids <subcommand>' for detailed help.

Code Documentation

The code documentation for ASC, Push and Snap is generated and hosted by Swift Package Index (powered by DocC)

Release

To release this Swift package the following steps have to be taken:

Create a new branch release-x.y.z
Increment the version in Core.Constants.version
Run bash <(curl -H -s https://raw.githubusercontent.com/Blackjacx/Scripts/master/frameworks/bootstrap.sh) to update to the latest shared development files
Run bundle update to update all Ruby gems
Commit all changes, make a PR and merge it to develop
Run bundle exec fastlane release framework:"Assist" version:"x.y.z" formula:"blackjacx/formulae/asc" to release the new version
Merge the created PR on https://github.com/Blackjacx/homebrew-formulae
Post the following on Twitter ``` Assist (ASC, Push, Snap) release x.y.z 🎉

▸ 🚀 Tools asc, snap, push (x.y.z) successfully published ▸ 📅 September 2nd ▸ 🌎 https://swiftpackageindex.com/Blackjacx/Assist ▸ 🌎 https://github.com/Blackjacx/Assist/releases/latest ▸ 👍 Tell your friends!

SPM #Automated #Snapshots #Push #Firebase #APNS #ASC #AppStoreConnectAPI


## Contribution

- If you found a **bug**, please open an **issue**.
- If you have a **feature request**, please open an **issue**.
- If you want to **contribute**, please submit a **pull request**.

## Author

[Stefan Herold](mailto:stefan.herold@gmail.com) • 🐦 [@Blackjacxxx](https://twitter.com/Blackjacxxx)

## Contributors

Thanks to all of you who are part of this:

<a href="https://github.com/blackjacx/Assist/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=blackjacx/Assist" />
</a>

## License

ASC is available under the MIT license. See the [LICENSE](LICENSE) file for more info.