https://github.com/blackjacx/assist

App Store Connect API access via CLI written in Swift
https://github.com/blackjacx/assist

apns appstoreconnect appstoreconnect-api hacktoberfest push screenshot snapshot snapshot-testing swift uitesting

Last synced: 9 months ago
JSON representation

App Store Connect API access via CLI written in Swift

Host: GitHub
URL: https://github.com/blackjacx/assist
Owner: Blackjacx
License: mit
Created: 2020-05-24T21:21:45.000Z (almost 6 years ago)
Default Branch: develop
Last Pushed: 2025-05-05T22:15:45.000Z (12 months ago)
Last Synced: 2025-06-07T04:34:08.443Z (11 months ago)
Topics: apns, appstoreconnect, appstoreconnect-api, hacktoberfest, push, screenshot, snapshot, snapshot-testing, swift, uitesting
Language: Swift
Homepage:
Size: 340 KB
Stars: 33
Watchers: 1
Forks: 2
Open Issues: 18
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS

Awesome Lists containing this project

README

[![Twitter Follow](https://img.shields.io/badge/follow-%40blackjacx-1DA1F2?logo=twitter&style=for-the-badge)](https://twitter.com/intent/follow?original_referer=https%3A%2F%2Fgithub.com%2Fblackjacx&screen_name=Blackjacxxx)
[![Version](https://shields.io/github/v/release/blackjacx/Assist?display_name=tag&include_prereleases&sort=semver)](https://github.com/Blackjacx/Assist/releases)
[![Swift Package Manager Compatible](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://swift.org/package-manager/)
[![Swift Versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FBlackjacx%2FAssist%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/Blackjacx/Assist)
[![Platforms](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FBlackjacx%2FAssist%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/Blackjacx/Assist)
[![Xcode 16+](https://img.shields.io/badge/Xcode-16%2B-blue.svg)](https://developer.apple.com/download/)
[![Codebeat](https://codebeat.co/badges/6fb8ff62-9cb4-484a-8c0d-6f7f973d3f0d)](https://codebeat.co/projects/github-com-blackjacx-assist-develop)
[![License](https://img.shields.io/github/license/blackjacx/assist.svg)](https://github.com/blackjacx/assist/blob/master/LICENSE)
[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg?logo=paypal&style=for-the-badge)](https://www.paypal.me/STHEROLD)

# 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:

```sh
asc app-store-versions list -k \
asc app-store-versions list -k \
asc app-store-versions list -k
```

## Installation

### Via [Homebrew](http://brew.sh/)

```sh
brew tap Blackjacx/asc
brew install asc
```

### Via [Mint](https://github.com/yonaskolb/mint)

Just install Mint using with [Homebrew](https://brew.sh/) via `brew install mint`.

```sh
mint install Blackjacx/Assist
```

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

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

### Via Command Line

```sh
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](https://appstoreconnect.apple.com/access/api) and execute the following command which will just store the exact parameters you provide in the user defaults.

```sh
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:

```sh
# 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`

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

USAGE: asc api-keys