Skip to main content

Quick Start

Get asc-cli running in 5 minutes.

Prerequisites​

  • Python 3.9+ or uv package manager
  • App Store Connect API key (get one here)
  • At least one app in App Store Connect

Step 1: Install​

Choose your preferred method:

uv tool install asc-cli

Using pip​

pip install asc-cli

Using pipx​

pipx install asc-cli

Verify installation:

asc --version

Step 2: Get API Credentials​

You need three pieces from App Store Connect:

  1. Go to App Store Connect
  2. Navigate to Users and Access → Integrations → App Store Connect API
  3. Click + to generate a new key
  4. Select Admin or App Manager role
  5. Click Generate

Save these items:

  • Issuer ID - UUID at the top of the page
  • Key ID - 10-character identifier
  • Private Key - Download the .p8 file (one-time download!)
Save Your Key

The .p8 private key file can only be downloaded once. Store it securely.

Step 3: Configure Authentication​

Run the interactive setup:

asc auth login

Enter when prompted:

  • Issuer ID
  • Key ID
  • Path to your .p8 file

Or configure in one command:

asc auth login \
  --issuer-id YOUR_ISSUER_ID \
  --key-id YOUR_KEY_ID \
  --key-path ~/path/to/AuthKey_XXXXX.p8

Step 4: Test Connection​

Verify authentication works:

asc auth test

Expected output:

✓ Authentication successful
✓ Connected to App Store Connect
✓ Found 3 apps in your account

Step 5: Run Your First Command​

List your apps:

asc apps list

Example output:

Bundle ID                    Name             SKU
live.yooz.whisper           Yooz Whisper     YOOZWHISPER
live.yooz.notes             Yooz Notes       YOOZNOTES

Common First Commands​

List Subscriptions​

asc subscriptions list live.yooz.whisper

Check Pricing​

asc subscriptions pricing list SUBSCRIPTION_ID

List TestFlight Builds​

asc testflight builds list live.yooz.whisper

Quick Workflow Example​

Set up a subscription with pricing and free trial:

# 1. List your subscriptions to get the ID
asc subscriptions list live.yooz.whisper

# 2. Set pricing to $2.99/month
asc subscriptions pricing set SUB_ID --price 2.99 --dry-run
asc subscriptions pricing set SUB_ID --price 2.99

# 3. Add a 2-week free trial
asc subscriptions offers create SUB_ID \
  --type free-trial \
  --duration 2w \
  --all

Using Mock Server (Development)​

For testing without affecting production, use the mock server:

# Start mock server
asc mock start

# Run commands against mock
ASC_MOCK=true asc apps list

# Stop mock server
asc mock stop

See the Mock Server section in the main documentation for more details.

Troubleshooting​

"Command not found"​

Ensure the install location is in your PATH:

# For uv
export PATH="$HOME/.local/bin:$PATH"

# For pip (user install)
export PATH="$HOME/.local/bin:$PATH"

"Not authenticated"​

Run asc auth login to configure credentials.

"Invalid token"​

  • Verify Issuer ID and Key ID match App Store Connect
  • Check .p8 file is readable and not corrupted
  • Ensure key hasn't been revoked

"Permission denied"​

Your API key role may lack permissions. Use Admin or App Manager role.

Next Steps​