shopq 0.3.3 → 0.3.7
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 +29 -10
- package/package.json +5 -5
- package/dist/shopctl.js +0 -2264
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# shopq
|
|
2
2
|
|
|
3
|
-
[](https://github.com/c99e/shopq/actions/workflows/ci.yml)
|
|
4
4
|
[](https://www.npmjs.com/package/shopq)
|
|
5
5
|
[](LICENSE)
|
|
6
6
|
[](https://bun.sh)
|
|
@@ -11,24 +11,39 @@ Built with AI agents as the primary user — structured JSON output, predictable
|
|
|
11
11
|
|
|
12
12
|
## Install
|
|
13
13
|
|
|
14
|
+
### CLI
|
|
15
|
+
|
|
14
16
|
```bash
|
|
15
17
|
bun install -g shopq
|
|
16
18
|
```
|
|
17
19
|
|
|
20
|
+
### Pi coding agent
|
|
21
|
+
|
|
22
|
+
Install as a [pi package](https://shittycodingagent.ai/packages) to give your agent Shopify skills:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
pi install npm:shopq
|
|
26
|
+
```
|
|
27
|
+
|
|
18
28
|
## Prerequisites
|
|
19
29
|
|
|
20
|
-
- [Bun](https://bun.sh) v1.3+ (also works with Node.js
|
|
21
|
-
- A Shopify store with a
|
|
30
|
+
- [Bun](https://bun.sh) v1.3+ (also works with Node.js v22+)
|
|
31
|
+
- A Shopify store with a Dev Dashboard app (see setup below)
|
|
22
32
|
|
|
23
33
|
## Setup
|
|
24
34
|
|
|
25
|
-
|
|
35
|
+
### 1. Create a Shopify app
|
|
26
36
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
37
|
+
1. Go to the [Shopify Dev Dashboard](https://dev.shopify.com/) and create a new app
|
|
38
|
+
2. Configure the API scopes your app needs and release a version
|
|
39
|
+
3. Click **Install app** (top right of the app overview page) to install it on your store
|
|
40
|
+
4. Go to your app's **Settings** page and copy the **Client ID** and **Secret**
|
|
41
|
+
|
|
42
|
+
Your store URL is the `xxx.myshopify.com` domain shown in your Shopify admin sidebar.
|
|
30
43
|
|
|
31
|
-
|
|
44
|
+
### 2. Configure credentials
|
|
45
|
+
|
|
46
|
+
Create a `.env` file in your project directory:
|
|
32
47
|
|
|
33
48
|
```
|
|
34
49
|
SHOPIFY_STORE=your-store.myshopify.com
|
|
@@ -36,13 +51,17 @@ SHOPIFY_CLIENT_ID=your-client-id
|
|
|
36
51
|
SHOPIFY_CLIENT_SECRET=your-client-secret
|
|
37
52
|
```
|
|
38
53
|
|
|
54
|
+
Bun loads `.env` automatically — no extra setup needed. shopq handles the OAuth token exchange behind the scenes.
|
|
55
|
+
|
|
39
56
|
### Development
|
|
40
57
|
|
|
41
58
|
```bash
|
|
42
|
-
git clone https://github.com/
|
|
59
|
+
git clone https://github.com/c99e/shopq.git
|
|
43
60
|
cd shopq
|
|
44
61
|
bun install
|
|
45
|
-
|
|
62
|
+
|
|
63
|
+
# Run locally without affecting a global shopq install
|
|
64
|
+
bun run bin/shopq.ts <command>
|
|
46
65
|
```
|
|
47
66
|
|
|
48
67
|
## Usage
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "shopq",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.7",
|
|
4
4
|
"description": "A zero-dependency Shopify Admin CLI built on Bun",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -20,11 +20,11 @@
|
|
|
20
20
|
},
|
|
21
21
|
"repository": {
|
|
22
22
|
"type": "git",
|
|
23
|
-
"url": "git+https://github.com/
|
|
23
|
+
"url": "git+https://github.com/c99e/shopq.git"
|
|
24
24
|
},
|
|
25
|
-
"homepage": "https://github.com/
|
|
25
|
+
"homepage": "https://github.com/c99e/shopq",
|
|
26
26
|
"bugs": {
|
|
27
|
-
"url": "https://github.com/
|
|
27
|
+
"url": "https://github.com/c99e/shopq/issues"
|
|
28
28
|
},
|
|
29
29
|
"keywords": [
|
|
30
30
|
"shopify",
|
|
@@ -47,6 +47,6 @@
|
|
|
47
47
|
"@types/bun": "latest"
|
|
48
48
|
},
|
|
49
49
|
"peerDependencies": {
|
|
50
|
-
"typescript": "^5"
|
|
50
|
+
"typescript": "^5.9.3"
|
|
51
51
|
}
|
|
52
52
|
}
|