storeconfig 0.0.21 → 0.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # StoreConfig CLI
2
2
 
3
- A powerful command-line tool for managing apps on **App Store Connect**. Manage **in-app purchases**, **subscriptions**, **pricing**, **localizations**, **metadata**, **availability**, and more. Sync your app configurations from local JSON files to App Store Connect - the smart way. **No more manual work**.
3
+ A powerful command-line tool for automating **App Store Connect** app management with JSON-based workflows. Manage **in-app purchases**, **subscriptions**, **pricing**, **localizations**, **metadata**, **availability**, and more. Sync your app configurations from local JSON files to App Store Connect - the smart way. **No more manual work**.
4
4
 
5
5
  [![npm version](https://badge.fury.io/js/storeconfig.svg)](https://badge.fury.io/js/storeconfig)
6
6
 
@@ -23,7 +23,7 @@ For detailed documentation, visit [storeconfig.com/docs](https://storeconfig.com
23
23
  - **😌 Easy to Use** - Prepare App Store Connect for your app in minutes instead of hours. What normally takes 2+ hours of manual work is now done in minutes.
24
24
  - **⚡️ Quick App Duplication** - Copy App Store Connect data from an existing app to a new app in minutes.
25
25
  - **📄 Configuration as Code** - Define your app structure in version-controlled JSON files.
26
- - **🤖 Vibe Code Your App Store Connect Setup** - Use AI to vibe code your JSON configuration for app descriptions, content updates, in-app purchases, subscriptions, and more.
26
+ - **🤖 Vibe Code Your App Store Connect Setup** - Use our MCP server and AI to vibe code your JSON configuration for app descriptions, content updates, in-app purchases, subscriptions, and more.
27
27
  - **🌍 Multi-Language Support** - Easily manage localized content across all supported territories.
28
28
  - **📊 Bulk Operations** - Make changes across multiple products, subscriptions, or territories at once.
29
29
  - **🔄 Bidirectional Sync** - Fetch current state of your app and apply changes to App Store Connect.
@@ -68,17 +68,14 @@ storeconfig apple --key-path /path/to/your/AuthKey_XXXXX.p8
68
68
  This is required for store config to manage your apps on App Store Connect.
69
69
 
70
70
  1. **Open App Store Connect API Settings**
71
-
72
71
  - Go to [https://appstoreconnect.apple.com/access/integrations/api](https://appstoreconnect.apple.com/access/integrations/api)
73
72
  - Make sure the correct team is selected on top right corner of the page
74
73
 
75
74
  2. **Create a New Team Key**
76
-
77
75
  - Click the "Plus" button to create a new `Team Key` (Not Individual Key)
78
76
  - Choose a descriptive name (e.g., "StoreConfig") to easily identify it later
79
77
 
80
78
  3. **Set Required Permissions**
81
-
82
79
  - Select **App Manager Access** - this is required to manage prices and other app configurations
83
80
 
84
81
  4. **Download and Copy Credentials**
@@ -217,23 +214,43 @@ storeconfig example --type iap
217
214
  }
218
215
  ```
219
216
 
220
- ## 🧰 AI Integration - IDE Support - JSON Schema
217
+ ## 🧰 MCP Server - AI Integration
221
218
 
222
- 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.
219
+ ### MCP Server - AI Integration
223
220
 
224
- ### AI Integration
221
+ StoreConfig includes a Model Context Protocol (MCP) server that provides AI assistants with direct access to the JSON schema, business rules, and CLI guidelines. This enables AI tools to better understand and help you work with StoreConfig files.
225
222
 
226
- When using AI tools to modify your StoreConfig JSON files, provide the schema URL for more accurate and consistent results:
223
+ This is optional but recommended for the best experience.
227
224
 
228
- **JSON Schema URL:** `https://storeconfig.com/storeconfig-schema.json`
225
+ #### Installation
226
+
227
+ The MCP server is included when you install StoreConfig globally.
228
+
229
+ #### Configuration
230
+
231
+ Add the following configuration to your MCP client:
232
+
233
+ ```json
234
+ {
235
+ "storeconfig": {
236
+ "command": "storeconfig-mcp"
237
+ }
238
+ }
239
+ ```
240
+
241
+ For detailed setup instructions for different MCP clients (Cursor, VSCode, Claude Desktop, etc.), see the [MCP Configuration documentation](https://storeconfig.com/docs#mcp-configuration).
229
242
 
230
243
  ### VSCode Setup
231
244
 
232
- 1. **Open VSCode Settings** (Cmd/Ctrl + ,)
233
- 2. **Search for "json schema"**
234
- 3. **Ensure Schema Download is enabled:**
235
- 4. **Click "Edit in settings.json"**
236
- 5. **Add the following configuration:**
245
+ Enable validation, autocomplete, and IntelliSense support. This is optional but recommended for the best experience.
246
+
247
+ #### Setup Steps
248
+
249
+ 1. Open VSCode Settings (Cmd/Ctrl + ,)
250
+ 2. Search for "json schema"
251
+ 3. Ensure Schema Download is enabled
252
+ 4. Click "Edit in settings.json"
253
+ 5. Add the following configuration:
237
254
 
238
255
  ```json
239
256
  // root settings.json
@@ -254,6 +271,14 @@ When using AI tools to modify your StoreConfig JSON files, provide the schema UR
254
271
  > - **User Settings** (applies to all your projects)
255
272
  > - **Workspace Settings** (applies only to the current project)
256
273
 
274
+ #### JSON Schema URL
275
+
276
+ The schema URL used in the configuration above:
277
+
278
+ **JSON Schema URL:** `https://storeconfig.com/storeconfig-schema.json`
279
+
280
+ > **Note:** If you don't want to use the MCP server, you can still use AI tools with StoreConfig by providing the schema URL directly. When using AI tools to modify your StoreConfig JSON files, provide the schema URL for more accurate and consistent results.
281
+
257
282
  ### Benefits
258
283
 
259
284
  - ✅ **Real-time validation** - Catch errors as you type
@@ -261,10 +286,6 @@ When using AI tools to modify your StoreConfig JSON files, provide the schema UR
261
286
  - ✅ **Documentation** - Hover over properties to see descriptions
262
287
  - ✅ **Type safety** - Ensure your JSON structure is correct
263
288
 
264
- ### Schema URL
265
-
266
- The JSON Schema is available at: [https://storeconfig.com/storeconfig-schema.json](https://storeconfig.com/storeconfig-schema.json)
267
-
268
289
  ### Tool Limitations
269
290
 
270
291
  Due to current App Store Connect API restrictions, some features are not yet available in the CLI. As soon as these capabilities are supported by the API, we will update the CLI accordingly.