aso-cli 0.1.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Semih Cihan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,122 @@
1
+ # App Store Optimization CLI
2
+
3
+ [![npm version](https://img.shields.io/npm/v/aso-cli)](https://www.npmjs.com/package/aso-cli)
4
+ [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
5
+ [![Node.js](https://img.shields.io/node/v/aso-cli)](https://www.npmjs.com/package/aso-cli)
6
+ [![CI](https://img.shields.io/github/actions/workflow/status/semihcihan/App-Store-Optimization-CLI/ci.yml?branch=main&label=ci)](https://github.com/semihcihan/App-Store-Optimization-CLI/actions/workflows/ci.yml)
7
+
8
+ Research ASO keywords, inspect competition, and manage results from one local-first CLI.
9
+
10
+ ## Why use it
11
+
12
+ - Fast, free keyword research and visibility tracking
13
+ - Keyword scoring with popularity + difficulty in one command
14
+ - Local dashboard for reviewing keyword/app data
15
+ - MCP tool (`aso_suggest`) for agent workflows and automated keyword research
16
+ - Local persistence and reusable auth session
17
+
18
+ ## Install
19
+
20
+ ```bash
21
+ npm install -g aso-cli
22
+ ```
23
+
24
+ ## Apple Search Ads Setup
25
+
26
+ ASO commands require Apple Search Ads setup.
27
+
28
+ ### Prerequisites
29
+
30
+ - Apple Search Ads account
31
+ - Linked App Store Connect account
32
+ - App ID of a published app you can access
33
+ - No campaign creation or billing required
34
+
35
+ ### Setup
36
+
37
+ 1. Create/sign in: https://searchads.apple.com
38
+ 2. Open Advanced: https://searchads.apple.com/advanced
39
+ 3. Link your App Store Connect account in campaign group settings
40
+ 4. Copy an App ID from your App Store URL (number after `id`)
41
+ 5. Run `aso auth` and complete Apple ID + password + 2FA in terminal
42
+
43
+ Example App Store URL:
44
+
45
+ ```text
46
+ https://apps.apple.com/us/app/example-app/id123456789
47
+ ```
48
+
49
+ App ID is `123456789` in this example.
50
+
51
+ ## Quick Start
52
+
53
+ ```bash
54
+ # Authenticate once
55
+ aso auth
56
+
57
+ # Fetch keyword metrics
58
+ aso keywords "meditation,sleep sounds,white noise"
59
+
60
+ # Open dashboard
61
+ aso
62
+ ```
63
+
64
+ ## Command Reference
65
+
66
+ | Command | What it does |
67
+ | --- | --- |
68
+ | `aso` | Starts the local dashboard (default command) |
69
+ | `aso keywords "k1,k2,k3"` | Fetches keyword popularity/difficulty and prints JSON |
70
+ | `aso keywords "k1,k2" --stdout` | Machine-safe non-interactive mode for automation/agents |
71
+ | `aso auth` | Reauthenticates Apple Search Ads session |
72
+ | `aso reset-credentials` | Clears saved credentials/cookies |
73
+ | `aso --primary-app-id <id>` | Sets primary App ID used for popularity requests |
74
+
75
+ ### Supported flags
76
+
77
+ - `--country <code>`: currently `US` only
78
+ - `--primary-app-id <id>`: saved locally for future runs
79
+
80
+ ## Output Example (`aso keywords`)
81
+
82
+ ```json
83
+ [
84
+ {
85
+ "keyword": "meditation",
86
+ "popularity": 45,
87
+ "difficultyScore": 62,
88
+ "minDifficultyScore": 38
89
+ }
90
+ ]
91
+ ```
92
+
93
+ ## MCP
94
+
95
+ This package also installs `aso-mcp` with tool: `aso_suggest`.
96
+
97
+ Example MCP config:
98
+
99
+ ```json
100
+ {
101
+ "mcpServers": {
102
+ "aso": {
103
+ "command": "aso-mcp"
104
+ }
105
+ }
106
+ }
107
+ ```
108
+
109
+ ## Help
110
+
111
+ ```bash
112
+ aso --help
113
+ ```
114
+
115
+ ## Current Scope
116
+
117
+ - Storefront support: `US`
118
+ - Multi-storefront support is planned
119
+
120
+ ## Project Docs
121
+
122
+ - Contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md)
@@ -0,0 +1,49 @@
1
+ # Third-Party Licenses
2
+
3
+ This CLI includes the following open-source libraries bundled with the package:
4
+
5
+ - **inquirer** (MIT License) - [GitHub](https://github.com/SBoudrias/Inquirer.js?tab=MIT-1-ov-file)
6
+ - **ora** (MIT License) - [GitHub](https://github.com/sindresorhus/ora?tab=MIT-1-ov-file)
7
+
8
+ ## License Texts
9
+
10
+ ### inquirer
11
+
12
+ ```
13
+ Copyright (c) 2025 Simon Boudrias
14
+
15
+ Permission is hereby granted, free of charge, to any person
16
+ obtaining a copy of this software and associated documentation
17
+ files (the "Software"), to deal in the Software without
18
+ restriction, including without limitation the rights to use,
19
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
20
+ copies of the Software, and to permit persons to whom the
21
+ Software is furnished to do so, subject to the following
22
+ conditions:
23
+
24
+ The above copyright notice and this permission notice shall be
25
+ included in all copies or substantial portions of the Software.
26
+
27
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
29
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
31
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
32
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
33
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
34
+ OTHER DEALINGS IN THE SOFTWARE.
35
+ ```
36
+
37
+ ### ora
38
+
39
+ ```
40
+ MIT License
41
+
42
+ Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
43
+
44
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
45
+
46
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
47
+
48
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
49
+ ```