StoreConfig Documentation

Everything you need to know to get started with StoreConfig and manage your App Store Connect configurations.

Quick Start

Get Your Secret Key

You will need a StoreConfig Secret Key to authenticate with our service.

Get Secret Key

Installation & Setup

Get up and running with StoreConfig in just a few minutes.

Install StoreConfig

npm install -g storeconfig

Install the CLI tool globally on your system.

Configure StoreConfig

storeconfig configure

Enter the Secret Key you received via email to configure StoreConfig.

Add Apple Credentials

storeconfig apple --issuer-id YOUR_ID --key-id YOUR_KEY_ID --key-path /PATH/TO/KEY.p8

Set up your App Store Connect API credentials. Replace YOUR_ID, YOUR_KEY_ID, and /PATH/TO/KEY.p8 with your actual values.

Fetch Your App

storeconfig fetch

Download your app configuration to get started (saves to storeconfig.json by default).

Apply Changes

storeconfig apply

Upload your changes back to App Store Connect (uses storeconfig.json by default).

Commands Reference

fetch

Fetch current app configuration from App Store Connect

Usage

storeconfig fetch [--f my-app.json] [--id 1234567890]

Options

--f, --fileOptional

Output file path for the configuration (defaults to storeconfig.json)

--idOptional

Specific app ID to fetch (if not provided, you'll select from available apps)

apply

Apply changes from JSON file to App Store Connect

Usage

storeconfig apply [--f my-app.json] [--p]

Options

--f, --fileOptional

Input file path for the configuration (defaults to storeconfig.json)

--p, --previewOptional

Preview changes without applying them

set-price

Set prices for your app, in-app purchases, and subscriptions interactively. This updates pricing only in your configuration file; changes won't be applied to App Store Connect until you run the `apply` command.

Usage

storeconfig set-price [--f my-app.json]

Options

--f, --fileOptional

Input file path for the configuration (defaults to storeconfig.json)

compare-price

Compare prices across territories in USD

Usage

storeconfig compare-price [--f my-app.json] [--o price-analysis.csv]

Options

--f, --fileOptional

Input JSON file path (defaults to storeconfig.json)

--o, --outputOptional

Output CSV file path (defaults to compare-price.csv)

example

Generate example JSON files for different data types

Usage

storeconfig example [--type minimal] [--file output.json]

Options

--t, --typeOptional

Type of example (minimal, full, subscription, iap) - if not provided, you'll select interactively

--f, --fileOptional

Path to the output JSON file (defaults to storeconfig_example.json)

configure

Configure StoreConfig with your Secret Key

Usage

storeconfig configure

apple

Add Apple App Store Connect credentials

Usage

storeconfig apple --issuer-id YOUR_ID --key-id YOUR_KEY_ID --key-path /path/to/key.p8

Options

--issuer-idRequired

Apple App Store Connect Issuer ID

--key-idRequired

Apple App Store Connect Key ID

--key-pathRequired

Path to Apple private key (.p8 file)

user

Display current user information and most recent apply status

Usage

storeconfig user

Schema Reference

JSON Schema Documentation

Detailed schema documentation for all supported data structures and configurations.

For comprehensive information about JSON schemas, data types, and validation rules, visit our detailed schema documentation.

View Schema Documentation

AI Integration - IDE Support - JSON Schema

JSON Schema URL

StoreConfig provides a JSON Schema that enhances the development experience by offering validation, autocomplete, and IntelliSense support in your favorite IDE, while also improving results with AI tools.

https://storeconfig.com/storeconfig-schema.json

AI Integration

When using AI tools to modify your StoreConfig JSON files, provide the schema URL for more accurate and consistent results.

VSCode Setup

Enable validation, autocomplete, and IntelliSense support

Setup Steps

Open VSCode Settings (Cmd/Ctrl + ,)
Search for "json schema"
Ensure Schema Download is enabled:
Click "Edit in settings.json"
Add the following configuration:

// root settings.json
{
  // Other settings (if any)...
  "json.schemas": [
    // Other schemas (if any)...
    {
      "fileMatch": ["*storeconfig*.json"],
      "url": "https://storeconfig.com/storeconfig-schema.json"
    }
  ]
}

Note: You can add this configuration to either:
• User Settings (applies to all your projects)
• Workspace Settings (applies only to the current project)

Example JSON Structure

Current Limitations

App Store Connect API Restrictions

Due to current App Store Connect API limitations, some features are not yet available.

Creating New Apps

New apps can only be created via the App Store Connect website.

App Privacy

App Privacy data can only be created or updated through the App Store Connect website.

State Management

Submitting apps, in-app purchases, and subscriptions is not supported. These actions are usually performed as a final step and are not repetitive or particularly difficult to do manually.

Age Rating

Setting age ratings for apps is not currently supported.

Start and End Dates

Setting start and end dates for in-app purchases and subscriptions is not supported.

Promo Offers

Promo offers for subscriptions are not supported.

Billing Grace Period

Billing grace period for subscriptions is not supported.

Planned Features

Upcoming Capabilities

Features we plan to add as soon as they become available through the App Store Connect API.

App Category

Support for setting app categories will be added soon.

Content Rights

Support for managing content rights will be added soon.

iOS Platform

Currently, only the iOS platform is supported. We plan to add support for additional platforms in the future.

Security

Secret Key

StoreConfig Secret Keys are stored locally on your machine and never shared with third parties.

Apple Credentials

Apple credentials are encrypted and stored securely on our servers. You can revoke access at any time through your Apple Developer account or contact us to delete your user data and credentials.

Need Help?

GitHub Issues

Report bugs, request features, or get help from the community.

Open Issue

FAQ

Find answers to frequently asked questions about StoreConfig.

View FAQ

Ready to Get Started?

Join developers who have already saved hundreds of hours with StoreConfig.

Start Free Trial