@usethrottle/cli 1.0.0 → 1.0.1
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 +9 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,13 @@ throttle bc-connect
|
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
You'll be prompted for:
|
|
20
|
-
|
|
20
|
+
|
|
21
|
+
1. Your Throttle API key (sk\_\*) — create one in the Throttle dashboard.
|
|
21
22
|
2. Your BigCommerce store hash (the part of your store URL after `stores/`)
|
|
22
23
|
3. Your BigCommerce API token (Settings → API accounts → Create V2/V3 API token; needs Modify scopes for Orders, Customers, Carts, Webhooks)
|
|
23
24
|
|
|
24
25
|
Or non-interactive:
|
|
26
|
+
|
|
25
27
|
```bash
|
|
26
28
|
throttle bc-connect --api-key sk_xxx --store-hash abc123 --access-token tok_xxx
|
|
27
29
|
```
|
|
@@ -50,12 +52,12 @@ throttle embed-config set \
|
|
|
50
52
|
--merchant-name "Shop"
|
|
51
53
|
```
|
|
52
54
|
|
|
53
|
-
Origins must be `https://host[:port]
|
|
54
|
-
|
|
55
|
+
Origins must be `https://host[:port]`. No paths, no trailing slashes, no
|
|
56
|
+
wildcards. Up to 20 entries.
|
|
55
57
|
|
|
56
58
|
## Configuration
|
|
57
59
|
|
|
58
|
-
| Flag
|
|
59
|
-
|
|
60
|
-
| `--api`
|
|
61
|
-
| `--api-key` | `THROTTLE_API_KEY` | (interactive prompt)
|
|
60
|
+
| Flag | Env var | Default |
|
|
61
|
+
| ----------- | ------------------ | ----------------------------- |
|
|
62
|
+
| `--api` | `THROTTLE_API_URL` | `https://api.usethrottle.dev` |
|
|
63
|
+
| `--api-key` | `THROTTLE_API_KEY` | (interactive prompt) |
|