shipmail-cli 0.1.1 → 0.1.3
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 +4 -4
- package/dist/cli.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Shipmail CLI
|
|
2
2
|
|
|
3
|
-
Official command line interface for the
|
|
3
|
+
Official command line interface for the Shipmail API.
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
6
|
npx -y shipmail-cli --help
|
|
@@ -8,7 +8,7 @@ npx -y shipmail-cli --help
|
|
|
8
8
|
|
|
9
9
|
## Authentication
|
|
10
10
|
|
|
11
|
-
Most commands require an API key. Create one in the
|
|
11
|
+
Most commands require an API key. Create one in the Shipmail dashboard and export it:
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
export SHIPMAIL_API_KEY="sm_live_..."
|
|
@@ -49,7 +49,7 @@ shipmail webhooks deliveries whk_123 --status failed
|
|
|
49
49
|
|
|
50
50
|
## Generic API Command
|
|
51
51
|
|
|
52
|
-
The `api` command reaches every
|
|
52
|
+
The `api` command reaches every Shipmail REST endpoint, including endpoints that do not have a shorthand command yet.
|
|
53
53
|
|
|
54
54
|
```bash
|
|
55
55
|
shipmail api GET /domains
|
package/dist/cli.js
CHANGED