shopq 0.1.0 → 0.3.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/README.md +15 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# shopq
|
|
2
2
|
|
|
3
3
|
[](https://github.com/c-99-e/shopq/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/shopq)
|
|
4
5
|
[](LICENSE)
|
|
5
6
|
[](https://bun.sh)
|
|
6
7
|
|
|
@@ -8,26 +9,26 @@ A zero-dependency Shopify Admin CLI built on [Bun](https://bun.sh). Manage produ
|
|
|
8
9
|
|
|
9
10
|
Built with AI agents as the primary user — structured JSON output, predictable exit codes, and no interactive prompts.
|
|
10
11
|
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
bun install -g shopq
|
|
16
|
+
```
|
|
17
|
+
|
|
11
18
|
## Prerequisites
|
|
12
19
|
|
|
13
|
-
- [Bun](https://bun.sh) v1.3+
|
|
20
|
+
- [Bun](https://bun.sh) v1.3+ (also works with Node.js v18+)
|
|
14
21
|
- A Shopify store with a [Dev Dashboard app](https://shopify.dev/docs/apps/build/authentication-authorization/client-credentials) configured for Client Credentials
|
|
15
22
|
|
|
16
23
|
## Setup
|
|
17
24
|
|
|
18
|
-
|
|
25
|
+
Configure your store credentials:
|
|
19
26
|
|
|
20
27
|
```bash
|
|
21
|
-
|
|
22
|
-
cd shopq
|
|
23
|
-
bun install
|
|
28
|
+
shopq config set --store your-store.myshopify.com --client-id your-client-id --client-secret your-client-secret
|
|
24
29
|
```
|
|
25
30
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
cp .env.example .env
|
|
30
|
-
```
|
|
31
|
+
Or set environment variables:
|
|
31
32
|
|
|
32
33
|
```
|
|
33
34
|
SHOPIFY_STORE=your-store.myshopify.com
|
|
@@ -35,11 +36,12 @@ SHOPIFY_CLIENT_ID=your-client-id
|
|
|
35
36
|
SHOPIFY_CLIENT_SECRET=your-client-secret
|
|
36
37
|
```
|
|
37
38
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
3. Link the CLI globally (optional):
|
|
39
|
+
### Development
|
|
41
40
|
|
|
42
41
|
```bash
|
|
42
|
+
git clone https://github.com/c-99-e/shopq.git
|
|
43
|
+
cd shopq
|
|
44
|
+
bun install
|
|
43
45
|
bun link
|
|
44
46
|
```
|
|
45
47
|
|