You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(docs): regenerate REFERENCE.md from Cobra metadata
Run go run ./tools/generate-reference after connection example updates
so REFERENCE.md reflects hookdeck gateway connection in examples.
Made-with: Cursor
Copy file name to clipboardExpand all lines: REFERENCE.md
+86-42Lines changed: 86 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,12 +59,14 @@ hookdeck login [flags]
59
59
| Flag | Type | Description |
60
60
|------|------|-------------|
61
61
|`-i, --interactive`|`bool`| Run interactive configuration mode if you cannot open a browser |
62
+
|`--local`|`bool`| Save credentials to current directory (.hookdeck/config.toml) |
62
63
63
64
**Examples:**
64
65
65
66
```bash
66
67
$ hookdeck login
67
68
$ hookdeck login -i # interactive mode (no browser)
69
+
$ hookdeck login --local # save credentials to .hookdeck/config.toml
68
70
```
69
71
## Logout
70
72
@@ -103,8 +105,6 @@ hookdeck whoami
103
105
```bash
104
106
$ hookdeck whoami
105
107
```
106
-
107
-
Output includes the current project type (Gateway, Outpost, or Console).
108
108
<!-- GENERATE_END -->
109
109
## Projects
110
110
@@ -114,7 +114,7 @@ Output includes the current project type (Gateway, Outpost, or Console).
114
114
115
115
### hookdeck project list
116
116
117
-
List and filter projects by organization and project name substrings. Output shows project type (Gateway, Outpost, Console). Outbound projects are excluded from the list.
117
+
List and filter projects by organization and project name substrings
118
118
119
119
**Usage:**
120
120
@@ -126,16 +126,15 @@ hookdeck project list [<organization_substring>] [<project_substring>] [flags]
126
126
127
127
| Flag | Type | Description |
128
128
|------|------|-------------|
129
-
|`--output`|`string`| Output format: `json` for machine-readable list (id, org, project, type, current)|
130
-
|`--type`|`string`| Filter by project type: `gateway`, `outpost`, or `console`|
129
+
|`--output`|`string`| Output format: json |
130
+
|`--type`|`string`| Filter by project type: gateway, outpost, console |
131
131
132
132
**Examples:**
133
133
134
134
```bash
135
135
$ hookdeck project list
136
136
Acme / Ecommerce Production (current) | Gateway
137
137
Acme / Ecommerce Staging | Gateway
138
-
139
138
$ hookdeck project list --output json
140
139
$ hookdeck project list --type gateway
141
140
```
@@ -161,14 +160,11 @@ hookdeck project use [<organization_name> [<project_name>]] [flags]
161
160
$ hookdeck project use
162
161
Use the arrow keys to navigate: ↓ ↑ → ←
163
162
? Select Project:
164
-
▸ [Acme] Ecommerce Production
165
-
[Acme] Ecommerce Staging
166
-
[Acme] Ecommerce Development
167
-
168
-
Selecting project [Acme] Ecommerce Staging
163
+
▸ Acme / Ecommerce Production (current) | Gateway
164
+
Acme / Ecommerce Staging | Gateway
169
165
170
166
$ hookdeck project use --local
171
-
Pinning project [Acme] Ecommerce Staging to current directory
transformations, events, requests, metrics, and MCP server.
220
216
221
217
The gateway command group provides full access to all Event Gateway resources.
222
-
**Gateway commands require the current project to be a Gateway project** (inbound or console). If your project type is Outpost or you have no project selected, run `hookdeck project use` to switch to a Gateway project first.
223
218
224
219
**Usage:**
225
220
@@ -282,22 +277,22 @@ hookdeck gateway connection list [flags]
282
277
283
278
```bash
284
279
# List all connections
285
-
hookdeck connection list
280
+
hookdeck gateway connection list
286
281
287
282
# Filter by connection name
288
-
hookdeck connection list --name my-connection
283
+
hookdeck gateway connection list --name my-connection
289
284
290
285
# Filter by source ID
291
-
hookdeck connection list --source-id src_abc123
286
+
hookdeck gateway connection list --source-id src_abc123
292
287
293
288
# Filter by destination ID
294
-
hookdeck connection list --destination-id dst_def456
289
+
hookdeck gateway connection list --destination-id dst_def456
0 commit comments