@hideandseeklab/aoox 0.1.0-alpha.8 → 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 (100) hide show
  1. package/README.md +666 -35
  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 +14 -8
  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 +18 -0
  11. package/dist/commands/env/diff.js +51 -0
  12. package/dist/commands/env/history.d.ts +17 -0
  13. package/dist/commands/env/history.js +48 -0
  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 +40 -0
  19. package/dist/commands/env/list.js +120 -0
  20. package/dist/commands/env/promote.d.ts +20 -0
  21. package/dist/commands/env/promote.js +96 -0
  22. package/dist/commands/env/pull.d.ts +17 -0
  23. package/dist/commands/env/pull.js +69 -0
  24. package/dist/commands/env/push.d.ts +17 -0
  25. package/dist/commands/env/push.js +70 -0
  26. package/dist/commands/env/set.d.ts +19 -0
  27. package/dist/commands/env/set.js +60 -0
  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 +18 -0
  31. package/dist/commands/env/unset.js +45 -0
  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 +7 -3
  37. package/dist/commands/registry/build.js +23 -8
  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 +10 -13
  43. package/dist/commands/reinstall.js +26 -20
  44. package/dist/commands/run.d.ts +23 -0
  45. package/dist/commands/run.js +163 -0
  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/connection-summary.d.ts +11 -4
  53. package/dist/lib/connection-summary.js +46 -11
  54. package/dist/lib/discovery.d.ts +24 -2
  55. package/dist/lib/discovery.js +97 -3
  56. package/dist/lib/docker.d.ts +9 -1
  57. package/dist/lib/docker.js +32 -2
  58. package/dist/lib/env-command.d.ts +109 -0
  59. package/dist/lib/env-command.js +230 -0
  60. package/dist/lib/env-file.d.ts +21 -0
  61. package/dist/lib/env-file.js +61 -0
  62. package/dist/lib/env-plan.d.ts +23 -0
  63. package/dist/lib/env-plan.js +34 -0
  64. package/dist/lib/env-run.d.ts +24 -0
  65. package/dist/lib/env-run.js +56 -0
  66. package/dist/lib/env-text.d.ts +97 -0
  67. package/dist/lib/env-text.js +266 -0
  68. package/dist/lib/image-confirm.d.ts +38 -0
  69. package/dist/lib/image-confirm.js +102 -0
  70. package/dist/lib/image-source.d.ts +59 -0
  71. package/dist/lib/image-source.js +261 -0
  72. package/dist/lib/install-plan.d.ts +69 -0
  73. package/dist/lib/install-plan.js +86 -0
  74. package/dist/lib/interrupt.d.ts +19 -0
  75. package/dist/lib/interrupt.js +42 -0
  76. package/dist/lib/leftover-volumes.d.ts +18 -0
  77. package/dist/lib/leftover-volumes.js +69 -0
  78. package/dist/lib/link-command.d.ts +9 -0
  79. package/dist/lib/link-command.js +23 -0
  80. package/dist/lib/manifest-parsers.d.ts +23 -0
  81. package/dist/lib/manifest-parsers.js +152 -0
  82. package/dist/lib/panel-addresses.d.ts +35 -0
  83. package/dist/lib/panel-addresses.js +122 -0
  84. package/dist/lib/registry-image-command.d.ts +24 -3
  85. package/dist/lib/registry-image-command.js +71 -10
  86. package/dist/lib/reinstall.d.ts +7 -0
  87. package/dist/lib/reinstall.js +28 -0
  88. package/dist/lib/run-banner.d.ts +18 -0
  89. package/dist/lib/run-banner.js +20 -0
  90. package/dist/lib/self-update.d.ts +4 -3
  91. package/dist/lib/self-update.js +6 -8
  92. package/dist/lib/style.d.ts +34 -0
  93. package/dist/lib/style.js +75 -0
  94. package/dist/lib/system-ca.d.ts +20 -0
  95. package/dist/lib/system-ca.js +29 -0
  96. package/dist/lib/types.d.ts +132 -0
  97. package/dist/lib/variable-sets.d.ts +90 -0
  98. package/dist/lib/variable-sets.js +177 -0
  99. package/oclif.manifest.json +1329 -72
  100. package/package.json +4 -1
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.8 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,10 +81,66 @@ 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)
132
+ * [`aoox env diff`](#aoox-env-diff)
133
+ * [`aoox env history`](#aoox-env-history)
134
+ * [`aoox env link`](#aoox-env-link)
135
+ * [`aoox env links`](#aoox-env-links)
136
+ * [`aoox env list`](#aoox-env-list)
137
+ * [`aoox env promote`](#aoox-env-promote)
138
+ * [`aoox env pull`](#aoox-env-pull)
139
+ * [`aoox env push`](#aoox-env-push)
140
+ * [`aoox env set ASSIGNMENTS`](#aoox-env-set-assignments)
141
+ * [`aoox env sets`](#aoox-env-sets)
142
+ * [`aoox env unlink`](#aoox-env-unlink)
143
+ * [`aoox env unset KEYS`](#aoox-env-unset-keys)
88
144
  * [`aoox help [COMMAND]`](#aoox-help-command)
89
145
  * [`aoox install`](#aoox-install)
90
146
  * [`aoox link`](#aoox-link)
@@ -99,10 +155,12 @@ npm link # or: npm install -g .
99
155
  * [`aoox plugins uninstall [PLUGIN]`](#aoox-plugins-uninstall-plugin)
100
156
  * [`aoox plugins unlink [PLUGIN]`](#aoox-plugins-unlink-plugin)
101
157
  * [`aoox plugins update`](#aoox-plugins-update)
102
- * [`aoox registry build IMAGE`](#aoox-registry-build-image)
158
+ * [`aoox registry build [IMAGE]`](#aoox-registry-build-image)
103
159
  * [`aoox registry domain`](#aoox-registry-domain)
104
- * [`aoox registry push IMAGE`](#aoox-registry-push-image)
160
+ * [`aoox registry password`](#aoox-registry-password)
161
+ * [`aoox registry push [IMAGE]`](#aoox-registry-push-image)
105
162
  * [`aoox reinstall`](#aoox-reinstall)
163
+ * [`aoox run`](#aoox-run)
106
164
  * [`aoox update`](#aoox-update)
107
165
  * [`aoox update panel`](#aoox-update-panel)
108
166
  * [`aoox whoami`](#aoox-whoami)
@@ -134,7 +192,32 @@ EXAMPLES
134
192
  $ aoox deploy --tag v1.2.3
135
193
  ```
136
194
 
137
- _See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
138
221
 
139
222
  ## `aoox domain set`
140
223
 
@@ -142,7 +225,7 @@ Set a custom domain for the panel itself (not an application) through the runnin
142
225
 
143
226
  ```
144
227
  USAGE
145
- $ 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]
146
229
 
147
230
  FLAGS
148
231
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
@@ -150,6 +233,9 @@ FLAGS
150
233
  https://dashboard.example.com); defaults to the value from `aoox login`
151
234
  --acme-email=<value> Email for the Let's Encrypt certificate
152
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
153
239
  --web=<value> (required) Domain for the panel dashboard
154
240
 
155
241
  DESCRIPTION
@@ -159,9 +245,446 @@ EXAMPLES
159
245
  $ aoox domain set --web panel.example.com --api api.example.com
160
246
 
161
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
250
+ ```
251
+
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)_
253
+
254
+ ## `aoox env diff`
255
+
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
257
+
258
+ ```
259
+ USAGE
260
+ $ aoox env diff --from <value> --to <value> [--json] [-t <value>] [-u <value>] [--stack <value> | --app
261
+ <value>] [-s <value>]
262
+
263
+ FLAGS
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
273
+
274
+ GLOBAL FLAGS
275
+ --json Format output as json.
276
+
277
+ DESCRIPTION
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
280
+
281
+ EXAMPLES
282
+ $ aoox env diff --set shared --from staging --to production
283
+ ```
284
+
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)_
286
+
287
+ ## `aoox env history`
288
+
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
290
+
291
+ ```
292
+ USAGE
293
+ $ aoox env history [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
294
+ <value>] [--limit <value>]
295
+
296
+ FLAGS
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
307
+
308
+ GLOBAL FLAGS
309
+ --json Format output as json.
310
+
311
+ DESCRIPTION
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
314
+
315
+ EXAMPLES
316
+ $ aoox env history --set shared --env production
317
+
318
+ $ aoox env history --limit 5 --json
319
+ ```
320
+
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>
162
383
  ```
163
384
 
164
- _See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/src/commands/domain/set.ts)_
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)_
386
+
387
+ ## `aoox env list`
388
+
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
390
+
391
+ ```
392
+ USAGE
393
+ $ aoox env list [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [--reveal]
394
+ [-s <value>]
395
+
396
+ FLAGS
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
406
+
407
+ GLOBAL FLAGS
408
+ --json Format output as json.
409
+
410
+ DESCRIPTION
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
416
+
417
+ EXAMPLES
418
+ $ aoox env list
419
+
420
+ $ aoox env list --set shared
421
+
422
+ $ aoox env list --set shared --env staging
423
+
424
+ $ aoox env list --set shared --env development --reveal
425
+ ```
426
+
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)_
428
+
429
+ ## `aoox env promote`
430
+
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)
432
+
433
+ ```
434
+ USAGE
435
+ $ aoox env promote --from <value> --to <value> [-t <value>] [-u <value>] [--stack <value> | --app <value>]
436
+ [--all] [-s <value>] [-y]
437
+
438
+ FLAGS
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
450
+
451
+ DESCRIPTION
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)
455
+
456
+ EXAMPLES
457
+ $ aoox env promote --set shared --from staging --to production API_URL FEATURE_X
458
+
459
+ $ aoox env promote --from development --to staging --all --yes
460
+ ```
461
+
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)_
463
+
464
+ ## `aoox env pull`
465
+
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
467
+
468
+ ```
469
+ USAGE
470
+ $ aoox env pull [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
471
+ [--file <value>] [--force] [--format dotenv|json|shell]
472
+
473
+ FLAGS
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
478
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
479
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
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`
482
+ --file=<value> File to write, relative to the current folder; "-" writes to standard output (nothing else is
483
+ printed there). Default: .env, .env.json or .env.sh by format
484
+ --force Overwrite the file if it exists
485
+ --format=<option> [default: dotenv] dotenv (the stored text, comments kept), json ({"KEY":"value"}) or shell
486
+ (export KEY='value' lines for eval)
487
+ <options: dotenv|json|shell>
488
+ --stack=<value> Compose stack ID, instead of an application
489
+
490
+ DESCRIPTION
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
493
+
494
+ EXAMPLES
495
+ $ aoox env pull
496
+
497
+ $ aoox env pull --set shared --env staging --file .env.staging
498
+
499
+ $ aoox env pull --force
500
+
501
+ $ aoox env pull --format json --file -
502
+
503
+ $ aoox env pull --format shell --file -
504
+ ```
505
+
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)_
507
+
508
+ ## `aoox env push`
509
+
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
511
+
512
+ ```
513
+ USAGE
514
+ $ aoox env push --file <value> [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
515
+ <value>] [-y]
516
+
517
+ FLAGS
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
529
+
530
+ DESCRIPTION
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
533
+
534
+ EXAMPLES
535
+ $ aoox env push --file .env
536
+
537
+ $ aoox env push --file .env.staging --set shared --env staging --yes
538
+ ```
539
+
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)_
541
+
542
+ ## `aoox env set ASSIGNMENTS`
543
+
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
545
+
546
+ ```
547
+ USAGE
548
+ $ aoox env set ASSIGNMENTS... [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
549
+ <value>] [--secret]
550
+
551
+ ARGUMENTS
552
+ ASSIGNMENTS... KEY=VALUE (the value is stored exactly as given)
553
+
554
+ FLAGS
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
566
+
567
+ DESCRIPTION
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
570
+
571
+ EXAMPLES
572
+ $ aoox env set API_URL=https://api.example.com --set shared --env production
573
+
574
+ $ aoox env set GREETING="hello world" QUERY=a=b --env staging
575
+
576
+ $ aoox env set API_TOKEN=abc123 --secret
577
+ ```
578
+
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)_
654
+
655
+ ## `aoox env unset KEYS`
656
+
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
658
+
659
+ ```
660
+ USAGE
661
+ $ aoox env unset KEYS... [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
662
+
663
+ ARGUMENTS
664
+ KEYS... Variable name(s) to remove
665
+
666
+ FLAGS
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
676
+
677
+ DESCRIPTION
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
680
+
681
+ EXAMPLES
682
+ $ aoox env unset OLD_KEY
683
+
684
+ $ aoox env unset A B --set shared --env staging
685
+ ```
686
+
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)_
165
688
 
166
689
  ## `aoox help [COMMAND]`
167
690
 
@@ -190,23 +713,31 @@ Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
190
713
  ```
191
714
  USAGE
192
715
  $ aoox install [--acme-email <value>] [--admin-name <value> --admin-email <value>] [--admin-password
193
- <value> ] [--api-domain <value> --web-domain <value>] [--dir <value>] [--force] [--no-terminal-authorize]
194
- [--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]
195
718
 
196
719
  FLAGS
197
- -y, --yes Do not ask for any confirmation
720
+ -y, --yes Do not ask for any confirmation (does not confirm a wipe)
198
721
  --acme-email=<value> Required with --web-domain/--api-domain (Let’s Encrypt)
199
722
  --admin-email=<value> Create the first owner without going through /setup in the browser
200
723
  --admin-name=<value> Name of the first owner
201
724
  --admin-password=<value> Password of the first owner (min. 8 characters)
202
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)
203
728
  --dir=<value> [default: /opt/aoox] Installation directory
204
- --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)
205
733
  --no-terminal-authorize Do not create/authorize the web Terminal SSH key automatically (do it in Settings >
206
734
  Terminal instead)
207
735
  --terminal-ssh-user=<value> SSH user the web Terminal uses to log in to this host (default: the user running
208
736
  sudo, or root if there is none)
209
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)
210
741
 
211
742
  DESCRIPTION
212
743
  Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
@@ -215,13 +746,17 @@ EXAMPLES
215
746
  sudo aoox install
216
747
 
217
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)
218
753
  ```
219
754
 
220
- _See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
221
756
 
222
757
  ## `aoox link`
223
758
 
224
- 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)
225
760
 
226
761
  ```
227
762
  USAGE
@@ -235,7 +770,8 @@ FLAGS
235
770
  --project=<value> Project ID; skip the interactive selection
236
771
 
237
772
  DESCRIPTION
238
- 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)
239
775
 
240
776
  EXAMPLES
241
777
  $ aoox link
@@ -243,7 +779,7 @@ EXAMPLES
243
779
  $ aoox link --project <id> --app <id>
244
780
  ```
245
781
 
246
- _See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
247
783
 
248
784
  ## `aoox login`
249
785
 
@@ -269,7 +805,7 @@ EXAMPLES
269
805
  $ aoox login --url 203.0.113.10:3000 --token aoox_xxx
270
806
  ```
271
807
 
272
- _See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
273
809
 
274
810
  ## `aoox plugins`
275
811
 
@@ -561,39 +1097,53 @@ DESCRIPTION
561
1097
 
562
1098
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.5.2/src/commands/plugins/update.ts)_
563
1099
 
564
- ## `aoox registry build IMAGE`
1100
+ ## `aoox registry build [IMAGE]`
565
1101
 
566
- 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)
567
1103
 
568
1104
  ```
569
1105
  USAGE
570
- $ aoox registry build IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>] [--context <value>] [-f
571
- <value>]
1106
+ $ aoox registry build [IMAGE] [-t <value>] [-u <value>] [--force] [--registry <value>] [-y] [--context <value>]
1107
+ [-f <value>] [--push]
572
1108
 
573
1109
  ARGUMENTS
574
- 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
575
1113
 
576
1114
  FLAGS
577
1115
  -f, --dockerfile=<value> [default: Dockerfile] Path to the Dockerfile
578
1116
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
579
1117
  -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
580
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
581
1120
  --context=<value> [default: .] Docker build context
582
- --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)
1123
+ --push Push the image to the registry right after the build
583
1124
  --registry=<value> Registry ID; defaults to the self-hosted registry
584
1125
 
585
1126
  DESCRIPTION
586
- 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)
587
1129
 
588
1130
  EXAMPLES
589
1131
  $ aoox registry build myapp:1.0.0
590
1132
 
1133
+ $ aoox registry build --push
1134
+
1135
+ $ aoox registry build myapp --context ./app
1136
+
1137
+ $ aoox registry build --push --yes
1138
+
1139
+ $ aoox registry build myapp:1.0.0 --push
1140
+
591
1141
  $ aoox registry build team/api:2.1.0 -f docker/Dockerfile --context .
592
1142
 
593
1143
  $ aoox registry build myapp:1.0.0 --force
594
1144
  ```
595
1145
 
596
- _See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
597
1147
 
598
1148
  ## `aoox registry domain`
599
1149
 
@@ -619,38 +1169,74 @@ EXAMPLES
619
1169
  $ aoox registry domain --clear
620
1170
  ```
621
1171
 
622
- _See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
623
1173
 
624
- ## `aoox registry push IMAGE`
1174
+ ## `aoox registry password`
625
1175
 
626
- 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
627
1177
 
628
1178
  ```
629
1179
  USAGE
630
- $ 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]
631
1208
 
632
1209
  ARGUMENTS
633
- 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
634
1213
 
635
1214
  FLAGS
636
1215
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
637
1216
  -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
638
1217
  https://dashboard.example.com); defaults to the value from `aoox login`
639
- --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)
640
1221
  --registry=<value> Registry ID; defaults to the self-hosted registry
641
1222
 
642
1223
  DESCRIPTION
643
- 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)
644
1226
 
645
1227
  EXAMPLES
646
1228
  $ aoox registry push myapp:1.0.0
647
1229
 
1230
+ $ aoox registry push
1231
+
1232
+ $ aoox registry push myapp
1233
+
648
1234
  $ aoox registry push registry.example.com/myapp:1.0.0
649
1235
 
650
1236
  $ aoox registry push myapp:1.0.0 --force
651
1237
  ```
652
1238
 
653
- _See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
654
1240
 
655
1241
  ## `aoox reinstall`
656
1242
 
@@ -680,7 +1266,52 @@ EXAMPLES
680
1266
  sudo aoox reinstall --yes --terminal-ssh-user root
681
1267
  ```
682
1268
 
683
- _See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
1270
+
1271
+ ## `aoox run`
1272
+
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
1274
+
1275
+ ```
1276
+ USAGE
1277
+ $ aoox run [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
1278
+ [--file <value>] [-q]
1279
+
1280
+ FLAGS
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
1294
+
1295
+ DESCRIPTION
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
1301
+
1302
+ EXAMPLES
1303
+ $ aoox run -- npm run dev
1304
+
1305
+ $ aoox run --set shared --env staging -- node server.js
1306
+
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
1312
+ ```
1313
+
1314
+ _See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-beta.0/src/commands/run.ts)_
684
1315
 
685
1316
  ## `aoox update`
686
1317
 
@@ -702,7 +1333,7 @@ EXAMPLES
702
1333
  $ aoox update --check
703
1334
  ```
704
1335
 
705
- _See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
706
1337
 
707
1338
  ## `aoox update panel`
708
1339
 
@@ -727,7 +1358,7 @@ EXAMPLES
727
1358
  $ aoox update panel --apply
728
1359
  ```
729
1360
 
730
- _See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
731
1362
 
732
1363
  ## `aoox whoami`
733
1364
 
@@ -754,7 +1385,7 @@ EXAMPLES
754
1385
  $ aoox whoami --json
755
1386
  ```
756
1387
 
757
- _See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.8/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)_
758
1389
  <!-- commandsstop -->
759
1390
 
760
1391
  ## Versioning