@hyperdrive.bot/cli 1.0.2
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 +1598 -0
- package/bin/dev.cmd +3 -0
- package/bin/dev.js +3 -0
- package/bin/run.cmd +3 -0
- package/bin/run.js +5 -0
- package/dist/commands/account/add.d.ts +16 -0
- package/dist/commands/account/add.js +185 -0
- package/dist/commands/account/list.d.ts +6 -0
- package/dist/commands/account/list.js +37 -0
- package/dist/commands/account/remove.d.ts +11 -0
- package/dist/commands/account/remove.js +57 -0
- package/dist/commands/auth/login.d.ts +16 -0
- package/dist/commands/auth/login.js +178 -0
- package/dist/commands/auth/logout.d.ts +6 -0
- package/dist/commands/auth/logout.js +39 -0
- package/dist/commands/auth/refresh.d.ts +6 -0
- package/dist/commands/auth/refresh.js +66 -0
- package/dist/commands/auth/status.d.ts +6 -0
- package/dist/commands/auth/status.js +63 -0
- package/dist/commands/ci/account/create.d.ts +16 -0
- package/dist/commands/ci/account/create.js +158 -0
- package/dist/commands/ci/account/delete.d.ts +14 -0
- package/dist/commands/ci/account/delete.js +88 -0
- package/dist/commands/ci/account/list.d.ts +10 -0
- package/dist/commands/ci/account/list.js +65 -0
- package/dist/commands/config/get.d.ts +9 -0
- package/dist/commands/config/get.js +37 -0
- package/dist/commands/config/set.d.ts +10 -0
- package/dist/commands/config/set.js +48 -0
- package/dist/commands/config/show.d.ts +6 -0
- package/dist/commands/config/show.js +10 -0
- package/dist/commands/deployment/create.d.ts +30 -0
- package/dist/commands/deployment/create.js +188 -0
- package/dist/commands/deployment/get.d.ts +13 -0
- package/dist/commands/deployment/get.js +101 -0
- package/dist/commands/deployment/launch.d.ts +15 -0
- package/dist/commands/deployment/launch.js +105 -0
- package/dist/commands/deployment/list.d.ts +11 -0
- package/dist/commands/deployment/list.js +91 -0
- package/dist/commands/domain/current.d.ts +6 -0
- package/dist/commands/domain/current.js +18 -0
- package/dist/commands/domain/list.d.ts +6 -0
- package/dist/commands/domain/list.js +42 -0
- package/dist/commands/domain/switch.d.ts +9 -0
- package/dist/commands/domain/switch.js +40 -0
- package/dist/commands/example.d.ts +13 -0
- package/dist/commands/example.js +24 -0
- package/dist/commands/git/connect.d.ts +10 -0
- package/dist/commands/git/connect.js +56 -0
- package/dist/commands/git/disconnect.d.ts +11 -0
- package/dist/commands/git/disconnect.js +93 -0
- package/dist/commands/git/list.d.ts +10 -0
- package/dist/commands/git/list.js +53 -0
- package/dist/commands/git/sync.d.ts +18 -0
- package/dist/commands/git/sync.js +235 -0
- package/dist/commands/init.d.ts +188 -0
- package/dist/commands/init.js +817 -0
- package/dist/commands/jira/connect.d.ts +9 -0
- package/dist/commands/jira/connect.js +141 -0
- package/dist/commands/jira/status.d.ts +9 -0
- package/dist/commands/jira/status.js +118 -0
- package/dist/commands/module/analyze.d.ts +29 -0
- package/dist/commands/module/analyze.js +201 -0
- package/dist/commands/module/create.d.ts +42 -0
- package/dist/commands/module/create.js +498 -0
- package/dist/commands/module/destroy.d.ts +11 -0
- package/dist/commands/module/destroy.js +77 -0
- package/dist/commands/module/get.d.ts +10 -0
- package/dist/commands/module/get.js +43 -0
- package/dist/commands/module/link.d.ts +15 -0
- package/dist/commands/module/link.js +175 -0
- package/dist/commands/module/list.d.ts +9 -0
- package/dist/commands/module/list.js +51 -0
- package/dist/commands/module/reanalyze.d.ts +30 -0
- package/dist/commands/module/reanalyze.js +206 -0
- package/dist/commands/module/update.d.ts +27 -0
- package/dist/commands/module/update.js +102 -0
- package/dist/commands/parameter/add.d.ts +15 -0
- package/dist/commands/parameter/add.js +99 -0
- package/dist/commands/parameter/backfill.d.ts +12 -0
- package/dist/commands/parameter/backfill.js +113 -0
- package/dist/commands/parameter/clear.d.ts +14 -0
- package/dist/commands/parameter/clear.js +95 -0
- package/dist/commands/parameter/list.d.ts +14 -0
- package/dist/commands/parameter/list.js +92 -0
- package/dist/commands/parameter/pull.d.ts +14 -0
- package/dist/commands/parameter/pull.js +124 -0
- package/dist/commands/parameter/remove.d.ts +15 -0
- package/dist/commands/parameter/remove.js +90 -0
- package/dist/commands/parameter/sync.d.ts +14 -0
- package/dist/commands/parameter/sync.js +153 -0
- package/dist/commands/parameter/update.d.ts +15 -0
- package/dist/commands/parameter/update.js +100 -0
- package/dist/commands/stage/create.d.ts +28 -0
- package/dist/commands/stage/create.js +312 -0
- package/dist/commands/stage/list.d.ts +9 -0
- package/dist/commands/stage/list.js +63 -0
- package/dist/commands/test-api.d.ts +9 -0
- package/dist/commands/test-api.js +40 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/services/auth-service.d.ts +84 -0
- package/dist/services/auth-service.js +240 -0
- package/dist/services/git.d.ts +46 -0
- package/dist/services/git.js +409 -0
- package/dist/services/hyperdrive-sigv4.d.ts +449 -0
- package/dist/services/hyperdrive-sigv4.js +375 -0
- package/dist/services/hyperdrive.d.ts +87 -0
- package/dist/services/hyperdrive.js +108 -0
- package/dist/services/log-tailer.d.ts +95 -0
- package/dist/services/log-tailer.js +242 -0
- package/dist/services/tenant-service.d.ts +106 -0
- package/dist/services/tenant-service.js +332 -0
- package/dist/utils/account-flow.d.ts +74 -0
- package/dist/utils/account-flow.js +228 -0
- package/dist/utils/auth-flow.d.ts +146 -0
- package/dist/utils/auth-flow.js +477 -0
- package/dist/utils/git-flow.d.ts +72 -0
- package/dist/utils/git-flow.js +232 -0
- package/dist/utils/jira-flow.d.ts +71 -0
- package/dist/utils/jira-flow.js +120 -0
- package/dist/utils/summary-display.d.ts +59 -0
- package/dist/utils/summary-display.js +140 -0
- package/dist/utils/validation.d.ts +15 -0
- package/dist/utils/validation.js +32 -0
- package/oclif.manifest.json +2819 -0
- package/package.json +112 -0
package/README.md
ADDED
|
@@ -0,0 +1,1598 @@
|
|
|
1
|
+
hd
|
|
2
|
+
=================
|
|
3
|
+
|
|
4
|
+
hyperdrive.bot is a command-line interface (CLI) tool designed for managing and deploying projects using the Hyperdrive API. The CLI acts as a proxy to the Hyperdrive API, enabling users to:
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
[](https://oclif.io)
|
|
8
|
+
[](https://npmjs.org/package/hd)
|
|
9
|
+
[](https://npmjs.org/package/hd)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<!-- toc -->
|
|
13
|
+
* [Usage](#usage)
|
|
14
|
+
* [Commands](#commands)
|
|
15
|
+
<!-- tocstop -->
|
|
16
|
+
# Usage
|
|
17
|
+
<!-- usage -->
|
|
18
|
+
```sh-session
|
|
19
|
+
$ npm install -g @hyperdrive.bot/cli
|
|
20
|
+
$ hd COMMAND
|
|
21
|
+
running command...
|
|
22
|
+
$ hd (--version)
|
|
23
|
+
@hyperdrive.bot/cli/1.0.2 linux-x64 node-v18.20.8
|
|
24
|
+
$ hd --help [COMMAND]
|
|
25
|
+
USAGE
|
|
26
|
+
$ hd COMMAND
|
|
27
|
+
...
|
|
28
|
+
```
|
|
29
|
+
<!-- usagestop -->
|
|
30
|
+
# Commands
|
|
31
|
+
<!-- commands -->
|
|
32
|
+
* [`hd account add`](#hd-account-add)
|
|
33
|
+
* [`hd account list`](#hd-account-list)
|
|
34
|
+
* [`hd account remove`](#hd-account-remove)
|
|
35
|
+
* [`hd auth login`](#hd-auth-login)
|
|
36
|
+
* [`hd auth logout`](#hd-auth-logout)
|
|
37
|
+
* [`hd auth refresh`](#hd-auth-refresh)
|
|
38
|
+
* [`hd auth status`](#hd-auth-status)
|
|
39
|
+
* [`hd ci account create`](#hd-ci-account-create)
|
|
40
|
+
* [`hd ci account delete [ACCOUNTID]`](#hd-ci-account-delete-accountid)
|
|
41
|
+
* [`hd ci account list`](#hd-ci-account-list)
|
|
42
|
+
* [`hd config get KEY`](#hd-config-get-key)
|
|
43
|
+
* [`hd config set KEY VALUE`](#hd-config-set-key-value)
|
|
44
|
+
* [`hd config show`](#hd-config-show)
|
|
45
|
+
* [`hd deployment create`](#hd-deployment-create)
|
|
46
|
+
* [`hd deployment get`](#hd-deployment-get)
|
|
47
|
+
* [`hd deployment launch`](#hd-deployment-launch)
|
|
48
|
+
* [`hd deployment list`](#hd-deployment-list)
|
|
49
|
+
* [`hd domain current`](#hd-domain-current)
|
|
50
|
+
* [`hd domain list`](#hd-domain-list)
|
|
51
|
+
* [`hd domain switch DOMAIN`](#hd-domain-switch-domain)
|
|
52
|
+
* [`hd example [FILE]`](#hd-example-file)
|
|
53
|
+
* [`hd git connect`](#hd-git-connect)
|
|
54
|
+
* [`hd git disconnect`](#hd-git-disconnect)
|
|
55
|
+
* [`hd git list`](#hd-git-list)
|
|
56
|
+
* [`hd git sync`](#hd-git-sync)
|
|
57
|
+
* [`hd help [COMMAND]`](#hd-help-command)
|
|
58
|
+
* [`hd init`](#hd-init)
|
|
59
|
+
* [`hd jira connect`](#hd-jira-connect)
|
|
60
|
+
* [`hd jira status`](#hd-jira-status)
|
|
61
|
+
* [`hd module analyze`](#hd-module-analyze)
|
|
62
|
+
* [`hd module create`](#hd-module-create)
|
|
63
|
+
* [`hd module destroy`](#hd-module-destroy)
|
|
64
|
+
* [`hd module get`](#hd-module-get)
|
|
65
|
+
* [`hd module link`](#hd-module-link)
|
|
66
|
+
* [`hd module list`](#hd-module-list)
|
|
67
|
+
* [`hd module reanalyze`](#hd-module-reanalyze)
|
|
68
|
+
* [`hd module update`](#hd-module-update)
|
|
69
|
+
* [`hd parameter add`](#hd-parameter-add)
|
|
70
|
+
* [`hd parameter backfill`](#hd-parameter-backfill)
|
|
71
|
+
* [`hd parameter clear`](#hd-parameter-clear)
|
|
72
|
+
* [`hd parameter list`](#hd-parameter-list)
|
|
73
|
+
* [`hd parameter pull`](#hd-parameter-pull)
|
|
74
|
+
* [`hd parameter remove`](#hd-parameter-remove)
|
|
75
|
+
* [`hd parameter sync`](#hd-parameter-sync)
|
|
76
|
+
* [`hd parameter update`](#hd-parameter-update)
|
|
77
|
+
* [`hd plugins`](#hd-plugins)
|
|
78
|
+
* [`hd plugins add PLUGIN`](#hd-plugins-add-plugin)
|
|
79
|
+
* [`hd plugins:inspect PLUGIN...`](#hd-pluginsinspect-plugin)
|
|
80
|
+
* [`hd plugins install PLUGIN`](#hd-plugins-install-plugin)
|
|
81
|
+
* [`hd plugins link PATH`](#hd-plugins-link-path)
|
|
82
|
+
* [`hd plugins remove [PLUGIN]`](#hd-plugins-remove-plugin)
|
|
83
|
+
* [`hd plugins reset`](#hd-plugins-reset)
|
|
84
|
+
* [`hd plugins uninstall [PLUGIN]`](#hd-plugins-uninstall-plugin)
|
|
85
|
+
* [`hd plugins unlink [PLUGIN]`](#hd-plugins-unlink-plugin)
|
|
86
|
+
* [`hd plugins update`](#hd-plugins-update)
|
|
87
|
+
* [`hd stage create`](#hd-stage-create)
|
|
88
|
+
* [`hd stage list`](#hd-stage-list)
|
|
89
|
+
* [`hd test-api`](#hd-test-api)
|
|
90
|
+
|
|
91
|
+
## `hd account add`
|
|
92
|
+
|
|
93
|
+
Add an AWS account to Hyperdrive for deployments
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
USAGE
|
|
97
|
+
$ hd account add [-a <value>] [-r <value>] [-d <value>] [-n <value>] [--no-wait] [--roleArn <value>]
|
|
98
|
+
|
|
99
|
+
FLAGS
|
|
100
|
+
-a, --accountId=<value> AWS Account ID (12 digits)
|
|
101
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
102
|
+
-n, --name=<value> Friendly name for the account
|
|
103
|
+
-r, --defaultRegion=<value> Default AWS region for deployments
|
|
104
|
+
--no-wait Do not wait for role verification after opening CloudFormation
|
|
105
|
+
--roleArn=<value> Cross-account IAM role ARN (optional - will be auto-generated if not provided)
|
|
106
|
+
|
|
107
|
+
DESCRIPTION
|
|
108
|
+
Add an AWS account to Hyperdrive for deployments
|
|
109
|
+
|
|
110
|
+
EXAMPLES
|
|
111
|
+
$ hd account add --accountId 123456789012 --defaultRegion us-east-1
|
|
112
|
+
|
|
113
|
+
$ hd account add --accountId 123456789012 --defaultRegion us-east-1 --name "Production Account"
|
|
114
|
+
|
|
115
|
+
$ hd account add # Interactive mode
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
_See code: [src/commands/account/add.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/account/add.ts)_
|
|
119
|
+
|
|
120
|
+
## `hd account list`
|
|
121
|
+
|
|
122
|
+
List all AWS accounts registered with Hyperdrive
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
USAGE
|
|
126
|
+
$ hd account list
|
|
127
|
+
|
|
128
|
+
DESCRIPTION
|
|
129
|
+
List all AWS accounts registered with Hyperdrive
|
|
130
|
+
|
|
131
|
+
EXAMPLES
|
|
132
|
+
$ hd account list
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
_See code: [src/commands/account/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/account/list.ts)_
|
|
136
|
+
|
|
137
|
+
## `hd account remove`
|
|
138
|
+
|
|
139
|
+
Remove an AWS account from Hyperdrive
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
USAGE
|
|
143
|
+
$ hd account remove -a <value> [-d <value>] [-f]
|
|
144
|
+
|
|
145
|
+
FLAGS
|
|
146
|
+
-a, --accountId=<value> (required) AWS Account ID (12 digits)
|
|
147
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
148
|
+
-f, --force Skip confirmation prompt
|
|
149
|
+
|
|
150
|
+
DESCRIPTION
|
|
151
|
+
Remove an AWS account from Hyperdrive
|
|
152
|
+
|
|
153
|
+
EXAMPLES
|
|
154
|
+
$ hd account remove --accountId 123456789012
|
|
155
|
+
|
|
156
|
+
$ hd account remove --accountId 123456789012 --force
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
_See code: [src/commands/account/remove.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/account/remove.ts)_
|
|
160
|
+
|
|
161
|
+
## `hd auth login`
|
|
162
|
+
|
|
163
|
+
Authenticate with Hyperdrive using OAuth 2.0 PKCE flow (or CI credentials)
|
|
164
|
+
|
|
165
|
+
```
|
|
166
|
+
USAGE
|
|
167
|
+
$ hd auth login [--ci] [-d <value>] [-p <value>]
|
|
168
|
+
|
|
169
|
+
FLAGS
|
|
170
|
+
-d, --domain=<value> Tenant domain (e.g., acme.hyperdrive.bot) - allows multiple installations
|
|
171
|
+
-p, --port=<value> [default: 8765] Local callback server port
|
|
172
|
+
--ci Use CI authentication (requires HD_CI_USERNAME and HD_CI_PASSWORD env vars)
|
|
173
|
+
|
|
174
|
+
DESCRIPTION
|
|
175
|
+
Authenticate with Hyperdrive using OAuth 2.0 PKCE flow (or CI credentials)
|
|
176
|
+
|
|
177
|
+
EXAMPLES
|
|
178
|
+
$ hd auth login
|
|
179
|
+
|
|
180
|
+
$ hd auth login --domain acme.hyperdrive.bot
|
|
181
|
+
|
|
182
|
+
$ hd auth login --port 9876
|
|
183
|
+
|
|
184
|
+
$ hd auth login --ci --domain acme.hyperdrive.bot
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
_See code: [src/commands/auth/login.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/auth/login.ts)_
|
|
188
|
+
|
|
189
|
+
## `hd auth logout`
|
|
190
|
+
|
|
191
|
+
Remove stored credentials and logout
|
|
192
|
+
|
|
193
|
+
```
|
|
194
|
+
USAGE
|
|
195
|
+
$ hd auth logout
|
|
196
|
+
|
|
197
|
+
DESCRIPTION
|
|
198
|
+
Remove stored credentials and logout
|
|
199
|
+
|
|
200
|
+
EXAMPLES
|
|
201
|
+
$ hd auth logout
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
_See code: [src/commands/auth/logout.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/auth/logout.ts)_
|
|
205
|
+
|
|
206
|
+
## `hd auth refresh`
|
|
207
|
+
|
|
208
|
+
Refresh expired AWS credentials using refresh token
|
|
209
|
+
|
|
210
|
+
```
|
|
211
|
+
USAGE
|
|
212
|
+
$ hd auth refresh
|
|
213
|
+
|
|
214
|
+
DESCRIPTION
|
|
215
|
+
Refresh expired AWS credentials using refresh token
|
|
216
|
+
|
|
217
|
+
EXAMPLES
|
|
218
|
+
$ hd auth refresh
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
_See code: [src/commands/auth/refresh.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/auth/refresh.ts)_
|
|
222
|
+
|
|
223
|
+
## `hd auth status`
|
|
224
|
+
|
|
225
|
+
Show current authentication status
|
|
226
|
+
|
|
227
|
+
```
|
|
228
|
+
USAGE
|
|
229
|
+
$ hd auth status
|
|
230
|
+
|
|
231
|
+
DESCRIPTION
|
|
232
|
+
Show current authentication status
|
|
233
|
+
|
|
234
|
+
EXAMPLES
|
|
235
|
+
$ hd auth status
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
_See code: [src/commands/auth/status.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/auth/status.ts)_
|
|
239
|
+
|
|
240
|
+
## `hd ci account create`
|
|
241
|
+
|
|
242
|
+
Create a CI token for non-interactive authentication in CI/CD pipelines
|
|
243
|
+
|
|
244
|
+
```
|
|
245
|
+
USAGE
|
|
246
|
+
$ hd ci account create [--description <value>] [-d <value>] [-n <value>] [--project <value>] [-s
|
|
247
|
+
deploy|deploy:create|deploy:launch|module:read|module:write|parameter:read|parameter:write|stage:read|stage:write]
|
|
248
|
+
[--stage <value>]
|
|
249
|
+
|
|
250
|
+
FLAGS
|
|
251
|
+
-d, --domain=<value> Tenant domain
|
|
252
|
+
-n, --name=<value> Name for the CI account (e.g., github-prod, gitlab-staging)
|
|
253
|
+
-s, --scope=<option>... Scopes to grant (can be specified multiple times)
|
|
254
|
+
<options: deploy|deploy:create|deploy:launch|module:read|module:write|parameter:read|parame
|
|
255
|
+
ter:write|stage:read|stage:write>
|
|
256
|
+
--description=<value> Optional description for the CI account
|
|
257
|
+
--project=<value>... Restrict to specific project slugs (can be specified multiple times)
|
|
258
|
+
--stage=<value>... Restrict to specific stages (can be specified multiple times)
|
|
259
|
+
|
|
260
|
+
DESCRIPTION
|
|
261
|
+
Create a CI token for non-interactive authentication in CI/CD pipelines
|
|
262
|
+
|
|
263
|
+
EXAMPLES
|
|
264
|
+
$ hd ci account create --name="github-prod" --scope=deploy --scope=module:read
|
|
265
|
+
|
|
266
|
+
$ hd ci account create --name="gitlab-staging" --scope=deploy --scope=parameter:read
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
_See code: [src/commands/ci/account/create.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/ci/account/create.ts)_
|
|
270
|
+
|
|
271
|
+
## `hd ci account delete [ACCOUNTID]`
|
|
272
|
+
|
|
273
|
+
Delete (revoke) a CI token
|
|
274
|
+
|
|
275
|
+
```
|
|
276
|
+
USAGE
|
|
277
|
+
$ hd ci account delete [ACCOUNTID] [-d <value>] [-f]
|
|
278
|
+
|
|
279
|
+
ARGUMENTS
|
|
280
|
+
ACCOUNTID CI token ID to delete
|
|
281
|
+
|
|
282
|
+
FLAGS
|
|
283
|
+
-d, --domain=<value> Tenant domain
|
|
284
|
+
-f, --force Skip confirmation prompt
|
|
285
|
+
|
|
286
|
+
DESCRIPTION
|
|
287
|
+
Delete (revoke) a CI token
|
|
288
|
+
|
|
289
|
+
EXAMPLES
|
|
290
|
+
$ hd ci account delete <account-id>
|
|
291
|
+
|
|
292
|
+
$ hd ci account delete <account-id> --force
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
_See code: [src/commands/ci/account/delete.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/ci/account/delete.ts)_
|
|
296
|
+
|
|
297
|
+
## `hd ci account list`
|
|
298
|
+
|
|
299
|
+
List all CI tokens
|
|
300
|
+
|
|
301
|
+
```
|
|
302
|
+
USAGE
|
|
303
|
+
$ hd ci account list [-d <value>] [--json]
|
|
304
|
+
|
|
305
|
+
FLAGS
|
|
306
|
+
-d, --domain=<value> Tenant domain
|
|
307
|
+
--json Output as JSON
|
|
308
|
+
|
|
309
|
+
DESCRIPTION
|
|
310
|
+
List all CI tokens
|
|
311
|
+
|
|
312
|
+
EXAMPLES
|
|
313
|
+
$ hd ci account list
|
|
314
|
+
|
|
315
|
+
$ hd ci account list --json
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
_See code: [src/commands/ci/account/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/ci/account/list.ts)_
|
|
319
|
+
|
|
320
|
+
## `hd config get KEY`
|
|
321
|
+
|
|
322
|
+
Get CLI configuration value
|
|
323
|
+
|
|
324
|
+
```
|
|
325
|
+
USAGE
|
|
326
|
+
$ hd config get KEY
|
|
327
|
+
|
|
328
|
+
ARGUMENTS
|
|
329
|
+
KEY (tenant-domain|bootstrap-url|api-url|region) Configuration key
|
|
330
|
+
|
|
331
|
+
DESCRIPTION
|
|
332
|
+
Get CLI configuration value
|
|
333
|
+
|
|
334
|
+
EXAMPLES
|
|
335
|
+
$ hd config get tenant-domain
|
|
336
|
+
|
|
337
|
+
$ hd config get bootstrap-url
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
_See code: [src/commands/config/get.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/config/get.ts)_
|
|
341
|
+
|
|
342
|
+
## `hd config set KEY VALUE`
|
|
343
|
+
|
|
344
|
+
Set CLI configuration values
|
|
345
|
+
|
|
346
|
+
```
|
|
347
|
+
USAGE
|
|
348
|
+
$ hd config set KEY VALUE
|
|
349
|
+
|
|
350
|
+
ARGUMENTS
|
|
351
|
+
KEY (tenant-domain|bootstrap-url|api-url|region) Configuration key
|
|
352
|
+
VALUE Configuration value
|
|
353
|
+
|
|
354
|
+
DESCRIPTION
|
|
355
|
+
Set CLI configuration values
|
|
356
|
+
|
|
357
|
+
EXAMPLES
|
|
358
|
+
$ hd config set tenant-domain acme.hyperdrive.bot
|
|
359
|
+
|
|
360
|
+
$ hd config set bootstrap-url https://custom-api.example.com/tenant/bootstrap
|
|
361
|
+
|
|
362
|
+
$ hd config set api-url https://api.us-east-1.hyperdrive.bot
|
|
363
|
+
|
|
364
|
+
$ hd config set region us-west-2
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
_See code: [src/commands/config/set.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/config/set.ts)_
|
|
368
|
+
|
|
369
|
+
## `hd config show`
|
|
370
|
+
|
|
371
|
+
Show all CLI configuration settings
|
|
372
|
+
|
|
373
|
+
```
|
|
374
|
+
USAGE
|
|
375
|
+
$ hd config show
|
|
376
|
+
|
|
377
|
+
DESCRIPTION
|
|
378
|
+
Show all CLI configuration settings
|
|
379
|
+
|
|
380
|
+
EXAMPLES
|
|
381
|
+
$ hd config show
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
_See code: [src/commands/config/show.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/config/show.ts)_
|
|
385
|
+
|
|
386
|
+
## `hd deployment create`
|
|
387
|
+
|
|
388
|
+
Create a new deployment with real-time log streaming
|
|
389
|
+
|
|
390
|
+
```
|
|
391
|
+
USAGE
|
|
392
|
+
$ hd deployment create -c <value> -m <value> -s <value> [--debug] [-d <value>] [--launch] [-n <value>] [--noStream]
|
|
393
|
+
[-r <value>] [-v]
|
|
394
|
+
|
|
395
|
+
FLAGS
|
|
396
|
+
-c, --commit=<value> (required) Commit hash
|
|
397
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
398
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
399
|
+
-n, --name=<value> [default: Deployment-2026-01-18-11-46-30] The name of the deployment
|
|
400
|
+
-r, --regions=<value>... [default: ] Regions for the deployment
|
|
401
|
+
-s, --stage=<value> (required) Stage for the deployment
|
|
402
|
+
-v, --verbose Show detailed build logs
|
|
403
|
+
--debug Include debug-level logs (requires --verbose)
|
|
404
|
+
--launch Launch the deployment after creating it
|
|
405
|
+
--noStream Disable log streaming (use polling instead)
|
|
406
|
+
|
|
407
|
+
DESCRIPTION
|
|
408
|
+
Create a new deployment with real-time log streaming
|
|
409
|
+
|
|
410
|
+
EXAMPLES
|
|
411
|
+
$ hd deployment create --stage="dev" --commit="abc123" --moduleSlug="my-api"
|
|
412
|
+
|
|
413
|
+
$ hd deployment create --stage="dev" --commit="abc123" --launch
|
|
414
|
+
|
|
415
|
+
$ hd deployment create --stage="dev" --commit="abc123" --verbose
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
_See code: [src/commands/deployment/create.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/deployment/create.ts)_
|
|
419
|
+
|
|
420
|
+
## `hd deployment get`
|
|
421
|
+
|
|
422
|
+
Get details of a specific deployment (alias for deployment check)
|
|
423
|
+
|
|
424
|
+
```
|
|
425
|
+
USAGE
|
|
426
|
+
$ hd deployment get -m <value> -n <value> -s <value> [-d <value>]
|
|
427
|
+
|
|
428
|
+
FLAGS
|
|
429
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
430
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
431
|
+
-n, --name=<value> (required) Deployment name
|
|
432
|
+
-s, --stage=<value> (required) Stage for the deployment
|
|
433
|
+
|
|
434
|
+
DESCRIPTION
|
|
435
|
+
Get details of a specific deployment (alias for deployment check)
|
|
436
|
+
|
|
437
|
+
EXAMPLES
|
|
438
|
+
$ hd deployment get --name="Deployment-2024-01-01" --stage="dev"
|
|
439
|
+
|
|
440
|
+
$ hd deployment get --name="prod-release-v1" --stage="prod"
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
_See code: [src/commands/deployment/get.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/deployment/get.ts)_
|
|
444
|
+
|
|
445
|
+
## `hd deployment launch`
|
|
446
|
+
|
|
447
|
+
Launch an existing deployment
|
|
448
|
+
|
|
449
|
+
```
|
|
450
|
+
USAGE
|
|
451
|
+
$ hd deployment launch -m <value> -n <value> -s <value> [-d <value>] [-f] [-r <value>]
|
|
452
|
+
|
|
453
|
+
FLAGS
|
|
454
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
455
|
+
-f, --force Force launch even if deployment is not in ready state
|
|
456
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
457
|
+
-n, --name=<value> (required) The name of the deployment to launch
|
|
458
|
+
-r, --region=<value> Region for the deployment
|
|
459
|
+
-s, --stage=<value> (required) Stage for the deployment
|
|
460
|
+
|
|
461
|
+
DESCRIPTION
|
|
462
|
+
Launch an existing deployment
|
|
463
|
+
|
|
464
|
+
EXAMPLES
|
|
465
|
+
$ hd deployment launch --name="Deployment-2024-01-01" --stage="dev" --region="us-east-1"
|
|
466
|
+
|
|
467
|
+
$ hd deployment launch --name="prod-release" --stage="prod" --region="us-west-2"
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
_See code: [src/commands/deployment/launch.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/deployment/launch.ts)_
|
|
471
|
+
|
|
472
|
+
## `hd deployment list`
|
|
473
|
+
|
|
474
|
+
List all deployments for a module and stage
|
|
475
|
+
|
|
476
|
+
```
|
|
477
|
+
USAGE
|
|
478
|
+
$ hd deployment list -m <value> -s <value> [-d <value>]
|
|
479
|
+
|
|
480
|
+
FLAGS
|
|
481
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
482
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
483
|
+
-s, --stage=<value> (required) Stage to list deployments for
|
|
484
|
+
|
|
485
|
+
DESCRIPTION
|
|
486
|
+
List all deployments for a module and stage
|
|
487
|
+
|
|
488
|
+
EXAMPLES
|
|
489
|
+
$ hd deployment list --stage="dev"
|
|
490
|
+
|
|
491
|
+
$ hd deployment list --stage="prod" --moduleSlug="my-api"
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
_See code: [src/commands/deployment/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/deployment/list.ts)_
|
|
495
|
+
|
|
496
|
+
## `hd domain current`
|
|
497
|
+
|
|
498
|
+
Show the current default domain
|
|
499
|
+
|
|
500
|
+
```
|
|
501
|
+
USAGE
|
|
502
|
+
$ hd domain current
|
|
503
|
+
|
|
504
|
+
DESCRIPTION
|
|
505
|
+
Show the current default domain
|
|
506
|
+
|
|
507
|
+
EXAMPLES
|
|
508
|
+
$ hd domain current
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
_See code: [src/commands/domain/current.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/domain/current.ts)_
|
|
512
|
+
|
|
513
|
+
## `hd domain list`
|
|
514
|
+
|
|
515
|
+
List all configured domains/installations
|
|
516
|
+
|
|
517
|
+
```
|
|
518
|
+
USAGE
|
|
519
|
+
$ hd domain list
|
|
520
|
+
|
|
521
|
+
DESCRIPTION
|
|
522
|
+
List all configured domains/installations
|
|
523
|
+
|
|
524
|
+
EXAMPLES
|
|
525
|
+
$ hd domain list
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
_See code: [src/commands/domain/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/domain/list.ts)_
|
|
529
|
+
|
|
530
|
+
## `hd domain switch DOMAIN`
|
|
531
|
+
|
|
532
|
+
Switch the default domain for CLI commands
|
|
533
|
+
|
|
534
|
+
```
|
|
535
|
+
USAGE
|
|
536
|
+
$ hd domain switch DOMAIN
|
|
537
|
+
|
|
538
|
+
ARGUMENTS
|
|
539
|
+
DOMAIN The domain to set as default
|
|
540
|
+
|
|
541
|
+
DESCRIPTION
|
|
542
|
+
Switch the default domain for CLI commands
|
|
543
|
+
|
|
544
|
+
EXAMPLES
|
|
545
|
+
$ hd domain switch acme.hyperdrive.bot
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
_See code: [src/commands/domain/switch.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/domain/switch.ts)_
|
|
549
|
+
|
|
550
|
+
## `hd example [FILE]`
|
|
551
|
+
|
|
552
|
+
describe the command here
|
|
553
|
+
|
|
554
|
+
```
|
|
555
|
+
USAGE
|
|
556
|
+
$ hd example [FILE] [-f] [-n <value>]
|
|
557
|
+
|
|
558
|
+
ARGUMENTS
|
|
559
|
+
FILE file to read
|
|
560
|
+
|
|
561
|
+
FLAGS
|
|
562
|
+
-f, --force
|
|
563
|
+
-n, --name=<value> name to print
|
|
564
|
+
|
|
565
|
+
DESCRIPTION
|
|
566
|
+
describe the command here
|
|
567
|
+
|
|
568
|
+
EXAMPLES
|
|
569
|
+
$ hd example
|
|
570
|
+
```
|
|
571
|
+
|
|
572
|
+
_See code: [src/commands/example.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/example.ts)_
|
|
573
|
+
|
|
574
|
+
## `hd git connect`
|
|
575
|
+
|
|
576
|
+
Connect a GitHub or GitLab account to Hyperdrive
|
|
577
|
+
|
|
578
|
+
```
|
|
579
|
+
USAGE
|
|
580
|
+
$ hd git connect [-d <value>] [-p github|gitlab]
|
|
581
|
+
|
|
582
|
+
FLAGS
|
|
583
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
584
|
+
-p, --provider=<option> Git provider to connect
|
|
585
|
+
<options: github|gitlab>
|
|
586
|
+
|
|
587
|
+
DESCRIPTION
|
|
588
|
+
Connect a GitHub or GitLab account to Hyperdrive
|
|
589
|
+
|
|
590
|
+
EXAMPLES
|
|
591
|
+
$ hd git connect --provider=github
|
|
592
|
+
|
|
593
|
+
$ hd git connect --provider=gitlab
|
|
594
|
+
```
|
|
595
|
+
|
|
596
|
+
_See code: [src/commands/git/connect.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/git/connect.ts)_
|
|
597
|
+
|
|
598
|
+
## `hd git disconnect`
|
|
599
|
+
|
|
600
|
+
Disconnect a Git account from Hyperdrive
|
|
601
|
+
|
|
602
|
+
```
|
|
603
|
+
USAGE
|
|
604
|
+
$ hd git disconnect [-d <value>] [-i <value>] [-p github|gitlab]
|
|
605
|
+
|
|
606
|
+
FLAGS
|
|
607
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
608
|
+
-i, --installationId=<value> Installation ID to disconnect
|
|
609
|
+
-p, --provider=<option> Git provider
|
|
610
|
+
<options: github|gitlab>
|
|
611
|
+
|
|
612
|
+
DESCRIPTION
|
|
613
|
+
Disconnect a Git account from Hyperdrive
|
|
614
|
+
|
|
615
|
+
EXAMPLES
|
|
616
|
+
$ hd git disconnect
|
|
617
|
+
|
|
618
|
+
$ hd git disconnect --provider=github --installation-id=12345
|
|
619
|
+
```
|
|
620
|
+
|
|
621
|
+
_See code: [src/commands/git/disconnect.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/git/disconnect.ts)_
|
|
622
|
+
|
|
623
|
+
## `hd git list`
|
|
624
|
+
|
|
625
|
+
List connected Git accounts
|
|
626
|
+
|
|
627
|
+
```
|
|
628
|
+
USAGE
|
|
629
|
+
$ hd git list [-d <value>] [-p github|gitlab]
|
|
630
|
+
|
|
631
|
+
FLAGS
|
|
632
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
633
|
+
-p, --provider=<option> Filter by Git provider
|
|
634
|
+
<options: github|gitlab>
|
|
635
|
+
|
|
636
|
+
DESCRIPTION
|
|
637
|
+
List connected Git accounts
|
|
638
|
+
|
|
639
|
+
EXAMPLES
|
|
640
|
+
$ hd git list
|
|
641
|
+
|
|
642
|
+
$ hd git list --provider=github
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
_See code: [src/commands/git/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/git/list.ts)_
|
|
646
|
+
|
|
647
|
+
## `hd git sync`
|
|
648
|
+
|
|
649
|
+
Sync specific branches or all open branches with a source branch (default: master)
|
|
650
|
+
|
|
651
|
+
```
|
|
652
|
+
USAGE
|
|
653
|
+
$ hd git sync [-a] [-b <value>] [-d <value>] [-m no-ff|--ff-only|--no-ff|--squash] [-r <value>] [-s <value>]
|
|
654
|
+
[-v]
|
|
655
|
+
|
|
656
|
+
FLAGS
|
|
657
|
+
-a, --all Sync all remote branches
|
|
658
|
+
-b, --branch=<value>... Specific branch(es) to sync (can be used multiple times)
|
|
659
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
660
|
+
-m, --merge-strategy=<option> [default: no-ff] Git merge strategy
|
|
661
|
+
<options: no-ff|--ff-only|--no-ff|--squash>
|
|
662
|
+
-r, --remote=<value> [default: origin] Remote repository name
|
|
663
|
+
-s, --source-branch=<value> [default: master] Source branch to merge from
|
|
664
|
+
-v, --verbose Show detailed progress information
|
|
665
|
+
|
|
666
|
+
DESCRIPTION
|
|
667
|
+
Sync specific branches or all open branches with a source branch (default: master)
|
|
668
|
+
|
|
669
|
+
EXAMPLES
|
|
670
|
+
$ hd git sync --branch feature-branch
|
|
671
|
+
|
|
672
|
+
$ hd git sync --branch feature-1 --branch feature-2
|
|
673
|
+
|
|
674
|
+
$ hd git sync --all
|
|
675
|
+
|
|
676
|
+
$ hd git sync --branch feature-branch --source-branch main
|
|
677
|
+
|
|
678
|
+
$ hd git sync --all --remote upstream --merge-strategy no-ff
|
|
679
|
+
```
|
|
680
|
+
|
|
681
|
+
_See code: [src/commands/git/sync.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/git/sync.ts)_
|
|
682
|
+
|
|
683
|
+
## `hd help [COMMAND]`
|
|
684
|
+
|
|
685
|
+
Display help for hd.
|
|
686
|
+
|
|
687
|
+
```
|
|
688
|
+
USAGE
|
|
689
|
+
$ hd help [COMMAND...] [-n]
|
|
690
|
+
|
|
691
|
+
ARGUMENTS
|
|
692
|
+
COMMAND... Command to show help for.
|
|
693
|
+
|
|
694
|
+
FLAGS
|
|
695
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
696
|
+
|
|
697
|
+
DESCRIPTION
|
|
698
|
+
Display help for hd.
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
|
|
702
|
+
|
|
703
|
+
## `hd init`
|
|
704
|
+
|
|
705
|
+
Initialize Hyperdrive CLI with guided setup wizard
|
|
706
|
+
|
|
707
|
+
```
|
|
708
|
+
USAGE
|
|
709
|
+
$ hd init
|
|
710
|
+
|
|
711
|
+
DESCRIPTION
|
|
712
|
+
Initialize Hyperdrive CLI with guided setup wizard
|
|
713
|
+
|
|
714
|
+
EXAMPLES
|
|
715
|
+
$ hd init
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
_See code: [src/commands/init.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/init.ts)_
|
|
719
|
+
|
|
720
|
+
## `hd jira connect`
|
|
721
|
+
|
|
722
|
+
Register your Jira instance with Hyperdrive (run BEFORE installing the Forge app)
|
|
723
|
+
|
|
724
|
+
```
|
|
725
|
+
USAGE
|
|
726
|
+
$ hd jira connect [-d <value>]
|
|
727
|
+
|
|
728
|
+
FLAGS
|
|
729
|
+
-d, --domain=<value> Your Jira domain (e.g., dev-squad.atlassian.net)
|
|
730
|
+
|
|
731
|
+
DESCRIPTION
|
|
732
|
+
Register your Jira instance with Hyperdrive (run BEFORE installing the Forge app)
|
|
733
|
+
|
|
734
|
+
EXAMPLES
|
|
735
|
+
$ hd jira connect
|
|
736
|
+
|
|
737
|
+
$ hd jira connect --domain dev-squad.atlassian.net
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
_See code: [src/commands/jira/connect.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/jira/connect.ts)_
|
|
741
|
+
|
|
742
|
+
## `hd jira status`
|
|
743
|
+
|
|
744
|
+
Check the status of your Jira integration
|
|
745
|
+
|
|
746
|
+
```
|
|
747
|
+
USAGE
|
|
748
|
+
$ hd jira status [-d <value>]
|
|
749
|
+
|
|
750
|
+
FLAGS
|
|
751
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
752
|
+
|
|
753
|
+
DESCRIPTION
|
|
754
|
+
Check the status of your Jira integration
|
|
755
|
+
|
|
756
|
+
EXAMPLES
|
|
757
|
+
$ hd jira status
|
|
758
|
+
```
|
|
759
|
+
|
|
760
|
+
_See code: [src/commands/jira/status.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/jira/status.ts)_
|
|
761
|
+
|
|
762
|
+
## `hd module analyze`
|
|
763
|
+
|
|
764
|
+
Analyze a module and generate an optimized Dockerfile using AI
|
|
765
|
+
|
|
766
|
+
```
|
|
767
|
+
USAGE
|
|
768
|
+
$ hd module analyze -s <value> [-d <value>] [--save] [-v] [-w]
|
|
769
|
+
|
|
770
|
+
FLAGS
|
|
771
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
772
|
+
-s, --slug=<value> (required) Module slug to analyze
|
|
773
|
+
-v, --verbose Show detailed analysis progress and real-time logs
|
|
774
|
+
-w, --wait Wait for analysis to complete and show results
|
|
775
|
+
--save Save generated Dockerfile to current directory
|
|
776
|
+
|
|
777
|
+
DESCRIPTION
|
|
778
|
+
Analyze a module and generate an optimized Dockerfile using AI
|
|
779
|
+
|
|
780
|
+
EXAMPLES
|
|
781
|
+
$ hd module analyze --slug="my-module"
|
|
782
|
+
|
|
783
|
+
$ hd module analyze
|
|
784
|
+
|
|
785
|
+
$ hd module analyze --slug="my-module" --verbose
|
|
786
|
+
```
|
|
787
|
+
|
|
788
|
+
_See code: [src/commands/module/analyze.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/analyze.ts)_
|
|
789
|
+
|
|
790
|
+
## `hd module create`
|
|
791
|
+
|
|
792
|
+
Create a new project
|
|
793
|
+
|
|
794
|
+
```
|
|
795
|
+
USAGE
|
|
796
|
+
$ hd module create [--buildCommand <value>] [--buildDirectory <value>] [--buildFolder <value>] [--buildRuntime
|
|
797
|
+
nodejs|python|go|rust|java|dotnet|ruby] [--buildRuntimeVersion <value>] [--ciService
|
|
798
|
+
github-actions|gitlab-ci|circle-ci|jenkins] [--defaultBranch <value>] [-d <value>] [--framework
|
|
799
|
+
express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|gin|actix|spring|aspnet|rails|other]
|
|
800
|
+
[--installCommand <value>] [--name <value>] [--runCommand <value>] [-r nodejs|python|go|rust|java|dotnet|ruby]
|
|
801
|
+
[--runtimeVersion <value>] [--slug <value>] [--sourceDirectory <value>] [--sourceLocation <value>]
|
|
802
|
+
|
|
803
|
+
FLAGS
|
|
804
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
805
|
+
-r, --runtime=<option> Runtime environment
|
|
806
|
+
<options: nodejs|python|go|rust|java|dotnet|ruby>
|
|
807
|
+
--buildCommand=<value> Build command
|
|
808
|
+
--buildDirectory=<value> Build output directory (e.g., dist, build, .next) - where compiled artifacts are
|
|
809
|
+
output
|
|
810
|
+
--buildFolder=<value> Build folder
|
|
811
|
+
--buildRuntime=<option> Build runtime for Dockerfile template selection
|
|
812
|
+
<options: nodejs|python|go|rust|java|dotnet|ruby>
|
|
813
|
+
--buildRuntimeVersion=<value> Build runtime version (e.g., 20 for Node, 3.12 for Python)
|
|
814
|
+
--ciService=<option> CI service used
|
|
815
|
+
<options: github-actions|gitlab-ci|circle-ci|jenkins>
|
|
816
|
+
--defaultBranch=<value> Default git branch to branch from (e.g., main, master)
|
|
817
|
+
--framework=<option> Framework used
|
|
818
|
+
<options: express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|
|
|
819
|
+
gin|actix|spring|aspnet|rails|other>
|
|
820
|
+
--installCommand=<value> Install command
|
|
821
|
+
--name=<value> Name of the project
|
|
822
|
+
--runCommand=<value> Run command
|
|
823
|
+
--runtimeVersion=<value> Runtime version (e.g., 20, 3.12, 1.21)
|
|
824
|
+
--slug=<value> Slug of the project
|
|
825
|
+
--sourceDirectory=<value> Source code directory (e.g., src, lib, . for root) - default: src for Lambda, . for
|
|
826
|
+
static
|
|
827
|
+
--sourceLocation=<value> Source location of the project
|
|
828
|
+
|
|
829
|
+
DESCRIPTION
|
|
830
|
+
Create a new project
|
|
831
|
+
|
|
832
|
+
EXAMPLES
|
|
833
|
+
$ hd module create --name="New Project" --slug="project-slug"
|
|
834
|
+
|
|
835
|
+
$ hd module create --name="API Service" --framework="Serverless Framework"
|
|
836
|
+
```
|
|
837
|
+
|
|
838
|
+
_See code: [src/commands/module/create.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/create.ts)_
|
|
839
|
+
|
|
840
|
+
## `hd module destroy`
|
|
841
|
+
|
|
842
|
+
Destroy/delete a module permanently
|
|
843
|
+
|
|
844
|
+
```
|
|
845
|
+
USAGE
|
|
846
|
+
$ hd module destroy -s <value> [-d <value>] [-f]
|
|
847
|
+
|
|
848
|
+
FLAGS
|
|
849
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
850
|
+
-f, --force Skip confirmation prompt (DANGEROUS)
|
|
851
|
+
-s, --slug=<value> (required) Module slug to destroy
|
|
852
|
+
|
|
853
|
+
DESCRIPTION
|
|
854
|
+
Destroy/delete a module permanently
|
|
855
|
+
|
|
856
|
+
EXAMPLES
|
|
857
|
+
$ hd module destroy --slug="my-module"
|
|
858
|
+
|
|
859
|
+
$ hd module destroy --slug="old-project" --force
|
|
860
|
+
```
|
|
861
|
+
|
|
862
|
+
_See code: [src/commands/module/destroy.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/destroy.ts)_
|
|
863
|
+
|
|
864
|
+
## `hd module get`
|
|
865
|
+
|
|
866
|
+
Get details of a specific module/project
|
|
867
|
+
|
|
868
|
+
```
|
|
869
|
+
USAGE
|
|
870
|
+
$ hd module get -s <value> [-d <value>]
|
|
871
|
+
|
|
872
|
+
FLAGS
|
|
873
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
874
|
+
-s, --slug=<value> (required) Module slug to get details for
|
|
875
|
+
|
|
876
|
+
DESCRIPTION
|
|
877
|
+
Get details of a specific module/project
|
|
878
|
+
|
|
879
|
+
EXAMPLES
|
|
880
|
+
$ hd module get --slug="my-module"
|
|
881
|
+
|
|
882
|
+
$ hd module get
|
|
883
|
+
```
|
|
884
|
+
|
|
885
|
+
_See code: [src/commands/module/get.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/get.ts)_
|
|
886
|
+
|
|
887
|
+
## `hd module link`
|
|
888
|
+
|
|
889
|
+
Links two modules using specified environment variables as connectors
|
|
890
|
+
|
|
891
|
+
```
|
|
892
|
+
USAGE
|
|
893
|
+
$ hd module link --originSlug <value> --parameter <value> --targetSlug <value> [-d <value>]
|
|
894
|
+
|
|
895
|
+
FLAGS
|
|
896
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
897
|
+
--originSlug=<value> (required) Slug of the origin module (the one that depends on another)
|
|
898
|
+
--parameter=<value>... (required) Environment variable to link (e.g., API_URL)
|
|
899
|
+
--targetSlug=<value> (required) Slug of the target module (the dependency)
|
|
900
|
+
|
|
901
|
+
DESCRIPTION
|
|
902
|
+
Links two modules using specified environment variables as connectors
|
|
903
|
+
|
|
904
|
+
EXAMPLES
|
|
905
|
+
$ hd module link --originSlug="vixting-integration" --targetSlug="vixting-api" --parameter="VLOW_API_ENDPOINT_PREFIX"
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
_See code: [src/commands/module/link.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/link.ts)_
|
|
909
|
+
|
|
910
|
+
## `hd module list`
|
|
911
|
+
|
|
912
|
+
List all modules/projects
|
|
913
|
+
|
|
914
|
+
```
|
|
915
|
+
USAGE
|
|
916
|
+
$ hd module list [-d <value>]
|
|
917
|
+
|
|
918
|
+
FLAGS
|
|
919
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
920
|
+
|
|
921
|
+
DESCRIPTION
|
|
922
|
+
List all modules/projects
|
|
923
|
+
|
|
924
|
+
EXAMPLES
|
|
925
|
+
$ hd module list
|
|
926
|
+
```
|
|
927
|
+
|
|
928
|
+
_See code: [src/commands/module/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/list.ts)_
|
|
929
|
+
|
|
930
|
+
## `hd module reanalyze`
|
|
931
|
+
|
|
932
|
+
Reanalyze a module's Dockerfile with custom instructions
|
|
933
|
+
|
|
934
|
+
```
|
|
935
|
+
USAGE
|
|
936
|
+
$ hd module reanalyze -p <value> -s <value> [-d <value>] [--save] [-v] [-w]
|
|
937
|
+
|
|
938
|
+
FLAGS
|
|
939
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
940
|
+
-p, --prompt=<value> (required) Custom instructions for Dockerfile regeneration
|
|
941
|
+
-s, --slug=<value> (required) Module slug to reanalyze
|
|
942
|
+
-v, --verbose Show detailed analysis progress and real-time logs
|
|
943
|
+
-w, --wait Wait for reanalysis to complete and show results
|
|
944
|
+
--save Save generated Dockerfile to current directory
|
|
945
|
+
|
|
946
|
+
DESCRIPTION
|
|
947
|
+
Reanalyze a module's Dockerfile with custom instructions
|
|
948
|
+
|
|
949
|
+
EXAMPLES
|
|
950
|
+
$ hd module reanalyze --slug="my-module" --prompt="Use Node.js 18 instead of 20"
|
|
951
|
+
|
|
952
|
+
$ hd module reanalyze --prompt="Fix the build - missing Python dependency"
|
|
953
|
+
|
|
954
|
+
$ hd module reanalyze -s my-module -p "Exclude source maps from S3 upload" --verbose
|
|
955
|
+
```
|
|
956
|
+
|
|
957
|
+
_See code: [src/commands/module/reanalyze.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/reanalyze.ts)_
|
|
958
|
+
|
|
959
|
+
## `hd module update`
|
|
960
|
+
|
|
961
|
+
Update a module/project configuration
|
|
962
|
+
|
|
963
|
+
```
|
|
964
|
+
USAGE
|
|
965
|
+
$ hd module update -s <value> [--buildCommand <value>] [--buildDirectory <value>] [--buildFolder <value>]
|
|
966
|
+
[--buildRuntime nodejs|python|go|rust|java|dotnet|ruby] [--buildRuntimeVersion <value>] [--ciService
|
|
967
|
+
github-actions|gitlab-ci|circle-ci|jenkins] [--defaultBranch <value>] [--deploymentStrategy serverless] [-d <value>]
|
|
968
|
+
[--framework
|
|
969
|
+
express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|gin|actix|spring|aspnet|rails|other]
|
|
970
|
+
[--installCommand <value>] [--name <value>] [--routeDiscovery] [--runCommand <value>] [-r
|
|
971
|
+
nodejs|python|go|rust|java|dotnet|ruby] [-v <value>] [--sourceDirectory <value>] [--sourceLocation <value>]
|
|
972
|
+
|
|
973
|
+
FLAGS
|
|
974
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
975
|
+
-r, --runtime=<option> Runtime environment
|
|
976
|
+
<options: nodejs|python|go|rust|java|dotnet|ruby>
|
|
977
|
+
-s, --slug=<value> (required) Module slug to update (required)
|
|
978
|
+
-v, --runtimeVersion=<value> Runtime version (e.g., 20, 3.12, 1.21)
|
|
979
|
+
--buildCommand=<value> Build command
|
|
980
|
+
--buildDirectory=<value> Build output directory (e.g., dist, build, .next) - where compiled artifacts are
|
|
981
|
+
output
|
|
982
|
+
--buildFolder=<value> Build folder
|
|
983
|
+
--buildRuntime=<option> Build runtime for Dockerfile template selection
|
|
984
|
+
<options: nodejs|python|go|rust|java|dotnet|ruby>
|
|
985
|
+
--buildRuntimeVersion=<value> Build runtime version (e.g., 20 for Node, 3.12 for Python)
|
|
986
|
+
--ciService=<option> CI service used
|
|
987
|
+
<options: github-actions|gitlab-ci|circle-ci|jenkins>
|
|
988
|
+
--defaultBranch=<value> Default git branch to branch from (e.g., main, master)
|
|
989
|
+
--deploymentStrategy=<option> Deployment strategy: "serverless" for Serverless Framework deployment to Lambda
|
|
990
|
+
<options: serverless>
|
|
991
|
+
--framework=<option> Framework used
|
|
992
|
+
<options: express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|
|
|
993
|
+
gin|actix|spring|aspnet|rails|other>
|
|
994
|
+
--installCommand=<value> Install command
|
|
995
|
+
--name=<value> Name of the project
|
|
996
|
+
--[no-]routeDiscovery Enable AI-powered route discovery for per-route Lambda functions
|
|
997
|
+
--runCommand=<value> Run command
|
|
998
|
+
--sourceDirectory=<value> Source code directory (e.g., src, lib, . for root) - default: src for Lambda, . for
|
|
999
|
+
static
|
|
1000
|
+
--sourceLocation=<value> Source location of the project
|
|
1001
|
+
|
|
1002
|
+
DESCRIPTION
|
|
1003
|
+
Update a module/project configuration
|
|
1004
|
+
|
|
1005
|
+
EXAMPLES
|
|
1006
|
+
$ hd module update --slug="my-module" --runtimeVersion="12"
|
|
1007
|
+
|
|
1008
|
+
$ hd module update --slug="my-module" --buildCommand="npm run build:prod"
|
|
1009
|
+
|
|
1010
|
+
$ hd module update --slug="my-module" --name="New Name" --framework="React.js"
|
|
1011
|
+
```
|
|
1012
|
+
|
|
1013
|
+
_See code: [src/commands/module/update.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/module/update.ts)_
|
|
1014
|
+
|
|
1015
|
+
## `hd parameter add`
|
|
1016
|
+
|
|
1017
|
+
Add a new parameter to SSM Parameter Store
|
|
1018
|
+
|
|
1019
|
+
```
|
|
1020
|
+
USAGE
|
|
1021
|
+
$ hd parameter add --accountId <value> -k <value> -m <value> -v <value> [-d <value>] [--specific] [-s <value>]
|
|
1022
|
+
|
|
1023
|
+
FLAGS
|
|
1024
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1025
|
+
-k, --key=<value> (required) Parameter key/name
|
|
1026
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
1027
|
+
-s, --stage=<value> [default: all] Stage for the parameter (default: all stages)
|
|
1028
|
+
-v, --value=<value> (required) Parameter value
|
|
1029
|
+
--accountId=<value> (required) AWS Account ID
|
|
1030
|
+
--specific Make parameter specific to this project (default: global)
|
|
1031
|
+
|
|
1032
|
+
DESCRIPTION
|
|
1033
|
+
Add a new parameter to SSM Parameter Store
|
|
1034
|
+
|
|
1035
|
+
EXAMPLES
|
|
1036
|
+
$ hd parameter add --key="API_URL" --value="https://api.example.com" --stage="dev"
|
|
1037
|
+
|
|
1038
|
+
$ hd parameter add --key="DB_HOST" --value="localhost" --specific
|
|
1039
|
+
|
|
1040
|
+
$ hd parameter add --key="PORT" --value="3000"
|
|
1041
|
+
```
|
|
1042
|
+
|
|
1043
|
+
_See code: [src/commands/parameter/add.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/add.ts)_
|
|
1044
|
+
|
|
1045
|
+
## `hd parameter backfill`
|
|
1046
|
+
|
|
1047
|
+
Backfill existing SSM parameters to DynamoDB (one-time migration)
|
|
1048
|
+
|
|
1049
|
+
```
|
|
1050
|
+
USAGE
|
|
1051
|
+
$ hd parameter backfill --accountId <value> [-d <value>] [--dry-run] [--no-dry-run]
|
|
1052
|
+
|
|
1053
|
+
FLAGS
|
|
1054
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1055
|
+
--accountId=<value> (required) AWS Account ID to backfill from
|
|
1056
|
+
--dry-run Preview what would be imported without making changes (default: true)
|
|
1057
|
+
--no-dry-run Actually perform the backfill (writes to DynamoDB)
|
|
1058
|
+
|
|
1059
|
+
DESCRIPTION
|
|
1060
|
+
Backfill existing SSM parameters to DynamoDB (one-time migration)
|
|
1061
|
+
|
|
1062
|
+
EXAMPLES
|
|
1063
|
+
$ hd parameter backfill --accountId="123456789012" --dry-run
|
|
1064
|
+
|
|
1065
|
+
$ hd parameter backfill --accountId="123456789012"
|
|
1066
|
+
```
|
|
1067
|
+
|
|
1068
|
+
_See code: [src/commands/parameter/backfill.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/backfill.ts)_
|
|
1069
|
+
|
|
1070
|
+
## `hd parameter clear`
|
|
1071
|
+
|
|
1072
|
+
Clear all parameters for a project and stage (DANGEROUS)
|
|
1073
|
+
|
|
1074
|
+
```
|
|
1075
|
+
USAGE
|
|
1076
|
+
$ hd parameter clear --accountId <value> -m <value> [-d <value>] [-f] [--specific] [-s <value>]
|
|
1077
|
+
|
|
1078
|
+
FLAGS
|
|
1079
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1080
|
+
-f, --force Skip confirmation prompt (DANGEROUS)
|
|
1081
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
1082
|
+
-s, --stage=<value> [default: all] Stage to clear parameters for
|
|
1083
|
+
--accountId=<value> (required) AWS Account ID
|
|
1084
|
+
--specific Clear only project-specific parameters (default: global)
|
|
1085
|
+
|
|
1086
|
+
DESCRIPTION
|
|
1087
|
+
Clear all parameters for a project and stage (DANGEROUS)
|
|
1088
|
+
|
|
1089
|
+
EXAMPLES
|
|
1090
|
+
$ hd parameter clear --stage="dev"
|
|
1091
|
+
|
|
1092
|
+
$ hd parameter clear --stage="prod" --specific --force
|
|
1093
|
+
```
|
|
1094
|
+
|
|
1095
|
+
_See code: [src/commands/parameter/clear.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/clear.ts)_
|
|
1096
|
+
|
|
1097
|
+
## `hd parameter list`
|
|
1098
|
+
|
|
1099
|
+
List all parameters for a project and stage
|
|
1100
|
+
|
|
1101
|
+
```
|
|
1102
|
+
USAGE
|
|
1103
|
+
$ hd parameter list --accountId <value> -m <value> [--all-stages] [-d <value>] [--specific] [-s <value>]
|
|
1104
|
+
|
|
1105
|
+
FLAGS
|
|
1106
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1107
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
1108
|
+
-s, --stage=<value> [default: all] Stage to list parameters for
|
|
1109
|
+
--accountId=<value> (required) AWS Account ID
|
|
1110
|
+
--all-stages List parameters from all stages
|
|
1111
|
+
--specific List only project-specific parameters
|
|
1112
|
+
|
|
1113
|
+
DESCRIPTION
|
|
1114
|
+
List all parameters for a project and stage
|
|
1115
|
+
|
|
1116
|
+
EXAMPLES
|
|
1117
|
+
$ hd parameter list --stage="dev"
|
|
1118
|
+
|
|
1119
|
+
$ hd parameter list --stage="prod" --specific
|
|
1120
|
+
|
|
1121
|
+
$ hd parameter list --all-stages
|
|
1122
|
+
```
|
|
1123
|
+
|
|
1124
|
+
_See code: [src/commands/parameter/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/list.ts)_
|
|
1125
|
+
|
|
1126
|
+
## `hd parameter pull`
|
|
1127
|
+
|
|
1128
|
+
Pull parameters from SSM Parameter Store to a .env file
|
|
1129
|
+
|
|
1130
|
+
```
|
|
1131
|
+
USAGE
|
|
1132
|
+
$ hd parameter pull --accountId <value> -m <value> -s <value> [--backup] [-d <value>] [-f <value>]
|
|
1133
|
+
|
|
1134
|
+
FLAGS
|
|
1135
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1136
|
+
-f, --file=<value> [default: .env] Output file path
|
|
1137
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
1138
|
+
-s, --stage=<value> (required) Stage to pull parameters from
|
|
1139
|
+
--accountId=<value> (required) AWS Account ID
|
|
1140
|
+
--[no-]backup Create .env.backup before overwriting (default: true)
|
|
1141
|
+
|
|
1142
|
+
DESCRIPTION
|
|
1143
|
+
Pull parameters from SSM Parameter Store to a .env file
|
|
1144
|
+
|
|
1145
|
+
EXAMPLES
|
|
1146
|
+
$ hd parameter pull --stage="dev"
|
|
1147
|
+
|
|
1148
|
+
$ hd parameter pull --stage="prod" --file=".env.prod"
|
|
1149
|
+
|
|
1150
|
+
$ hd parameter pull --stage="dev" --no-backup
|
|
1151
|
+
```
|
|
1152
|
+
|
|
1153
|
+
_See code: [src/commands/parameter/pull.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/pull.ts)_
|
|
1154
|
+
|
|
1155
|
+
## `hd parameter remove`
|
|
1156
|
+
|
|
1157
|
+
Remove a parameter from SSM Parameter Store
|
|
1158
|
+
|
|
1159
|
+
```
|
|
1160
|
+
USAGE
|
|
1161
|
+
$ hd parameter remove --accountId <value> -k <value> -m <value> [-d <value>] [-f] [--specific] [-s <value>]
|
|
1162
|
+
|
|
1163
|
+
FLAGS
|
|
1164
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1165
|
+
-f, --force Skip confirmation prompt
|
|
1166
|
+
-k, --key=<value> (required) Parameter key/name to remove
|
|
1167
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
1168
|
+
-s, --stage=<value> [default: all] Stage for the parameter (default: all stages)
|
|
1169
|
+
--accountId=<value> (required) AWS Account ID
|
|
1170
|
+
--specific Remove from project-specific parameters (default: global)
|
|
1171
|
+
|
|
1172
|
+
DESCRIPTION
|
|
1173
|
+
Remove a parameter from SSM Parameter Store
|
|
1174
|
+
|
|
1175
|
+
EXAMPLES
|
|
1176
|
+
$ hd parameter remove --key="API_URL" --stage="dev"
|
|
1177
|
+
|
|
1178
|
+
$ hd parameter remove --key="DB_HOST" --specific --stage="prod"
|
|
1179
|
+
|
|
1180
|
+
$ hd parameter remove --key="PORT" --force
|
|
1181
|
+
```
|
|
1182
|
+
|
|
1183
|
+
_See code: [src/commands/parameter/remove.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/remove.ts)_
|
|
1184
|
+
|
|
1185
|
+
## `hd parameter sync`
|
|
1186
|
+
|
|
1187
|
+
Synchronize environment variables from a .env file to Hyperdrive
|
|
1188
|
+
|
|
1189
|
+
```
|
|
1190
|
+
USAGE
|
|
1191
|
+
$ hd parameter sync --accountId <value> -m <value> [-d <value>] [-f <value>] [-s] [-t <value>]
|
|
1192
|
+
|
|
1193
|
+
FLAGS
|
|
1194
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1195
|
+
-f, --file=<value> [default: .env] Path to the .env file
|
|
1196
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
1197
|
+
-s, --[no-]specific Whether the env vars are project-specific (default: true)
|
|
1198
|
+
-t, --stage=<value> [default: all] Stage for the env vars (default: all stages)
|
|
1199
|
+
--accountId=<value> (required) AWS Account ID
|
|
1200
|
+
|
|
1201
|
+
DESCRIPTION
|
|
1202
|
+
Synchronize environment variables from a .env file to Hyperdrive
|
|
1203
|
+
|
|
1204
|
+
EXAMPLES
|
|
1205
|
+
$ hd parameter sync --stage="dev"
|
|
1206
|
+
|
|
1207
|
+
$ hd parameter sync --file=".env.production" --stage="prod"
|
|
1208
|
+
|
|
1209
|
+
$ hd parameter sync --no-specific --stage="all"
|
|
1210
|
+
```
|
|
1211
|
+
|
|
1212
|
+
_See code: [src/commands/parameter/sync.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/sync.ts)_
|
|
1213
|
+
|
|
1214
|
+
## `hd parameter update`
|
|
1215
|
+
|
|
1216
|
+
Update an existing parameter in SSM Parameter Store
|
|
1217
|
+
|
|
1218
|
+
```
|
|
1219
|
+
USAGE
|
|
1220
|
+
$ hd parameter update --accountId <value> -k <value> -m <value> -v <value> [-d <value>] [--specific] [-s <value>]
|
|
1221
|
+
|
|
1222
|
+
FLAGS
|
|
1223
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1224
|
+
-k, --key=<value> (required) Parameter key/name to update
|
|
1225
|
+
-m, --moduleSlug=<value> (required) Module slug
|
|
1226
|
+
-s, --stage=<value> [default: all] Stage for the parameter (default: all stages)
|
|
1227
|
+
-v, --value=<value> (required) New parameter value
|
|
1228
|
+
--accountId=<value> (required) AWS Account ID
|
|
1229
|
+
--specific Update project-specific parameter (default: global)
|
|
1230
|
+
|
|
1231
|
+
DESCRIPTION
|
|
1232
|
+
Update an existing parameter in SSM Parameter Store
|
|
1233
|
+
|
|
1234
|
+
EXAMPLES
|
|
1235
|
+
$ hd parameter update --key="API_URL" --value="https://new-api.example.com" --stage="dev"
|
|
1236
|
+
|
|
1237
|
+
$ hd parameter update --key="DB_HOST" --value="new-host" --specific
|
|
1238
|
+
```
|
|
1239
|
+
|
|
1240
|
+
_See code: [src/commands/parameter/update.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/parameter/update.ts)_
|
|
1241
|
+
|
|
1242
|
+
## `hd plugins`
|
|
1243
|
+
|
|
1244
|
+
List installed plugins.
|
|
1245
|
+
|
|
1246
|
+
```
|
|
1247
|
+
USAGE
|
|
1248
|
+
$ hd plugins [--json] [--core]
|
|
1249
|
+
|
|
1250
|
+
FLAGS
|
|
1251
|
+
--core Show core plugins.
|
|
1252
|
+
|
|
1253
|
+
GLOBAL FLAGS
|
|
1254
|
+
--json Format output as json.
|
|
1255
|
+
|
|
1256
|
+
DESCRIPTION
|
|
1257
|
+
List installed plugins.
|
|
1258
|
+
|
|
1259
|
+
EXAMPLES
|
|
1260
|
+
$ hd plugins
|
|
1261
|
+
```
|
|
1262
|
+
|
|
1263
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/index.ts)_
|
|
1264
|
+
|
|
1265
|
+
## `hd plugins add PLUGIN`
|
|
1266
|
+
|
|
1267
|
+
Installs a plugin into hd.
|
|
1268
|
+
|
|
1269
|
+
```
|
|
1270
|
+
USAGE
|
|
1271
|
+
$ hd plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
1272
|
+
|
|
1273
|
+
ARGUMENTS
|
|
1274
|
+
PLUGIN... Plugin to install.
|
|
1275
|
+
|
|
1276
|
+
FLAGS
|
|
1277
|
+
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
1278
|
+
-h, --help Show CLI help.
|
|
1279
|
+
-s, --silent Silences npm output.
|
|
1280
|
+
-v, --verbose Show verbose npm output.
|
|
1281
|
+
|
|
1282
|
+
GLOBAL FLAGS
|
|
1283
|
+
--json Format output as json.
|
|
1284
|
+
|
|
1285
|
+
DESCRIPTION
|
|
1286
|
+
Installs a plugin into hd.
|
|
1287
|
+
|
|
1288
|
+
Uses bundled npm executable to install plugins into /root/.local/share/hd
|
|
1289
|
+
|
|
1290
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
1291
|
+
|
|
1292
|
+
Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
1293
|
+
Use the HD_NPM_REGISTRY environment variable to set the npm registry.
|
|
1294
|
+
|
|
1295
|
+
ALIASES
|
|
1296
|
+
$ hd plugins add
|
|
1297
|
+
|
|
1298
|
+
EXAMPLES
|
|
1299
|
+
Install a plugin from npm registry.
|
|
1300
|
+
|
|
1301
|
+
$ hd plugins add myplugin
|
|
1302
|
+
|
|
1303
|
+
Install a plugin from a github url.
|
|
1304
|
+
|
|
1305
|
+
$ hd plugins add https://github.com/someuser/someplugin
|
|
1306
|
+
|
|
1307
|
+
Install a plugin from a github slug.
|
|
1308
|
+
|
|
1309
|
+
$ hd plugins add someuser/someplugin
|
|
1310
|
+
```
|
|
1311
|
+
|
|
1312
|
+
## `hd plugins:inspect PLUGIN...`
|
|
1313
|
+
|
|
1314
|
+
Displays installation properties of a plugin.
|
|
1315
|
+
|
|
1316
|
+
```
|
|
1317
|
+
USAGE
|
|
1318
|
+
$ hd plugins inspect PLUGIN...
|
|
1319
|
+
|
|
1320
|
+
ARGUMENTS
|
|
1321
|
+
PLUGIN... [default: .] Plugin to inspect.
|
|
1322
|
+
|
|
1323
|
+
FLAGS
|
|
1324
|
+
-h, --help Show CLI help.
|
|
1325
|
+
-v, --verbose
|
|
1326
|
+
|
|
1327
|
+
GLOBAL FLAGS
|
|
1328
|
+
--json Format output as json.
|
|
1329
|
+
|
|
1330
|
+
DESCRIPTION
|
|
1331
|
+
Displays installation properties of a plugin.
|
|
1332
|
+
|
|
1333
|
+
EXAMPLES
|
|
1334
|
+
$ hd plugins inspect myplugin
|
|
1335
|
+
```
|
|
1336
|
+
|
|
1337
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/inspect.ts)_
|
|
1338
|
+
|
|
1339
|
+
## `hd plugins install PLUGIN`
|
|
1340
|
+
|
|
1341
|
+
Installs a plugin into hd.
|
|
1342
|
+
|
|
1343
|
+
```
|
|
1344
|
+
USAGE
|
|
1345
|
+
$ hd plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
1346
|
+
|
|
1347
|
+
ARGUMENTS
|
|
1348
|
+
PLUGIN... Plugin to install.
|
|
1349
|
+
|
|
1350
|
+
FLAGS
|
|
1351
|
+
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
1352
|
+
-h, --help Show CLI help.
|
|
1353
|
+
-s, --silent Silences npm output.
|
|
1354
|
+
-v, --verbose Show verbose npm output.
|
|
1355
|
+
|
|
1356
|
+
GLOBAL FLAGS
|
|
1357
|
+
--json Format output as json.
|
|
1358
|
+
|
|
1359
|
+
DESCRIPTION
|
|
1360
|
+
Installs a plugin into hd.
|
|
1361
|
+
|
|
1362
|
+
Uses bundled npm executable to install plugins into /root/.local/share/hd
|
|
1363
|
+
|
|
1364
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
1365
|
+
|
|
1366
|
+
Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
1367
|
+
Use the HD_NPM_REGISTRY environment variable to set the npm registry.
|
|
1368
|
+
|
|
1369
|
+
ALIASES
|
|
1370
|
+
$ hd plugins add
|
|
1371
|
+
|
|
1372
|
+
EXAMPLES
|
|
1373
|
+
Install a plugin from npm registry.
|
|
1374
|
+
|
|
1375
|
+
$ hd plugins install myplugin
|
|
1376
|
+
|
|
1377
|
+
Install a plugin from a github url.
|
|
1378
|
+
|
|
1379
|
+
$ hd plugins install https://github.com/someuser/someplugin
|
|
1380
|
+
|
|
1381
|
+
Install a plugin from a github slug.
|
|
1382
|
+
|
|
1383
|
+
$ hd plugins install someuser/someplugin
|
|
1384
|
+
```
|
|
1385
|
+
|
|
1386
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/install.ts)_
|
|
1387
|
+
|
|
1388
|
+
## `hd plugins link PATH`
|
|
1389
|
+
|
|
1390
|
+
Links a plugin into the CLI for development.
|
|
1391
|
+
|
|
1392
|
+
```
|
|
1393
|
+
USAGE
|
|
1394
|
+
$ hd plugins link PATH [-h] [--install] [-v]
|
|
1395
|
+
|
|
1396
|
+
ARGUMENTS
|
|
1397
|
+
PATH [default: .] path to plugin
|
|
1398
|
+
|
|
1399
|
+
FLAGS
|
|
1400
|
+
-h, --help Show CLI help.
|
|
1401
|
+
-v, --verbose
|
|
1402
|
+
--[no-]install Install dependencies after linking the plugin.
|
|
1403
|
+
|
|
1404
|
+
DESCRIPTION
|
|
1405
|
+
Links a plugin into the CLI for development.
|
|
1406
|
+
Installation of a linked plugin will override a user-installed or core plugin.
|
|
1407
|
+
|
|
1408
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
1409
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
EXAMPLES
|
|
1413
|
+
$ hd plugins link myplugin
|
|
1414
|
+
```
|
|
1415
|
+
|
|
1416
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/link.ts)_
|
|
1417
|
+
|
|
1418
|
+
## `hd plugins remove [PLUGIN]`
|
|
1419
|
+
|
|
1420
|
+
Removes a plugin from the CLI.
|
|
1421
|
+
|
|
1422
|
+
```
|
|
1423
|
+
USAGE
|
|
1424
|
+
$ hd plugins remove [PLUGIN...] [-h] [-v]
|
|
1425
|
+
|
|
1426
|
+
ARGUMENTS
|
|
1427
|
+
PLUGIN... plugin to uninstall
|
|
1428
|
+
|
|
1429
|
+
FLAGS
|
|
1430
|
+
-h, --help Show CLI help.
|
|
1431
|
+
-v, --verbose
|
|
1432
|
+
|
|
1433
|
+
DESCRIPTION
|
|
1434
|
+
Removes a plugin from the CLI.
|
|
1435
|
+
|
|
1436
|
+
ALIASES
|
|
1437
|
+
$ hd plugins unlink
|
|
1438
|
+
$ hd plugins remove
|
|
1439
|
+
|
|
1440
|
+
EXAMPLES
|
|
1441
|
+
$ hd plugins remove myplugin
|
|
1442
|
+
```
|
|
1443
|
+
|
|
1444
|
+
## `hd plugins reset`
|
|
1445
|
+
|
|
1446
|
+
Remove all user-installed and linked plugins.
|
|
1447
|
+
|
|
1448
|
+
```
|
|
1449
|
+
USAGE
|
|
1450
|
+
$ hd plugins reset [--hard] [--reinstall]
|
|
1451
|
+
|
|
1452
|
+
FLAGS
|
|
1453
|
+
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
|
|
1454
|
+
--reinstall Reinstall all plugins after uninstalling.
|
|
1455
|
+
```
|
|
1456
|
+
|
|
1457
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/reset.ts)_
|
|
1458
|
+
|
|
1459
|
+
## `hd plugins uninstall [PLUGIN]`
|
|
1460
|
+
|
|
1461
|
+
Removes a plugin from the CLI.
|
|
1462
|
+
|
|
1463
|
+
```
|
|
1464
|
+
USAGE
|
|
1465
|
+
$ hd plugins uninstall [PLUGIN...] [-h] [-v]
|
|
1466
|
+
|
|
1467
|
+
ARGUMENTS
|
|
1468
|
+
PLUGIN... plugin to uninstall
|
|
1469
|
+
|
|
1470
|
+
FLAGS
|
|
1471
|
+
-h, --help Show CLI help.
|
|
1472
|
+
-v, --verbose
|
|
1473
|
+
|
|
1474
|
+
DESCRIPTION
|
|
1475
|
+
Removes a plugin from the CLI.
|
|
1476
|
+
|
|
1477
|
+
ALIASES
|
|
1478
|
+
$ hd plugins unlink
|
|
1479
|
+
$ hd plugins remove
|
|
1480
|
+
|
|
1481
|
+
EXAMPLES
|
|
1482
|
+
$ hd plugins uninstall myplugin
|
|
1483
|
+
```
|
|
1484
|
+
|
|
1485
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/uninstall.ts)_
|
|
1486
|
+
|
|
1487
|
+
## `hd plugins unlink [PLUGIN]`
|
|
1488
|
+
|
|
1489
|
+
Removes a plugin from the CLI.
|
|
1490
|
+
|
|
1491
|
+
```
|
|
1492
|
+
USAGE
|
|
1493
|
+
$ hd plugins unlink [PLUGIN...] [-h] [-v]
|
|
1494
|
+
|
|
1495
|
+
ARGUMENTS
|
|
1496
|
+
PLUGIN... plugin to uninstall
|
|
1497
|
+
|
|
1498
|
+
FLAGS
|
|
1499
|
+
-h, --help Show CLI help.
|
|
1500
|
+
-v, --verbose
|
|
1501
|
+
|
|
1502
|
+
DESCRIPTION
|
|
1503
|
+
Removes a plugin from the CLI.
|
|
1504
|
+
|
|
1505
|
+
ALIASES
|
|
1506
|
+
$ hd plugins unlink
|
|
1507
|
+
$ hd plugins remove
|
|
1508
|
+
|
|
1509
|
+
EXAMPLES
|
|
1510
|
+
$ hd plugins unlink myplugin
|
|
1511
|
+
```
|
|
1512
|
+
|
|
1513
|
+
## `hd plugins update`
|
|
1514
|
+
|
|
1515
|
+
Update installed plugins.
|
|
1516
|
+
|
|
1517
|
+
```
|
|
1518
|
+
USAGE
|
|
1519
|
+
$ hd plugins update [-h] [-v]
|
|
1520
|
+
|
|
1521
|
+
FLAGS
|
|
1522
|
+
-h, --help Show CLI help.
|
|
1523
|
+
-v, --verbose
|
|
1524
|
+
|
|
1525
|
+
DESCRIPTION
|
|
1526
|
+
Update installed plugins.
|
|
1527
|
+
```
|
|
1528
|
+
|
|
1529
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/update.ts)_
|
|
1530
|
+
|
|
1531
|
+
## `hd stage create`
|
|
1532
|
+
|
|
1533
|
+
Create a new stage
|
|
1534
|
+
|
|
1535
|
+
```
|
|
1536
|
+
USAGE
|
|
1537
|
+
$ hd stage create [-a <value>] [--autoLaunch] [-b <value>] [--defaultStage] [--deletionProtection] [-d <value>]
|
|
1538
|
+
[-n <value>] [--production] [-p <value>] [--provider <value>] [-r <value>]
|
|
1539
|
+
|
|
1540
|
+
FLAGS
|
|
1541
|
+
-a, --accountId=<value> AWS Account ID for deployments
|
|
1542
|
+
-b, --branchName=<value> Git branch name
|
|
1543
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1544
|
+
-n, --name=<value> Name of the stage (e.g., dev, staging, production)
|
|
1545
|
+
-p, --project=<value>... Project slugs to associate with this stage
|
|
1546
|
+
-r, --region=<value>... AWS region(s) for deployment
|
|
1547
|
+
--autoLaunch Automatically launch deployments for this stage
|
|
1548
|
+
--defaultStage Set as default stage for fallback
|
|
1549
|
+
--deletionProtection Enable deletion protection
|
|
1550
|
+
--production Mark as production stage
|
|
1551
|
+
--provider=<value> [default: aws] Cloud provider
|
|
1552
|
+
|
|
1553
|
+
DESCRIPTION
|
|
1554
|
+
Create a new stage
|
|
1555
|
+
```
|
|
1556
|
+
|
|
1557
|
+
_See code: [src/commands/stage/create.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/stage/create.ts)_
|
|
1558
|
+
|
|
1559
|
+
## `hd stage list`
|
|
1560
|
+
|
|
1561
|
+
List all stages
|
|
1562
|
+
|
|
1563
|
+
```
|
|
1564
|
+
USAGE
|
|
1565
|
+
$ hd stage list [-d <value>]
|
|
1566
|
+
|
|
1567
|
+
FLAGS
|
|
1568
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1569
|
+
|
|
1570
|
+
DESCRIPTION
|
|
1571
|
+
List all stages
|
|
1572
|
+
|
|
1573
|
+
EXAMPLES
|
|
1574
|
+
$ hd stage list
|
|
1575
|
+
```
|
|
1576
|
+
|
|
1577
|
+
_See code: [src/commands/stage/list.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/stage/list.ts)_
|
|
1578
|
+
|
|
1579
|
+
## `hd test-api`
|
|
1580
|
+
|
|
1581
|
+
Test API connection with SigV4 authentication
|
|
1582
|
+
|
|
1583
|
+
```
|
|
1584
|
+
USAGE
|
|
1585
|
+
$ hd test-api [-d <value>]
|
|
1586
|
+
|
|
1587
|
+
FLAGS
|
|
1588
|
+
-d, --domain=<value> Tenant domain (for multi-domain setups)
|
|
1589
|
+
|
|
1590
|
+
DESCRIPTION
|
|
1591
|
+
Test API connection with SigV4 authentication
|
|
1592
|
+
|
|
1593
|
+
EXAMPLES
|
|
1594
|
+
$ hd test-api
|
|
1595
|
+
```
|
|
1596
|
+
|
|
1597
|
+
_See code: [src/commands/test-api.ts](https://github.com/hyperdrive/hd/blob/v1.0.2/src/commands/test-api.ts)_
|
|
1598
|
+
<!-- commandsstop -->
|