hookdeck-cli 0.10.0 → 0.11.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 +8 -8
- package/bin/hookdeck +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,17 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
[![slack-badge]](https://join.slack.com/t/hookdeckdevelopers/shared_invite/zt-yw7hlyzp-EQuO3QvdiBlH9Tz2KZg5MQ)
|
|
6
6
|
|
|
7
|
-
Using the Hookdeck CLI, you can forward your events (e.g. webhooks) to your local
|
|
7
|
+
Using the Hookdeck CLI, you can forward your events (e.g. webhooks) to your local web server with unlimited **free** and **permanent** event URLs. Your event history is preserved between sessions and can be viewed, replayed, or used for testing by you and your teammates.
|
|
8
8
|
|
|
9
9
|
Hookdeck CLI is compatible with most of Hookdeck's features, such as filtering and fan-out delivery. You can use Hookdeck CLI to develop or test your event (e.g. webhook) integration code locally.
|
|
10
10
|
|
|
11
11
|
Although it uses a different approach and philosophy, it's a replacement for ngrok and alternative HTTP tunnel solutions.
|
|
12
12
|
|
|
13
|
-
Hookdeck for development is completely free, and we monetize the platform with our
|
|
13
|
+
Hookdeck for development is completely free, and we monetize the platform with our production offering.
|
|
14
14
|
|
|
15
|
-
For a complete reference, see the [CLI reference](https://hookdeck.com/cli)
|
|
15
|
+
For a complete reference, see the [CLI reference](https://hookdeck.com/docs/cli?ref=github-hookdeck-cli).
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
https://github.com/user-attachments/assets/5fca7842-9c41-411c-8cd6-2f32f84fa907
|
|
18
18
|
|
|
19
19
|
## Installation
|
|
20
20
|
|
|
@@ -25,7 +25,7 @@ Hookdeck CLI is available for macOS, Windows, and Linux for distros like Ubuntu,
|
|
|
25
25
|
Hookdeck CLI is distributed as an NPM package:
|
|
26
26
|
|
|
27
27
|
```sh
|
|
28
|
-
npm install hookdeck -g
|
|
28
|
+
npm install hookdeck-cli -g
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
### macOS
|
|
@@ -45,7 +45,7 @@ scoop bucket add hookdeck https://github.com/hookdeck/scoop-hookdeck-cli.git
|
|
|
45
45
|
scoop install hookdeck
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
### Linux Or
|
|
48
|
+
### Linux Or without package managers
|
|
49
49
|
|
|
50
50
|
To install the Hookdeck CLI on Linux without a package manager:
|
|
51
51
|
|
|
@@ -112,7 +112,7 @@ Hookdeck works by routing events received for a given `source` (i.e., Shopify, G
|
|
|
112
112
|
|
|
113
113
|
Each `source` is assigned a Event URL, which you can use to receive events. When starting with a fresh account, the CLI will prompt you to create your first source. Each CLI process can listen to one source at a time.
|
|
114
114
|
|
|
115
|
-
Contrary to ngrok, **Hookdeck does not allow to append a path to your
|
|
115
|
+
Contrary to ngrok, **Hookdeck does not allow to append a path to your event URL**. Instead, the routing is done within Hookdeck configuration. This means you will also be prompted to specify your `destination` path, and you can have as many as you want per `source`.
|
|
116
116
|
|
|
117
117
|
> The `port-or-URL` param is mandatory, events will be forwarded to http://localhost:$PORT/$DESTINATION_PATH when inputing a valid port or your provided URL.
|
|
118
118
|
|
|
@@ -159,7 +159,7 @@ Inventory Service forwarding to /webhooks/shopify/inventory
|
|
|
159
159
|
|
|
160
160
|
#### Viewing and interacting with your events
|
|
161
161
|
|
|
162
|
-
Event logs for your CLI can be found at https://dashboard.hookdeck.com/cli/events. Events can be replayed or saved at any time.
|
|
162
|
+
Event logs for your CLI can be found at [https://dashboard.hookdeck.com/cli/events](https://dashboard.hookdeck.com/cli/events?ref=github-hookdeck-cli). Events can be replayed or saved at any time.
|
|
163
163
|
|
|
164
164
|
### Logout
|
|
165
165
|
|
package/bin/hookdeck
CHANGED
|
Binary file
|