hookdeck-cli 0.6.7 → 0.8.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 +62 -0
- package/bin/hookdeck +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -196,6 +196,68 @@ Configure auto-completion for Hookdeck CLI. It is run on install when using Home
|
|
|
196
196
|
hookdeck completion
|
|
197
197
|
```
|
|
198
198
|
|
|
199
|
+
### Running in CI
|
|
200
|
+
|
|
201
|
+
If you want to use Hookdeck in CI for tests or any other purposes, you can use your HOOKDECK_API_KEY to authenticate and start forwarding events.
|
|
202
|
+
|
|
203
|
+
```sh-session
|
|
204
|
+
$ hookdeck ci --api-key $HOOKDECK_API_KEY
|
|
205
|
+
Done! The Hookdeck CLI is configured in workspace MyWorkspace
|
|
206
|
+
|
|
207
|
+
$ hookdeck listen 3000 shopify orders
|
|
208
|
+
|
|
209
|
+
👉 Inspect and replay webhooks: https://dashboard.hookdeck.com/cli/events
|
|
210
|
+
|
|
211
|
+
Shopify Source
|
|
212
|
+
🔌 Webhook URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
|
|
213
|
+
|
|
214
|
+
Connections
|
|
215
|
+
Inventory Service forwarding to /webhooks/shopify/inventory
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
⣾ Getting ready...
|
|
219
|
+
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Manage active workspace
|
|
223
|
+
|
|
224
|
+
If you are a part of multiple workspaces, you can switch between them using our workspace management commands.
|
|
225
|
+
|
|
226
|
+
```sh-session
|
|
227
|
+
$ hookdeck workspace list
|
|
228
|
+
My Workspace (current)
|
|
229
|
+
Another Workspace
|
|
230
|
+
Yet Another One
|
|
231
|
+
|
|
232
|
+
$ hookdeck workspace use
|
|
233
|
+
Use the arrow keys to navigate: ↓ ↑ → ←
|
|
234
|
+
? Select Workspace:
|
|
235
|
+
My Workspace
|
|
236
|
+
Another Workspace
|
|
237
|
+
▸ Yet Another One
|
|
238
|
+
|
|
239
|
+
Selecting workspace Yet Another One
|
|
240
|
+
|
|
241
|
+
$ hookdeck whoami
|
|
242
|
+
Using profile default
|
|
243
|
+
Logged in as Me in workspace Yet Another One
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
You can also pin an active workspace in the current working directory with the `--local` flag.
|
|
247
|
+
|
|
248
|
+
```sh-session
|
|
249
|
+
$ hookdeck workspace use --local
|
|
250
|
+
Use the arrow keys to navigate: ↓ ↑ → ←
|
|
251
|
+
? Select Workspace:
|
|
252
|
+
My Workspace
|
|
253
|
+
Another Workspace
|
|
254
|
+
▸ Yet Another One
|
|
255
|
+
|
|
256
|
+
Selecting workspace Yet Another One
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
This will create a local config file in your current directory at `myproject/.hookdeck/config.toml`. Depending on your team's Hookdeck usage and workspace setup, you may or may not want to commit this configuration file to version control.
|
|
260
|
+
|
|
199
261
|
## Developing
|
|
200
262
|
|
|
201
263
|
Build from source by running:
|
package/bin/hookdeck
CHANGED
|
Binary file
|