@hideandseeklab/aoox 0.1.0-alpha.9 → 0.1.0-beta.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.
Files changed (89) hide show
  1. package/README.md +482 -154
  2. package/assets/install/docker-compose.dist.yml +15 -1
  3. package/bin/dev.js +8 -2
  4. package/bin/run.js +6 -2
  5. package/dist/commands/deploy.js +8 -7
  6. package/dist/commands/domain/clear.d.ts +16 -0
  7. package/dist/commands/domain/clear.js +61 -0
  8. package/dist/commands/domain/set.d.ts +1 -0
  9. package/dist/commands/domain/set.js +15 -3
  10. package/dist/commands/env/diff.d.ts +5 -5
  11. package/dist/commands/env/diff.js +19 -14
  12. package/dist/commands/env/history.d.ts +4 -2
  13. package/dist/commands/env/history.js +10 -8
  14. package/dist/commands/env/link.d.ts +17 -0
  15. package/dist/commands/env/link.js +53 -0
  16. package/dist/commands/env/links.d.ts +14 -0
  17. package/dist/commands/env/links.js +17 -0
  18. package/dist/commands/env/list.d.ts +16 -7
  19. package/dist/commands/env/list.js +62 -33
  20. package/dist/commands/env/promote.d.ts +5 -5
  21. package/dist/commands/env/promote.js +35 -38
  22. package/dist/commands/env/pull.d.ts +4 -2
  23. package/dist/commands/env/pull.js +8 -8
  24. package/dist/commands/env/push.d.ts +4 -2
  25. package/dist/commands/env/push.js +16 -27
  26. package/dist/commands/env/set.d.ts +4 -2
  27. package/dist/commands/env/set.js +17 -33
  28. package/dist/commands/env/unlink.d.ts +17 -0
  29. package/dist/commands/env/unlink.js +39 -0
  30. package/dist/commands/env/unset.d.ts +4 -2
  31. package/dist/commands/env/unset.js +13 -24
  32. package/dist/commands/install.d.ts +19 -0
  33. package/dist/commands/install.js +232 -82
  34. package/dist/commands/link.js +5 -4
  35. package/dist/commands/login.js +4 -3
  36. package/dist/commands/registry/build.d.ts +3 -1
  37. package/dist/commands/registry/build.js +12 -6
  38. package/dist/commands/registry/domain.js +3 -2
  39. package/dist/commands/registry/password.d.ts +19 -0
  40. package/dist/commands/registry/password.js +82 -0
  41. package/dist/commands/registry/push.d.ts +2 -1
  42. package/dist/commands/registry/push.js +6 -3
  43. package/dist/commands/reinstall.js +26 -20
  44. package/dist/commands/run.d.ts +9 -2
  45. package/dist/commands/run.js +70 -15
  46. package/dist/commands/update/panel.js +28 -5
  47. package/dist/commands/update.js +6 -5
  48. package/dist/commands/whoami.js +2 -1
  49. package/dist/lib/api.js +2 -2
  50. package/dist/lib/compose-version.d.ts +26 -0
  51. package/dist/lib/compose-version.js +61 -0
  52. package/dist/lib/discovery.d.ts +24 -2
  53. package/dist/lib/discovery.js +97 -3
  54. package/dist/lib/docker.d.ts +1 -1
  55. package/dist/lib/docker.js +2 -2
  56. package/dist/lib/env-command.d.ts +83 -35
  57. package/dist/lib/env-command.js +136 -62
  58. package/dist/lib/env-text.js +4 -0
  59. package/dist/lib/image-confirm.d.ts +38 -0
  60. package/dist/lib/image-confirm.js +102 -0
  61. package/dist/lib/image-source.d.ts +59 -0
  62. package/dist/lib/image-source.js +261 -0
  63. package/dist/lib/install-plan.d.ts +69 -0
  64. package/dist/lib/install-plan.js +86 -0
  65. package/dist/lib/interrupt.d.ts +19 -0
  66. package/dist/lib/interrupt.js +42 -0
  67. package/dist/lib/leftover-volumes.d.ts +18 -0
  68. package/dist/lib/leftover-volumes.js +69 -0
  69. package/dist/lib/link-command.d.ts +9 -0
  70. package/dist/lib/link-command.js +23 -0
  71. package/dist/lib/manifest-parsers.d.ts +23 -0
  72. package/dist/lib/manifest-parsers.js +152 -0
  73. package/dist/lib/registry-image-command.d.ts +20 -3
  74. package/dist/lib/registry-image-command.js +56 -14
  75. package/dist/lib/reinstall.d.ts +7 -0
  76. package/dist/lib/reinstall.js +28 -0
  77. package/dist/lib/run-banner.d.ts +18 -0
  78. package/dist/lib/run-banner.js +20 -0
  79. package/dist/lib/self-update.d.ts +4 -3
  80. package/dist/lib/self-update.js +6 -8
  81. package/dist/lib/style.d.ts +34 -0
  82. package/dist/lib/style.js +75 -0
  83. package/dist/lib/system-ca.d.ts +20 -0
  84. package/dist/lib/system-ca.js +29 -0
  85. package/dist/lib/types.d.ts +85 -15
  86. package/dist/lib/variable-sets.d.ts +90 -0
  87. package/dist/lib/variable-sets.js +177 -0
  88. package/oclif.manifest.json +741 -146
  89. package/package.json +2 -2
package/README.md CHANGED
@@ -27,7 +27,7 @@ $ npm install -g @hideandseeklab/aoox
27
27
  $ aoox COMMAND
28
28
  running command...
29
29
  $ aoox (--version)
30
- @hideandseeklab/aoox/0.1.0-alpha.9 linux-x64 node-v24.21.0
30
+ @hideandseeklab/aoox/0.1.0-beta.0 linux-x64 node-v24.22.1
31
31
  $ aoox --help [COMMAND]
32
32
  USAGE
33
33
  $ aoox COMMAND
@@ -81,17 +81,65 @@ npm run build
81
81
  npm link # or: npm install -g .
82
82
  ```
83
83
 
84
+ ## Image name and version from the project
85
+
86
+ `aoox registry build` and `aoox registry push` do not need `name:version` typed in full. With no argument (or a name without a version) the CLI fills the gaps, in this order, from the build context (`push`: the current directory); the first source that has the value wins and is named in the output:
87
+
88
+ | # | Source | Name | Version |
89
+ | - | ------ | ---- | ------- |
90
+ | 1 | `package.json` | `name`, npm scope removed (`@acme/web` becomes `web`) | `version` |
91
+ | 2 | `pyproject.toml` | `[project]` or `[tool.poetry]` name | version (skipped when `dynamic`) |
92
+ | 3 | `Cargo.toml` | `[package]` name | `[package]` version (not a workspace one) |
93
+ | 4 | `composer.json` | `name`, vendor removed | `version`, if present |
94
+ | 5 | `pubspec.yaml` | `name` | `version` |
95
+ | 6 | `*.csproj` (exactly one) | `AssemblyName`, else the file name | `Version`, or `VersionPrefix`-`VersionSuffix` |
96
+ | 7 | `pom.xml` | project `artifactId` | project `version` (not the parent's) |
97
+ | 8 | `VERSION` | - | first non-empty line |
98
+ | 9 | git tag | - | the tag HEAD is exactly on, leading `v` removed |
99
+ | 10 | folder name | the folder, lowercased | - |
100
+
101
+ Names are lowercased; a `+` in a version becomes `_` (tags cannot contain it). A value that cannot be read with certainty (an MSBuild `$(...)` or Maven `${...}` variable, `version.workspace`) is skipped. If HEAD is past the last tag the CLI refuses instead of guessing (tag it, type `name:version`, or `--force` to use the `git describe` form `1.4.2-3-gabc1234`). Because the result is derived, the CLI prints where it came from and asks `Build web:1.4.2? (Y/n/e)` first (`Y` continue, `n` abort, `e` edit); `--yes` skips the question, and without a terminal (or with `CI` set) it refuses and asks for `name:version` or `--yes`. A fully typed `name:version` never asks. The "version already exists" check still applies, so forgetting to bump the version never overwrites an image.
102
+
103
+ ## Installing on a machine that still has panel data
104
+
105
+ `aoox install` in an empty folder (no `.env.dist`, no compose file) first asks Docker whether the panel's data volume (`aoox_postgres_data`, and any other named volume the bundled compose file declares) already exists. If it does, a fresh install would generate a new `POSTGRES_PASSWORD` that cannot open the old database, so the command stops before writing anything and tells you to either:
106
+
107
+ - restore the old `.env.dist` (the message names the newest `<dir>/backups/<time>/` copy when there is one) and run `sudo aoox reinstall`, which keeps the data; or
108
+ - start from scratch with `sudo aoox install --force --new-secrets --wipe-data`, which removes those volumes (and the stack's own containers that still use them) after you type the folder, or pass `--confirm-wipe=<dir>`.
109
+
110
+ ## Colours
111
+
112
+ Step lines (`==> ...`), results, warnings and hints are coloured when the output is a terminal. `NO_COLOR=1` turns colour off, `FORCE_COLOR=1` turns it on without a terminal (for example in some CI logs). Output meant for pipes (`aoox env pull` to stdout) and docker's own output are never coloured by the CLI.
113
+
114
+ ## Behind an antivirus or corporate proxy
115
+
116
+ Antivirus HTTPS scanning (AVG, Avast, Kaspersky, ESET, Bitdefender) and corporate proxies (Zscaler,
117
+ Netskope, Fortinet, Palo Alto) re-sign HTTPS traffic with their own root certificate, which is
118
+ installed in the operating system's store but unknown to Node. On Node 22.19+ / 24.5+ aoox trusts
119
+ the system store in addition to Node's bundled list, so this works without any setup. Certificate
120
+ verification is never turned off.
121
+
122
+ - `AOOX_SYSTEM_CA=0` opts out (Node's bundled list only).
123
+ - `NODE_EXTRA_CA_CERTS=<root.pem>` still works and is kept.
124
+ - On older Node, set `NODE_OPTIONS=--use-system-ca` (Node 22.15+/23.10+), or upgrade Node, or add the panel's domain to the antivirus HTTPS-scanning exclusions.
125
+ - If verification still fails because of an unknown issuer, the error names the issuer it saw.
126
+
84
127
  # Commands
85
128
  <!-- commands -->
86
129
  * [`aoox deploy`](#aoox-deploy)
130
+ * [`aoox domain clear`](#aoox-domain-clear)
87
131
  * [`aoox domain set`](#aoox-domain-set)
88
- * [`aoox env diff FROM TO`](#aoox-env-diff-from-to)
132
+ * [`aoox env diff`](#aoox-env-diff)
89
133
  * [`aoox env history`](#aoox-env-history)
134
+ * [`aoox env link`](#aoox-env-link)
135
+ * [`aoox env links`](#aoox-env-links)
90
136
  * [`aoox env list`](#aoox-env-list)
91
- * [`aoox env promote FROM TO`](#aoox-env-promote-from-to)
137
+ * [`aoox env promote`](#aoox-env-promote)
92
138
  * [`aoox env pull`](#aoox-env-pull)
93
139
  * [`aoox env push`](#aoox-env-push)
94
140
  * [`aoox env set ASSIGNMENTS`](#aoox-env-set-assignments)
141
+ * [`aoox env sets`](#aoox-env-sets)
142
+ * [`aoox env unlink`](#aoox-env-unlink)
95
143
  * [`aoox env unset KEYS`](#aoox-env-unset-keys)
96
144
  * [`aoox help [COMMAND]`](#aoox-help-command)
97
145
  * [`aoox install`](#aoox-install)
@@ -107,9 +155,10 @@ npm link # or: npm install -g .
107
155
  * [`aoox plugins uninstall [PLUGIN]`](#aoox-plugins-uninstall-plugin)
108
156
  * [`aoox plugins unlink [PLUGIN]`](#aoox-plugins-unlink-plugin)
109
157
  * [`aoox plugins update`](#aoox-plugins-update)
110
- * [`aoox registry build IMAGE`](#aoox-registry-build-image)
158
+ * [`aoox registry build [IMAGE]`](#aoox-registry-build-image)
111
159
  * [`aoox registry domain`](#aoox-registry-domain)
112
- * [`aoox registry push IMAGE`](#aoox-registry-push-image)
160
+ * [`aoox registry password`](#aoox-registry-password)
161
+ * [`aoox registry push [IMAGE]`](#aoox-registry-push-image)
113
162
  * [`aoox reinstall`](#aoox-reinstall)
114
163
  * [`aoox run`](#aoox-run)
115
164
  * [`aoox update`](#aoox-update)
@@ -143,7 +192,32 @@ EXAMPLES
143
192
  $ aoox deploy --tag v1.2.3
144
193
  ```
145
194
 
146
- _See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/deploy.ts)_
195
+ _See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/deploy.ts)_
196
+
197
+ ## `aoox domain clear`
198
+
199
+ Remove the custom domain of the panel itself and go back to IP access (IP:3000) through the running panel API
200
+
201
+ ```
202
+ USAGE
203
+ $ aoox domain clear [-t <value>] [-u <value>] [-y]
204
+
205
+ FLAGS
206
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
207
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
208
+ https://dashboard.example.com); defaults to the value from `aoox login`
209
+ -y, --yes Do not ask for confirmation
210
+
211
+ DESCRIPTION
212
+ Remove the custom domain of the panel itself and go back to IP access (IP:3000) through the running panel API
213
+
214
+ EXAMPLES
215
+ $ aoox domain clear
216
+
217
+ $ aoox domain clear --yes
218
+ ```
219
+
220
+ _See code: [src/commands/domain/clear.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/domain/clear.ts)_
147
221
 
148
222
  ## `aoox domain set`
149
223
 
@@ -151,7 +225,7 @@ Set a custom domain for the panel itself (not an application) through the runnin
151
225
 
152
226
  ```
153
227
  USAGE
154
- $ aoox domain set --api <value> --web <value> [-t <value>] [-u <value>] [--acme-email <value>]
228
+ $ aoox domain set --api <value> --web <value> [-t <value>] [-u <value>] [--acme-email <value>] [--domain-only]
155
229
 
156
230
  FLAGS
157
231
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
@@ -159,6 +233,9 @@ FLAGS
159
233
  https://dashboard.example.com); defaults to the value from `aoox login`
160
234
  --acme-email=<value> Email for the Let's Encrypt certificate
161
235
  --api=<value> (required) Domain for the panel API
236
+ --[no-]domain-only Only allow access through the domain: ports 3000/3001 listen on 127.0.0.1 only (default:
237
+ keep the current setting). Use --no-domain-only to open them again. Make sure the domain
238
+ works first, or you lose IP:port access
162
239
  --web=<value> (required) Domain for the panel dashboard
163
240
 
164
241
  DESCRIPTION
@@ -168,167 +245,256 @@ EXAMPLES
168
245
  $ aoox domain set --web panel.example.com --api api.example.com
169
246
 
170
247
  $ aoox domain set --web panel.example.com --api api.example.com --acme-email you@example.com
248
+
249
+ $ aoox domain set --web panel.example.com --api api.example.com --domain-only
171
250
  ```
172
251
 
173
- _See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/domain/set.ts)_
252
+ _See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/domain/set.ts)_
174
253
 
175
- ## `aoox env diff FROM TO`
254
+ ## `aoox env diff`
176
255
 
177
- Compare two environments key by key: which variables exist on one side only and which have different values. Prints names only, never values
256
+ Compare two environments of a variable set key by key: which variables exist on one side only and which have different values. Prints names only, never values
178
257
 
179
258
  ```
180
259
  USAGE
181
- $ aoox env diff FROM TO [--json] [-t <value>] [-u <value>] [--project <value>]
182
-
183
- ARGUMENTS
184
- FROM Environment to compare from
185
- TO Environment to compare to
260
+ $ aoox env diff --from <value> --to <value> [--json] [-t <value>] [-u <value>] [--stack <value> | --app
261
+ <value>] [-s <value>]
186
262
 
187
263
  FLAGS
188
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
189
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
190
- https://dashboard.example.com); defaults to the value from `aoox login`
191
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
264
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
265
+ you can see
266
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
267
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
268
+ https://dashboard.example.com); defaults to the value from `aoox login`
269
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
270
+ --from=<value> (required) Environment to compare from
271
+ --stack=<value> Compose stack ID, instead of an application
272
+ --to=<value> (required) Environment to compare to
192
273
 
193
274
  GLOBAL FLAGS
194
275
  --json Format output as json.
195
276
 
196
277
  DESCRIPTION
197
- Compare two environments key by key: which variables exist on one side only and which have different values. Prints
198
- names only, never values
278
+ Compare two environments of a variable set key by key: which variables exist on one side only and which have different
279
+ values. Prints names only, never values
199
280
 
200
281
  EXAMPLES
201
- $ aoox env diff staging production
282
+ $ aoox env diff --set shared --from staging --to production
202
283
  ```
203
284
 
204
- _See code: [src/commands/env/diff.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/diff.ts)_
285
+ _See code: [src/commands/env/diff.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/diff.ts)_
205
286
 
206
287
  ## `aoox env history`
207
288
 
208
- Show the version history of an environment: when, who, and which variable names were added (+), changed (~) or removed (-). Values are never shown
289
+ Show the version history of a variable set environment: when, who, and which variable names were added (+), changed (~) or removed (-). Values are never shown
209
290
 
210
291
  ```
211
292
  USAGE
212
- $ aoox env history [--json] [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--limit <value>]
293
+ $ aoox env history [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
294
+ <value>] [--limit <value>]
213
295
 
214
296
  FLAGS
215
- -e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
216
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
217
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
218
- https://dashboard.example.com); defaults to the value from `aoox login`
219
- --limit=<value> [default: 20] How many versions to show (newest first)
220
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
297
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
298
+ the set the linked application links
299
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
300
+ you can see
301
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
302
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
303
+ https://dashboard.example.com); defaults to the value from `aoox login`
304
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
305
+ --limit=<value> [default: 20] How many versions to show (newest first)
306
+ --stack=<value> Compose stack ID, instead of an application
221
307
 
222
308
  GLOBAL FLAGS
223
309
  --json Format output as json.
224
310
 
225
311
  DESCRIPTION
226
- Show the version history of an environment: when, who, and which variable names were added (+), changed (~) or removed
227
- (-). Values are never shown
312
+ Show the version history of a variable set environment: when, who, and which variable names were added (+), changed
313
+ (~) or removed (-). Values are never shown
228
314
 
229
315
  EXAMPLES
230
- $ aoox env history --env production
316
+ $ aoox env history --set shared --env production
231
317
 
232
318
  $ aoox env history --limit 5 --json
233
319
  ```
234
320
 
235
- _See code: [src/commands/env/history.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/history.ts)_
321
+ _See code: [src/commands/env/history.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/history.ts)_
322
+
323
+ ## `aoox env link`
324
+
325
+ Link a variable set environment to the linked application (or --stack). It is added last, so it wins over the other links, unless --position is given; an environment that is already linked is moved. Takes effect on the next deploy
326
+
327
+ ```
328
+ USAGE
329
+ $ aoox env link -e <value> -s <value> [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>]
330
+ [--position <value>]
331
+
332
+ FLAGS
333
+ -e, --env=<value> (required) Environment of the set
334
+ -s, --set=<value> (required) Variable set slug (or name)
335
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
336
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
337
+ https://dashboard.example.com); defaults to the value from `aoox login`
338
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
339
+ --position=<value> 1-based place in the list (1 = first, overridden by every later link). Default: last
340
+ --stack=<value> Compose stack ID, instead of an application
341
+
342
+ GLOBAL FLAGS
343
+ --json Format output as json.
344
+
345
+ DESCRIPTION
346
+ Link a variable set environment to the linked application (or --stack). It is added last, so it wins over the other
347
+ links, unless --position is given; an environment that is already linked is moved. Takes effect on the next deploy
348
+
349
+ EXAMPLES
350
+ $ aoox env link --set shared --env production
351
+
352
+ $ aoox env link --set defaults --env production --position 1
353
+ ```
354
+
355
+ _See code: [src/commands/env/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/link.ts)_
356
+
357
+ ## `aoox env links`
358
+
359
+ Show the variable set environments the linked application (or --stack) uses, in merge order, with the variables a later link or the own env overrides
360
+
361
+ ```
362
+ USAGE
363
+ $ aoox env links [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>]
364
+
365
+ FLAGS
366
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
367
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
368
+ https://dashboard.example.com); defaults to the value from `aoox login`
369
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
370
+ --stack=<value> Compose stack ID, instead of an application
371
+
372
+ GLOBAL FLAGS
373
+ --json Format output as json.
374
+
375
+ DESCRIPTION
376
+ Show the variable set environments the linked application (or --stack) uses, in merge order, with the variables a
377
+ later link or the own env overrides
378
+
379
+ EXAMPLES
380
+ $ aoox env links
381
+
382
+ $ aoox env links --stack <id>
383
+ ```
384
+
385
+ _See code: [src/commands/env/links.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/links.ts)_
236
386
 
237
387
  ## `aoox env list`
238
388
 
239
- List the project environments, or (with --env) the variable names of one. Values are masked unless --reveal is given
389
+ List the variable sets you can see and their environments (with --set: one set; with --env: the variable names of one environment). Values are masked unless --reveal is given
240
390
 
241
391
  ```
242
392
  USAGE
243
- $ aoox env list [--json] [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--reveal]
393
+ $ aoox env list [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [--reveal]
394
+ [-s <value>]
244
395
 
245
396
  FLAGS
246
- -e, --env=<value> Environment name; without it the environments of the project are listed
247
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
248
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
249
- https://dashboard.example.com); defaults to the value from `aoox login`
250
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
251
- --reveal Show the values (needs --env; the read is recorded in the audit log)
397
+ -e, --env=<value> Environment name; lists its variable names (the set defaults like in the other env commands)
398
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
399
+ you can see
400
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
401
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
402
+ https://dashboard.example.com); defaults to the value from `aoox login`
403
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
404
+ --reveal Show the values (needs --env; the read is recorded in the audit log)
405
+ --stack=<value> Compose stack ID, instead of an application
252
406
 
253
407
  GLOBAL FLAGS
254
408
  --json Format output as json.
255
409
 
256
410
  DESCRIPTION
257
- List the project environments, or (with --env) the variable names of one. Values are masked unless --reveal is given
411
+ List the variable sets you can see and their environments (with --set: one set; with --env: the variable names of one
412
+ environment). Values are masked unless --reveal is given
413
+
414
+ ALIASES
415
+ $ aoox env sets
258
416
 
259
417
  EXAMPLES
260
418
  $ aoox env list
261
419
 
262
- $ aoox env list --env staging
420
+ $ aoox env list --set shared
263
421
 
264
- $ aoox env list --env development --reveal
422
+ $ aoox env list --set shared --env staging
423
+
424
+ $ aoox env list --set shared --env development --reveal
265
425
  ```
266
426
 
267
- _See code: [src/commands/env/list.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/list.ts)_
427
+ _See code: [src/commands/env/list.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/list.ts)_
268
428
 
269
- ## `aoox env promote FROM TO`
429
+ ## `aoox env promote`
270
430
 
271
- Copy variables from one environment to another (name them, or use --all). Needs the right to read the source and to change the target. The target keeps its comments and order; new variables are appended. Shows what changes and asks before writing (unless --yes)
431
+ Copy variables (and their secret flag) from one environment of a variable set to another (name them, or use --all). Needs the right to read the source and to change the target. The target keeps its comments and order; new variables are appended. Shows what changes and asks before writing (unless --yes)
272
432
 
273
433
  ```
274
434
  USAGE
275
- $ aoox env promote FROM... TO... [-t <value>] [-u <value>] [--project <value>] [--all] [-y]
276
-
277
- ARGUMENTS
278
- FROM... Environment to copy the values from
279
- TO... Environment to copy the values into
435
+ $ aoox env promote --from <value> --to <value> [-t <value>] [-u <value>] [--stack <value> | --app <value>]
436
+ [--all] [-s <value>] [-y]
280
437
 
281
438
  FLAGS
282
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
283
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
284
- https://dashboard.example.com); defaults to the value from `aoox login`
285
- -y, --yes Do not ask for confirmation
286
- --all Promote every variable of the source (those already equal are skipped)
287
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
439
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
440
+ you can see
441
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
442
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
443
+ https://dashboard.example.com); defaults to the value from `aoox login`
444
+ -y, --yes Do not ask for confirmation
445
+ --all Promote every variable of the source (those already equal are skipped)
446
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
447
+ --from=<value> (required) Environment to copy the values from
448
+ --stack=<value> Compose stack ID, instead of an application
449
+ --to=<value> (required) Environment to copy the values into
288
450
 
289
451
  DESCRIPTION
290
- Copy variables from one environment to another (name them, or use --all). Needs the right to read the source and to
291
- change the target. The target keeps its comments and order; new variables are appended. Shows what changes and asks
292
- before writing (unless --yes)
452
+ Copy variables (and their secret flag) from one environment of a variable set to another (name them, or use --all).
453
+ Needs the right to read the source and to change the target. The target keeps its comments and order; new variables
454
+ are appended. Shows what changes and asks before writing (unless --yes)
293
455
 
294
456
  EXAMPLES
295
- $ aoox env promote staging production API_URL FEATURE_X
457
+ $ aoox env promote --set shared --from staging --to production API_URL FEATURE_X
296
458
 
297
- $ aoox env promote development staging --all --yes
459
+ $ aoox env promote --from development --to staging --all --yes
298
460
  ```
299
461
 
300
- _See code: [src/commands/env/promote.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/promote.ts)_
462
+ _See code: [src/commands/env/promote.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/promote.ts)_
301
463
 
302
464
  ## `aoox env pull`
303
465
 
304
- Write the variables of an environment to a local file (mode 0600), or to standard output with --file -. Refuses to overwrite unless --force. The read is recorded in the audit log
466
+ Write the variables of a variable set environment to a local file (mode 0600), or to standard output with --file -. Refuses to overwrite unless --force. The read is recorded in the audit log
305
467
 
306
468
  ```
307
469
  USAGE
308
- $ aoox env pull [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--file <value>] [--force]
309
- [--format dotenv|json|shell]
470
+ $ aoox env pull [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
471
+ [--file <value>] [--force] [--format dotenv|json|shell]
310
472
 
311
473
  FLAGS
312
- -e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
474
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment
475
+ of the set the linked application links
476
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only
477
+ set you can see
313
478
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
314
479
  -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
315
480
  https://dashboard.example.com); defaults to the value from `aoox login`
481
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
316
482
  --file=<value> File to write, relative to the current folder; "-" writes to standard output (nothing else is
317
483
  printed there). Default: .env, .env.json or .env.sh by format
318
484
  --force Overwrite the file if it exists
319
485
  --format=<option> [default: dotenv] dotenv (the stored text, comments kept), json ({"KEY":"value"}) or shell
320
486
  (export KEY='value' lines for eval)
321
487
  <options: dotenv|json|shell>
322
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
488
+ --stack=<value> Compose stack ID, instead of an application
323
489
 
324
490
  DESCRIPTION
325
- Write the variables of an environment to a local file (mode 0600), or to standard output with --file -. Refuses to
326
- overwrite unless --force. The read is recorded in the audit log
491
+ Write the variables of a variable set environment to a local file (mode 0600), or to standard output with --file -.
492
+ Refuses to overwrite unless --force. The read is recorded in the audit log
327
493
 
328
494
  EXAMPLES
329
495
  $ aoox env pull
330
496
 
331
- $ aoox env pull --env staging --file .env.staging
497
+ $ aoox env pull --set shared --env staging --file .env.staging
332
498
 
333
499
  $ aoox env pull --force
334
500
 
@@ -337,100 +503,188 @@ EXAMPLES
337
503
  $ aoox env pull --format shell --file -
338
504
  ```
339
505
 
340
- _See code: [src/commands/env/pull.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/pull.ts)_
506
+ _See code: [src/commands/env/pull.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/pull.ts)_
341
507
 
342
508
  ## `aoox env push`
343
509
 
344
- Replace the whole text of an environment with a local .env file. Shows what is added, changed and removed and asks before writing (unless --yes); the write fails if someone else changed the environment in between
510
+ Replace the whole text of a variable set environment with a local .env file. Shows what is added, changed and removed and asks before writing (unless --yes); the write fails if someone else changed the environment in between
345
511
 
346
512
  ```
347
513
  USAGE
348
- $ aoox env push --file <value> [-t <value>] [-u <value>] [--project <value>] [-e <value>] [-y]
514
+ $ aoox env push --file <value> [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
515
+ <value>] [-y]
349
516
 
350
517
  FLAGS
351
- -e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
352
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
353
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
354
- https://dashboard.example.com); defaults to the value from `aoox login`
355
- -y, --yes Do not ask for confirmation
356
- --file=<value> (required) The .env file to upload
357
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
518
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
519
+ the set the linked application links
520
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
521
+ you can see
522
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
523
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
524
+ https://dashboard.example.com); defaults to the value from `aoox login`
525
+ -y, --yes Do not ask for confirmation
526
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
527
+ --file=<value> (required) The .env file to upload
528
+ --stack=<value> Compose stack ID, instead of an application
358
529
 
359
530
  DESCRIPTION
360
- Replace the whole text of an environment with a local .env file. Shows what is added, changed and removed and asks
361
- before writing (unless --yes); the write fails if someone else changed the environment in between
531
+ Replace the whole text of a variable set environment with a local .env file. Shows what is added, changed and removed
532
+ and asks before writing (unless --yes); the write fails if someone else changed the environment in between
362
533
 
363
534
  EXAMPLES
364
535
  $ aoox env push --file .env
365
536
 
366
- $ aoox env push --file .env.staging --env staging --yes
537
+ $ aoox env push --file .env.staging --set shared --env staging --yes
367
538
  ```
368
539
 
369
- _See code: [src/commands/env/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/push.ts)_
540
+ _See code: [src/commands/env/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/push.ts)_
370
541
 
371
542
  ## `aoox env set ASSIGNMENTS`
372
543
 
373
- Set one or more variables in an environment. Existing comments and order are kept; the write fails if someone else changed the environment in between
544
+ Set one or more variables in a variable set environment. Existing comments and order are kept; the write fails if someone else changed the environment in between
374
545
 
375
546
  ```
376
547
  USAGE
377
- $ aoox env set ASSIGNMENTS... [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--secret]
548
+ $ aoox env set ASSIGNMENTS... [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
549
+ <value>] [--secret]
378
550
 
379
551
  ARGUMENTS
380
552
  ASSIGNMENTS... KEY=VALUE (the value is stored exactly as given)
381
553
 
382
554
  FLAGS
383
- -e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
384
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
385
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
386
- https://dashboard.example.com); defaults to the value from `aoox login`
387
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
388
- --[no-]secret Mark the variables as secret (--secret: always masked in logs) or explicitly not secret
389
- (--no-secret: never masked). Without either the flag is left as it is
555
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
556
+ the set the linked application links
557
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
558
+ you can see
559
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
560
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
561
+ https://dashboard.example.com); defaults to the value from `aoox login`
562
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
563
+ --[no-]secret Mark the variables as secret (--secret: always masked in logs) or explicitly not secret
564
+ (--no-secret: never masked). Without either the flag is left as it is
565
+ --stack=<value> Compose stack ID, instead of an application
390
566
 
391
567
  DESCRIPTION
392
- Set one or more variables in an environment. Existing comments and order are kept; the write fails if someone else
393
- changed the environment in between
568
+ Set one or more variables in a variable set environment. Existing comments and order are kept; the write fails if
569
+ someone else changed the environment in between
394
570
 
395
571
  EXAMPLES
396
- $ aoox env set API_URL=https://api.example.com
572
+ $ aoox env set API_URL=https://api.example.com --set shared --env production
397
573
 
398
574
  $ aoox env set GREETING="hello world" QUERY=a=b --env staging
399
575
 
400
576
  $ aoox env set API_TOKEN=abc123 --secret
401
577
  ```
402
578
 
403
- _See code: [src/commands/env/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/set.ts)_
579
+ _See code: [src/commands/env/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/set.ts)_
580
+
581
+ ## `aoox env sets`
582
+
583
+ List the variable sets you can see and their environments (with --set: one set; with --env: the variable names of one environment). Values are masked unless --reveal is given
584
+
585
+ ```
586
+ USAGE
587
+ $ aoox env sets [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [--reveal]
588
+ [-s <value>]
589
+
590
+ FLAGS
591
+ -e, --env=<value> Environment name; lists its variable names (the set defaults like in the other env commands)
592
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
593
+ you can see
594
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
595
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
596
+ https://dashboard.example.com); defaults to the value from `aoox login`
597
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
598
+ --reveal Show the values (needs --env; the read is recorded in the audit log)
599
+ --stack=<value> Compose stack ID, instead of an application
600
+
601
+ GLOBAL FLAGS
602
+ --json Format output as json.
603
+
604
+ DESCRIPTION
605
+ List the variable sets you can see and their environments (with --set: one set; with --env: the variable names of one
606
+ environment). Values are masked unless --reveal is given
607
+
608
+ ALIASES
609
+ $ aoox env sets
610
+
611
+ EXAMPLES
612
+ $ aoox env sets
613
+
614
+ $ aoox env sets --set shared
615
+
616
+ $ aoox env sets --set shared --env staging
617
+
618
+ $ aoox env sets --set shared --env development --reveal
619
+ ```
620
+
621
+ ## `aoox env unlink`
622
+
623
+ Remove a variable set environment from the linked application (or --stack). Name it with --set and --env, or with its --position from `aoox env links`. Takes effect on the next deploy
624
+
625
+ ```
626
+ USAGE
627
+ $ aoox env unlink [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [--position <value> |
628
+ -s <value> | -e <value>]
629
+
630
+ FLAGS
631
+ -e, --env=<value> Environment of the set
632
+ -s, --set=<value> Variable set slug (or name)
633
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
634
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
635
+ https://dashboard.example.com); defaults to the value from `aoox login`
636
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
637
+ --position=<value> 1-based position as shown by `aoox env links`
638
+ --stack=<value> Compose stack ID, instead of an application
639
+
640
+ GLOBAL FLAGS
641
+ --json Format output as json.
642
+
643
+ DESCRIPTION
644
+ Remove a variable set environment from the linked application (or --stack). Name it with --set and --env, or with its
645
+ --position from `aoox env links`. Takes effect on the next deploy
646
+
647
+ EXAMPLES
648
+ $ aoox env unlink --set shared --env staging
649
+
650
+ $ aoox env unlink --position 2
651
+ ```
652
+
653
+ _See code: [src/commands/env/unlink.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/unlink.ts)_
404
654
 
405
655
  ## `aoox env unset KEYS`
406
656
 
407
- Remove one or more variables from an environment. Comments and the other variables are kept; the write fails if someone else changed the environment in between
657
+ Remove one or more variables from a variable set environment. Comments and the other variables are kept; the write fails if someone else changed the environment in between
408
658
 
409
659
  ```
410
660
  USAGE
411
- $ aoox env unset KEYS... [-t <value>] [-u <value>] [--project <value>] [-e <value>]
661
+ $ aoox env unset KEYS... [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
412
662
 
413
663
  ARGUMENTS
414
664
  KEYS... Variable name(s) to remove
415
665
 
416
666
  FLAGS
417
- -e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
418
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
419
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
420
- https://dashboard.example.com); defaults to the value from `aoox login`
421
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
667
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
668
+ the set the linked application links
669
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
670
+ you can see
671
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
672
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
673
+ https://dashboard.example.com); defaults to the value from `aoox login`
674
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
675
+ --stack=<value> Compose stack ID, instead of an application
422
676
 
423
677
  DESCRIPTION
424
- Remove one or more variables from an environment. Comments and the other variables are kept; the write fails if
425
- someone else changed the environment in between
678
+ Remove one or more variables from a variable set environment. Comments and the other variables are kept; the write
679
+ fails if someone else changed the environment in between
426
680
 
427
681
  EXAMPLES
428
682
  $ aoox env unset OLD_KEY
429
683
 
430
- $ aoox env unset A B --env staging
684
+ $ aoox env unset A B --set shared --env staging
431
685
  ```
432
686
 
433
- _See code: [src/commands/env/unset.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/unset.ts)_
687
+ _See code: [src/commands/env/unset.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/env/unset.ts)_
434
688
 
435
689
  ## `aoox help [COMMAND]`
436
690
 
@@ -459,23 +713,31 @@ Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
459
713
  ```
460
714
  USAGE
461
715
  $ aoox install [--acme-email <value>] [--admin-name <value> --admin-email <value>] [--admin-password
462
- <value> ] [--api-domain <value> --web-domain <value>] [--dir <value>] [--force] [--no-terminal-authorize]
463
- [--terminal-ssh-user <value>] [-y]
716
+ <value> ] [--api-domain <value> --web-domain <value>] [--confirm-wipe <value>] [--dir <value>] [--force]
717
+ [--new-secrets] [--no-terminal-authorize] [--terminal-ssh-user <value>] [--wipe-data] [-y]
464
718
 
465
719
  FLAGS
466
- -y, --yes Do not ask for any confirmation
720
+ -y, --yes Do not ask for any confirmation (does not confirm a wipe)
467
721
  --acme-email=<value> Required with --web-domain/--api-domain (Let’s Encrypt)
468
722
  --admin-email=<value> Create the first owner without going through /setup in the browser
469
723
  --admin-name=<value> Name of the first owner
470
724
  --admin-password=<value> Password of the first owner (min. 8 characters)
471
725
  --api-domain=<value> Domain for the API, served through the bundled proxy
726
+ --confirm-wipe=<value> Non-interactive confirmation for --wipe-data: must be exactly the install directory
727
+ (--yes alone is not enough)
472
728
  --dir=<value> [default: /opt/aoox] Installation directory
473
- --force Overwrite an existing installation in --dir
729
+ --force Reinstall over an existing installation in --dir: previous files are backed up to
730
+ <dir>/backups/ and existing secrets and values are kept (data survives)
731
+ --new-secrets Only with --force --wipe-data: generate new secrets for a completely fresh install
732
+ (DELETES all panel data)
474
733
  --no-terminal-authorize Do not create/authorize the web Terminal SSH key automatically (do it in Settings >
475
734
  Terminal instead)
476
735
  --terminal-ssh-user=<value> SSH user the web Terminal uses to log in to this host (default: the user running
477
736
  sudo, or root if there is none)
478
737
  --web-domain=<value> Domain for the web panel, served through the bundled proxy
738
+ --wipe-data Only with --force --new-secrets: run `docker compose down -v` first, removing the
739
+ panel database volume (and any leftover panel volumes from an earlier install)
740
+ (DELETES all panel data)
479
741
 
480
742
  DESCRIPTION
481
743
  Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
@@ -484,13 +746,17 @@ EXAMPLES
484
746
  sudo aoox install
485
747
 
486
748
  sudo aoox install --web-domain panel.example.com --api-domain api.panel.example.com --acme-email me@example.com
749
+
750
+ sudo aoox install --force # reinstall over an existing install, keeping data and secrets
751
+
752
+ sudo aoox install --force --new-secrets --wipe-data # start from scratch (deletes all panel data)
487
753
  ```
488
754
 
489
- _See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/install.ts)_
755
+ _See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/install.ts)_
490
756
 
491
757
  ## `aoox link`
492
758
 
493
- Link this folder to an application in the panel (used by `aoox deploy`/`aoox logs`)
759
+ Link this folder to an application in the panel (used by `aoox deploy`, `aoox run` without `--set`/`--env`, and the `aoox env` defaults and links)
494
760
 
495
761
  ```
496
762
  USAGE
@@ -504,7 +770,8 @@ FLAGS
504
770
  --project=<value> Project ID; skip the interactive selection
505
771
 
506
772
  DESCRIPTION
507
- Link this folder to an application in the panel (used by `aoox deploy`/`aoox logs`)
773
+ Link this folder to an application in the panel (used by `aoox deploy`, `aoox run` without `--set`/`--env`, and the
774
+ `aoox env` defaults and links)
508
775
 
509
776
  EXAMPLES
510
777
  $ aoox link
@@ -512,7 +779,7 @@ EXAMPLES
512
779
  $ aoox link --project <id> --app <id>
513
780
  ```
514
781
 
515
- _See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/link.ts)_
782
+ _See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/link.ts)_
516
783
 
517
784
  ## `aoox login`
518
785
 
@@ -538,7 +805,7 @@ EXAMPLES
538
805
  $ aoox login --url 203.0.113.10:3000 --token aoox_xxx
539
806
  ```
540
807
 
541
- _See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/login.ts)_
808
+ _See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/login.ts)_
542
809
 
543
810
  ## `aoox plugins`
544
811
 
@@ -830,34 +1097,45 @@ DESCRIPTION
830
1097
 
831
1098
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.5.2/src/commands/plugins/update.ts)_
832
1099
 
833
- ## `aoox registry build IMAGE`
1100
+ ## `aoox registry build [IMAGE]`
834
1101
 
835
- Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
1102
+ Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there). A name or version you leave out is taken from the project (you confirm it first, or pass --yes)
836
1103
 
837
1104
  ```
838
1105
  USAGE
839
- $ aoox registry build IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>] [--context <value>] [-f
840
- <value>] [--push]
1106
+ $ aoox registry build [IMAGE] [-t <value>] [-u <value>] [--force] [--registry <value>] [-y] [--context <value>]
1107
+ [-f <value>] [--push]
841
1108
 
842
1109
  ARGUMENTS
843
- IMAGE Image name and version, e.g. myapp:1.0.0
1110
+ [IMAGE] Image name and version, e.g. myapp:1.0.0. Omit it (or the version) to read them from the project in the build
1111
+ context: package.json, pyproject.toml, Cargo.toml, composer.json, pubspec.yaml, *.csproj, pom.xml, a VERSION
1112
+ file or a git tag
844
1113
 
845
1114
  FLAGS
846
1115
  -f, --dockerfile=<value> [default: Dockerfile] Path to the Dockerfile
847
1116
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
848
1117
  -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
849
1118
  https://dashboard.example.com); defaults to the value from `aoox login`
1119
+ -y, --yes Do not ask to confirm an image name or version taken from the project
850
1120
  --context=<value> [default: .] Docker build context
851
- --force Overwrite a version that already exists in the registry
1121
+ --force Overwrite a version that already exists in the registry (also lets a version be taken from a
1122
+ git tag HEAD is past)
852
1123
  --push Push the image to the registry right after the build
853
1124
  --registry=<value> Registry ID; defaults to the self-hosted registry
854
1125
 
855
1126
  DESCRIPTION
856
- Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
1127
+ Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there). A name or
1128
+ version you leave out is taken from the project (you confirm it first, or pass --yes)
857
1129
 
858
1130
  EXAMPLES
859
1131
  $ aoox registry build myapp:1.0.0
860
1132
 
1133
+ $ aoox registry build --push
1134
+
1135
+ $ aoox registry build myapp --context ./app
1136
+
1137
+ $ aoox registry build --push --yes
1138
+
861
1139
  $ aoox registry build myapp:1.0.0 --push
862
1140
 
863
1141
  $ aoox registry build team/api:2.1.0 -f docker/Dockerfile --context .
@@ -865,7 +1143,7 @@ EXAMPLES
865
1143
  $ aoox registry build myapp:1.0.0 --force
866
1144
  ```
867
1145
 
868
- _See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/registry/build.ts)_
1146
+ _See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/registry/build.ts)_
869
1147
 
870
1148
  ## `aoox registry domain`
871
1149
 
@@ -891,38 +1169,74 @@ EXAMPLES
891
1169
  $ aoox registry domain --clear
892
1170
  ```
893
1171
 
894
- _See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/registry/domain.ts)_
1172
+ _See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/registry/domain.ts)_
895
1173
 
896
- ## `aoox registry push IMAGE`
1174
+ ## `aoox registry password`
897
1175
 
898
- Push a local image to the aoox registry (refuses a version that already exists there)
1176
+ Show or reset the password of the self-hosted registry
899
1177
 
900
1178
  ```
901
1179
  USAGE
902
- $ aoox registry push IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>]
1180
+ $ aoox registry password [-t <value>] [-u <value>] [--reset] [--show] [-y]
1181
+
1182
+ FLAGS
1183
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1184
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1185
+ https://dashboard.example.com); defaults to the value from `aoox login`
1186
+ -y, --yes Confirm --reset without asking
1187
+ --reset Generate a new password (owner only). Images are kept; docker login again afterwards
1188
+ --show Print the current username, address and password
1189
+
1190
+ DESCRIPTION
1191
+ Show or reset the password of the self-hosted registry
1192
+
1193
+ EXAMPLES
1194
+ $ aoox registry password --show
1195
+
1196
+ $ aoox registry password --reset --yes
1197
+ ```
1198
+
1199
+ _See code: [src/commands/registry/password.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/registry/password.ts)_
1200
+
1201
+ ## `aoox registry push [IMAGE]`
1202
+
1203
+ Push a local image to the aoox registry (refuses a version that already exists there). A name or version you leave out is taken from the project (you confirm it first, or pass --yes)
1204
+
1205
+ ```
1206
+ USAGE
1207
+ $ aoox registry push [IMAGE] [-t <value>] [-u <value>] [--force] [--registry <value>] [-y]
903
1208
 
904
1209
  ARGUMENTS
905
- IMAGE Image name and version (short or full), e.g. myapp:1.0.0
1210
+ [IMAGE] Image name and version (short or full), e.g. myapp:1.0.0. Omit it (or the version) to read them from the
1211
+ project in the current directory: package.json, pyproject.toml, Cargo.toml, composer.json, pubspec.yaml,
1212
+ *.csproj, pom.xml, a VERSION file or a git tag
906
1213
 
907
1214
  FLAGS
908
1215
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
909
1216
  -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
910
1217
  https://dashboard.example.com); defaults to the value from `aoox login`
911
- --force Overwrite a version that already exists in the registry
1218
+ -y, --yes Do not ask to confirm an image name or version taken from the project
1219
+ --force Overwrite a version that already exists in the registry (also lets a version be taken from a
1220
+ git tag HEAD is past)
912
1221
  --registry=<value> Registry ID; defaults to the self-hosted registry
913
1222
 
914
1223
  DESCRIPTION
915
- Push a local image to the aoox registry (refuses a version that already exists there)
1224
+ Push a local image to the aoox registry (refuses a version that already exists there). A name or version you leave out
1225
+ is taken from the project (you confirm it first, or pass --yes)
916
1226
 
917
1227
  EXAMPLES
918
1228
  $ aoox registry push myapp:1.0.0
919
1229
 
1230
+ $ aoox registry push
1231
+
1232
+ $ aoox registry push myapp
1233
+
920
1234
  $ aoox registry push registry.example.com/myapp:1.0.0
921
1235
 
922
1236
  $ aoox registry push myapp:1.0.0 --force
923
1237
  ```
924
1238
 
925
- _See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/registry/push.ts)_
1239
+ _See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/registry/push.ts)_
926
1240
 
927
1241
  ## `aoox reinstall`
928
1242
 
@@ -952,38 +1266,52 @@ EXAMPLES
952
1266
  sudo aoox reinstall --yes --terminal-ssh-user root
953
1267
  ```
954
1268
 
955
- _See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/reinstall.ts)_
1269
+ _See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/reinstall.ts)_
956
1270
 
957
1271
  ## `aoox run`
958
1272
 
959
- Run a command with the variables of an environment, without writing them to disk. Put the command after `--`; its exit code is forwarded. The read is recorded in the audit log
1273
+ Run a command with the variables the linked application gets at deploy time, without writing them to disk: its linked variable set environments in order (a later one wins), then its own env on top. With --set/--env, exactly one set environment instead. Put the command after `--`; its exit code is forwarded. Before the command starts, one line on stderr says how many variables aoox injects and from which layers (colour only on a terminal; NO_COLOR turns it off, FORCE_COLOR forces it); --quiet hides it, but never the warnings. Every read is recorded in the audit log
960
1274
 
961
1275
  ```
962
1276
  USAGE
963
- $ aoox run [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--file <value>]
1277
+ $ aoox run [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
1278
+ [--file <value>] [-q]
964
1279
 
965
1280
  FLAGS
966
- -e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
967
- -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
968
- -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
969
- https://dashboard.example.com); defaults to the value from `aoox login`
970
- --file=<value> A local .env file layered on top of the environment (it wins over aoox, which wins over the
971
- current environment). Only read, never written
972
- --project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
1281
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
1282
+ the set the linked application links
1283
+ -q, --quiet Do not print the "Injecting N variables" line or the informational notes. Warnings about
1284
+ unresolved references and excluded Infisical secrets are always printed
1285
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
1286
+ you can see
1287
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1288
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1289
+ https://dashboard.example.com); defaults to the value from `aoox login`
1290
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
1291
+ --file=<value> A local .env file layered on top (it wins over aoox, which wins over the current environment).
1292
+ Only read, never written
1293
+ --stack=<value> Compose stack ID, instead of an application
973
1294
 
974
1295
  DESCRIPTION
975
- Run a command with the variables of an environment, without writing them to disk. Put the command after `--`; its exit
976
- code is forwarded. The read is recorded in the audit log
1296
+ Run a command with the variables the linked application gets at deploy time, without writing them to disk: its linked
1297
+ variable set environments in order (a later one wins), then its own env on top. With --set/--env, exactly one set
1298
+ environment instead. Put the command after `--`; its exit code is forwarded. Before the command starts, one line on
1299
+ stderr says how many variables aoox injects and from which layers (colour only on a terminal; NO_COLOR turns it off,
1300
+ FORCE_COLOR forces it); --quiet hides it, but never the warnings. Every read is recorded in the audit log
977
1301
 
978
1302
  EXAMPLES
979
1303
  $ aoox run -- npm run dev
980
1304
 
981
- $ aoox run --env staging -- node server.js
1305
+ $ aoox run --set shared --env staging -- node server.js
982
1306
 
983
1307
  $ aoox run --file .env.local -- npm run dev
1308
+
1309
+ $ aoox run --stack <id> -- docker compose config
1310
+
1311
+ $ aoox run --quiet -- npm run dev
984
1312
  ```
985
1313
 
986
- _See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/run.ts)_
1314
+ _See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/run.ts)_
987
1315
 
988
1316
  ## `aoox update`
989
1317
 
@@ -1005,7 +1333,7 @@ EXAMPLES
1005
1333
  $ aoox update --check
1006
1334
  ```
1007
1335
 
1008
- _See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/update.ts)_
1336
+ _See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/update.ts)_
1009
1337
 
1010
1338
  ## `aoox update panel`
1011
1339
 
@@ -1030,7 +1358,7 @@ EXAMPLES
1030
1358
  $ aoox update panel --apply
1031
1359
  ```
1032
1360
 
1033
- _See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/update/panel.ts)_
1361
+ _See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/update/panel.ts)_
1034
1362
 
1035
1363
  ## `aoox whoami`
1036
1364
 
@@ -1057,7 +1385,7 @@ EXAMPLES
1057
1385
  $ aoox whoami --json
1058
1386
  ```
1059
1387
 
1060
- _See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/whoami.ts)_
1388
+ _See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/whoami.ts)_
1061
1389
  <!-- commandsstop -->
1062
1390
 
1063
1391
  ## Versioning