@hideandseeklab/aoox 0.1.0-alpha.0 → 0.1.0-alpha.10

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 (122) hide show
  1. package/README.md +880 -6
  2. package/assets/install/README.md +4 -0
  3. package/assets/install/docker-compose.dist.yml +171 -146
  4. package/assets/install/docker-compose.domain.yml +49 -49
  5. package/bin/dev.cmd +3 -3
  6. package/bin/dev.js +15 -15
  7. package/bin/run.cmd +3 -3
  8. package/bin/run.js +11 -11
  9. package/dist/commands/deploy.d.ts +25 -0
  10. package/dist/commands/deploy.js +140 -0
  11. package/dist/commands/domain/set.d.ts +19 -0
  12. package/dist/commands/domain/set.js +67 -0
  13. package/dist/commands/env/diff.d.ts +18 -0
  14. package/dist/commands/env/diff.js +51 -0
  15. package/dist/commands/env/history.d.ts +17 -0
  16. package/dist/commands/env/history.js +48 -0
  17. package/dist/commands/env/link.d.ts +17 -0
  18. package/dist/commands/env/link.js +53 -0
  19. package/dist/commands/env/links.d.ts +14 -0
  20. package/dist/commands/env/links.js +17 -0
  21. package/dist/commands/env/list.d.ts +40 -0
  22. package/dist/commands/env/list.js +120 -0
  23. package/dist/commands/env/promote.d.ts +20 -0
  24. package/dist/commands/env/promote.js +95 -0
  25. package/dist/commands/env/pull.d.ts +17 -0
  26. package/dist/commands/env/pull.js +68 -0
  27. package/dist/commands/env/push.d.ts +17 -0
  28. package/dist/commands/env/push.js +69 -0
  29. package/dist/commands/env/set.d.ts +19 -0
  30. package/dist/commands/env/set.js +59 -0
  31. package/dist/commands/env/unlink.d.ts +17 -0
  32. package/dist/commands/env/unlink.js +39 -0
  33. package/dist/commands/env/unset.d.ts +18 -0
  34. package/dist/commands/env/unset.js +44 -0
  35. package/dist/commands/install.d.ts +28 -0
  36. package/dist/commands/install.js +215 -0
  37. package/dist/commands/link.d.ts +14 -0
  38. package/dist/commands/link.js +101 -0
  39. package/dist/commands/login.d.ts +14 -0
  40. package/dist/commands/login.js +101 -0
  41. package/dist/commands/registry/build.d.ts +24 -0
  42. package/dist/commands/registry/build.js +42 -0
  43. package/dist/commands/registry/domain.d.ts +18 -0
  44. package/dist/commands/registry/domain.js +62 -0
  45. package/dist/commands/registry/push.d.ts +19 -0
  46. package/dist/commands/registry/push.js +31 -0
  47. package/dist/commands/reinstall.d.ts +25 -0
  48. package/dist/commands/reinstall.js +235 -0
  49. package/dist/commands/run.d.ts +23 -0
  50. package/dist/commands/run.js +158 -0
  51. package/dist/commands/update/panel.d.ts +18 -0
  52. package/dist/commands/update/panel.js +62 -0
  53. package/dist/commands/update.d.ts +17 -0
  54. package/dist/commands/update.js +74 -0
  55. package/dist/commands/whoami.d.ts +15 -0
  56. package/dist/commands/whoami.js +39 -0
  57. package/dist/help.d.ts +9 -0
  58. package/dist/help.js +16 -0
  59. package/dist/index.d.ts +1 -0
  60. package/dist/index.js +1 -0
  61. package/dist/lib/api.d.ts +20 -0
  62. package/dist/lib/api.js +71 -0
  63. package/dist/lib/config.d.ts +37 -0
  64. package/dist/lib/config.js +81 -0
  65. package/dist/lib/connection-summary.d.ts +30 -0
  66. package/dist/lib/connection-summary.js +105 -0
  67. package/dist/lib/discovery.d.ts +47 -0
  68. package/dist/lib/discovery.js +222 -0
  69. package/dist/lib/docker.d.ts +21 -0
  70. package/dist/lib/docker.js +93 -0
  71. package/dist/lib/env-command.d.ts +109 -0
  72. package/dist/lib/env-command.js +229 -0
  73. package/dist/lib/env-file.d.ts +21 -0
  74. package/dist/lib/env-file.js +61 -0
  75. package/dist/lib/env-plan.d.ts +23 -0
  76. package/dist/lib/env-plan.js +34 -0
  77. package/dist/lib/env-run.d.ts +24 -0
  78. package/dist/lib/env-run.js +56 -0
  79. package/dist/lib/env-text.d.ts +97 -0
  80. package/dist/lib/env-text.js +266 -0
  81. package/dist/lib/flags.d.ts +28 -0
  82. package/dist/lib/flags.js +45 -0
  83. package/dist/lib/git.d.ts +13 -0
  84. package/dist/lib/git.js +34 -0
  85. package/dist/lib/image-ref.d.ts +28 -0
  86. package/dist/lib/image-ref.js +82 -0
  87. package/dist/lib/install-env.d.ts +47 -0
  88. package/dist/lib/install-env.js +79 -0
  89. package/dist/lib/link-command.d.ts +9 -0
  90. package/dist/lib/link-command.js +23 -0
  91. package/dist/lib/link.d.ts +12 -0
  92. package/dist/lib/link.js +41 -0
  93. package/dist/lib/outdated.d.ts +9 -0
  94. package/dist/lib/outdated.js +23 -0
  95. package/dist/lib/panel-addresses.d.ts +35 -0
  96. package/dist/lib/panel-addresses.js +122 -0
  97. package/dist/lib/registry-check.d.ts +35 -0
  98. package/dist/lib/registry-check.js +102 -0
  99. package/dist/lib/registry-image-command.d.ts +40 -0
  100. package/dist/lib/registry-image-command.js +146 -0
  101. package/dist/lib/registry-select.d.ts +21 -0
  102. package/dist/lib/registry-select.js +48 -0
  103. package/dist/lib/reinstall.d.ts +66 -0
  104. package/dist/lib/reinstall.js +204 -0
  105. package/dist/lib/run-banner.d.ts +27 -0
  106. package/dist/lib/run-banner.js +41 -0
  107. package/dist/lib/self-update.d.ts +30 -0
  108. package/dist/lib/self-update.js +94 -0
  109. package/dist/lib/system.d.ts +18 -0
  110. package/dist/lib/system.js +87 -0
  111. package/dist/lib/terminal-key.d.ts +74 -0
  112. package/dist/lib/terminal-key.js +147 -0
  113. package/dist/lib/types.d.ts +195 -0
  114. package/dist/lib/types.js +6 -0
  115. package/dist/lib/variable-sets.d.ts +90 -0
  116. package/dist/lib/variable-sets.js +177 -0
  117. package/dist/lib/version.d.ts +7 -0
  118. package/dist/lib/version.js +57 -0
  119. package/dist/lib/windows-exit-fix.d.ts +31 -0
  120. package/dist/lib/windows-exit-fix.js +32 -0
  121. package/oclif.manifest.json +1866 -2
  122. package/package.json +112 -77
package/README.md CHANGED
@@ -3,6 +3,12 @@ aoox
3
3
 
4
4
  CLI for [aoox](https://github.com/hideandseeklab/aoox-api), a self-hosted PaaS — build and deploy
5
5
 
6
+ Website: [aoox.dev](https://aoox.dev) · Docs: [aoox.dev/docs](https://aoox.dev/docs) · Changelog: [aoox.dev/changelog](https://aoox.dev/changelog)
7
+
8
+ Related repos: [aoox-api](https://github.com/hideandseeklab/aoox-api) (backend) ·
9
+ [aoox-web](https://github.com/hideandseeklab/aoox-web) (dashboard) ·
10
+ [aoox-landing](https://github.com/hideandseeklab/aoox-landing) (website and docs).
11
+
6
12
 
7
13
  [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
8
14
  [![Version](https://img.shields.io/npm/v/%40hideandseeklab%2Faoox.svg)](https://npmjs.org/package/@hideandseeklab/aoox)
@@ -21,7 +27,7 @@ $ npm install -g @hideandseeklab/aoox
21
27
  $ aoox COMMAND
22
28
  running command...
23
29
  $ aoox (--version)
24
- @hideandseeklab/aoox/0.1.0-alpha.0 win32-x64 node-v24.12.0
30
+ @hideandseeklab/aoox/0.1.0-alpha.10 linux-x64 node-v24.21.0
25
31
  $ aoox --help [COMMAND]
26
32
  USAGE
27
33
  $ aoox COMMAND
@@ -31,17 +37,38 @@ USAGE
31
37
 
32
38
  # Installation
33
39
 
34
- `aoox` is still in **alpha** — published to npm under the `alpha` dist-tag, not `latest`
35
- (the package has never had a stable release, so `npm install -g @hideandseeklab/aoox` without a
36
- tag will fail to find a version). Install explicitly with this tag:
40
+ ## Linux / macOS (no Node.js required)
41
+
42
+ A standalone install script downloads a tarball with its own bundled Node.js runtime — nothing
43
+ to install first, works even on a machine that will never otherwise touch Node.js (e.g. a bare
44
+ VPS before running `aoox install` on it):
37
45
 
38
46
  ```sh-session
39
- npm install -g @hideandseeklab/aoox@alpha
47
+ curl -fsSL https://aoox.dev/install-cli.sh | sh
40
48
  ```
41
49
 
50
+ This installs to `/usr/local/lib/aoox` + `/usr/local/bin/aoox` when run as root or with
51
+ passwordless `sudo` available, or `~/.local/lib/aoox` + `~/.local/bin/aoox` otherwise (a `curl |
52
+ sh` pipe can't relay an interactive `sudo` password prompt safely, so the script never tries).
53
+ Re-running it upgrades in place. Supports Linux (glibc — not Alpine/musl) and macOS on x64/arm64;
54
+ anything else needs the npm install below instead. See the comment header of
55
+ [`install-cli.sh`](https://github.com/hideandseeklab/aoox-landing/blob/main/public/install-cli.sh)
56
+ for every environment variable it accepts (pinning a version, a custom install directory, etc).
57
+
58
+ ## npm (Windows, Alpine, or if you already have Node.js)
59
+
60
+ ```sh-session
61
+ npm install -g @hideandseeklab/aoox
62
+ ```
63
+
64
+ While the project is in alpha every release is published under both the `latest` and `alpha` tags, so no tag is needed. To update later, run `aoox update` (`aoox update panel` updates the panel).
65
+
42
66
  `aoox` is then available globally. This also applies to `aoox install` on a new VPS —
43
67
  Node ≥22 must already be installed on that VPS **before** the step above (`aoox install`
44
- itself needs Node to run, so it cannot install Node for you first).
68
+ itself needs Node to run, so it cannot install Node for you first) — or use the install script
69
+ above, which needs no Node.js on the VPS at all.
70
+
71
+ ## From source
45
72
 
46
73
  To install from source (e.g. to contribute, or to get the latest `main` before it is
47
74
  released to npm):
@@ -56,7 +83,24 @@ npm link # or: npm install -g .
56
83
 
57
84
  # Commands
58
85
  <!-- commands -->
86
+ * [`aoox deploy`](#aoox-deploy)
87
+ * [`aoox domain set`](#aoox-domain-set)
88
+ * [`aoox env diff`](#aoox-env-diff)
89
+ * [`aoox env history`](#aoox-env-history)
90
+ * [`aoox env link`](#aoox-env-link)
91
+ * [`aoox env links`](#aoox-env-links)
92
+ * [`aoox env list`](#aoox-env-list)
93
+ * [`aoox env promote`](#aoox-env-promote)
94
+ * [`aoox env pull`](#aoox-env-pull)
95
+ * [`aoox env push`](#aoox-env-push)
96
+ * [`aoox env set ASSIGNMENTS`](#aoox-env-set-assignments)
97
+ * [`aoox env sets`](#aoox-env-sets)
98
+ * [`aoox env unlink`](#aoox-env-unlink)
99
+ * [`aoox env unset KEYS`](#aoox-env-unset-keys)
59
100
  * [`aoox help [COMMAND]`](#aoox-help-command)
101
+ * [`aoox install`](#aoox-install)
102
+ * [`aoox link`](#aoox-link)
103
+ * [`aoox login`](#aoox-login)
60
104
  * [`aoox plugins`](#aoox-plugins)
61
105
  * [`aoox plugins add PLUGIN`](#aoox-plugins-add-plugin)
62
106
  * [`aoox plugins:inspect PLUGIN...`](#aoox-pluginsinspect-plugin)
@@ -67,6 +111,505 @@ npm link # or: npm install -g .
67
111
  * [`aoox plugins uninstall [PLUGIN]`](#aoox-plugins-uninstall-plugin)
68
112
  * [`aoox plugins unlink [PLUGIN]`](#aoox-plugins-unlink-plugin)
69
113
  * [`aoox plugins update`](#aoox-plugins-update)
114
+ * [`aoox registry build IMAGE`](#aoox-registry-build-image)
115
+ * [`aoox registry domain`](#aoox-registry-domain)
116
+ * [`aoox registry push IMAGE`](#aoox-registry-push-image)
117
+ * [`aoox reinstall`](#aoox-reinstall)
118
+ * [`aoox run`](#aoox-run)
119
+ * [`aoox update`](#aoox-update)
120
+ * [`aoox update panel`](#aoox-update-panel)
121
+ * [`aoox whoami`](#aoox-whoami)
122
+
123
+ ## `aoox deploy`
124
+
125
+ Build a local image, push it to the aoox registry, then deploy (the repo must be linked with `aoox link` first)
126
+
127
+ ```
128
+ USAGE
129
+ $ aoox deploy [-t <value>] [-u <value>] [--context <value>] [-f <value>] [--registry <value>] [--tag
130
+ <value>]
131
+
132
+ FLAGS
133
+ -f, --dockerfile=<value> [default: Dockerfile] Path to the Dockerfile
134
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
135
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
136
+ https://dashboard.example.com); defaults to the value from `aoox login`
137
+ --context=<value> [default: .] Docker build context
138
+ --registry=<value> Registry ID to push to; defaults to the self-hosted registry
139
+ --tag=<value> Image tag; defaults to the git short SHA (+ -dirty)
140
+
141
+ DESCRIPTION
142
+ Build a local image, push it to the aoox registry, then deploy (the repo must be linked with `aoox link` first)
143
+
144
+ EXAMPLES
145
+ $ aoox deploy
146
+
147
+ $ aoox deploy --tag v1.2.3
148
+ ```
149
+
150
+ _See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/deploy.ts)_
151
+
152
+ ## `aoox domain set`
153
+
154
+ Set a custom domain for the panel itself (not an application) through the running panel API
155
+
156
+ ```
157
+ USAGE
158
+ $ aoox domain set --api <value> --web <value> [-t <value>] [-u <value>] [--acme-email <value>]
159
+
160
+ FLAGS
161
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
162
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
163
+ https://dashboard.example.com); defaults to the value from `aoox login`
164
+ --acme-email=<value> Email for the Let's Encrypt certificate
165
+ --api=<value> (required) Domain for the panel API
166
+ --web=<value> (required) Domain for the panel dashboard
167
+
168
+ DESCRIPTION
169
+ Set a custom domain for the panel itself (not an application) through the running panel API
170
+
171
+ EXAMPLES
172
+ $ aoox domain set --web panel.example.com --api api.example.com
173
+
174
+ $ aoox domain set --web panel.example.com --api api.example.com --acme-email you@example.com
175
+ ```
176
+
177
+ _See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/domain/set.ts)_
178
+
179
+ ## `aoox env diff`
180
+
181
+ 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
182
+
183
+ ```
184
+ USAGE
185
+ $ aoox env diff --from <value> --to <value> [--json] [-t <value>] [-u <value>] [--stack <value> | --app
186
+ <value>] [-s <value>]
187
+
188
+ FLAGS
189
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
190
+ you can see
191
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
192
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
193
+ https://dashboard.example.com); defaults to the value from `aoox login`
194
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
195
+ --from=<value> (required) Environment to compare from
196
+ --stack=<value> Compose stack ID, instead of an application
197
+ --to=<value> (required) Environment to compare to
198
+
199
+ GLOBAL FLAGS
200
+ --json Format output as json.
201
+
202
+ DESCRIPTION
203
+ Compare two environments of a variable set key by key: which variables exist on one side only and which have different
204
+ values. Prints names only, never values
205
+
206
+ EXAMPLES
207
+ $ aoox env diff --set shared --from staging --to production
208
+ ```
209
+
210
+ _See code: [src/commands/env/diff.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/diff.ts)_
211
+
212
+ ## `aoox env history`
213
+
214
+ Show the version history of a variable set environment: when, who, and which variable names were added (+), changed (~) or removed (-). Values are never shown
215
+
216
+ ```
217
+ USAGE
218
+ $ aoox env history [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
219
+ <value>] [--limit <value>]
220
+
221
+ FLAGS
222
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
223
+ the set the linked application links
224
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
225
+ you can see
226
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
227
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
228
+ https://dashboard.example.com); defaults to the value from `aoox login`
229
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
230
+ --limit=<value> [default: 20] How many versions to show (newest first)
231
+ --stack=<value> Compose stack ID, instead of an application
232
+
233
+ GLOBAL FLAGS
234
+ --json Format output as json.
235
+
236
+ DESCRIPTION
237
+ Show the version history of a variable set environment: when, who, and which variable names were added (+), changed
238
+ (~) or removed (-). Values are never shown
239
+
240
+ EXAMPLES
241
+ $ aoox env history --set shared --env production
242
+
243
+ $ aoox env history --limit 5 --json
244
+ ```
245
+
246
+ _See code: [src/commands/env/history.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/history.ts)_
247
+
248
+ ## `aoox env link`
249
+
250
+ 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
251
+
252
+ ```
253
+ USAGE
254
+ $ aoox env link -e <value> -s <value> [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>]
255
+ [--position <value>]
256
+
257
+ FLAGS
258
+ -e, --env=<value> (required) Environment of the set
259
+ -s, --set=<value> (required) Variable set slug (or name)
260
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
261
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
262
+ https://dashboard.example.com); defaults to the value from `aoox login`
263
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
264
+ --position=<value> 1-based place in the list (1 = first, overridden by every later link). Default: last
265
+ --stack=<value> Compose stack ID, instead of an application
266
+
267
+ GLOBAL FLAGS
268
+ --json Format output as json.
269
+
270
+ DESCRIPTION
271
+ Link a variable set environment to the linked application (or --stack). It is added last, so it wins over the other
272
+ links, unless --position is given; an environment that is already linked is moved. Takes effect on the next deploy
273
+
274
+ EXAMPLES
275
+ $ aoox env link --set shared --env production
276
+
277
+ $ aoox env link --set defaults --env production --position 1
278
+ ```
279
+
280
+ _See code: [src/commands/env/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/link.ts)_
281
+
282
+ ## `aoox env links`
283
+
284
+ 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
285
+
286
+ ```
287
+ USAGE
288
+ $ aoox env links [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>]
289
+
290
+ FLAGS
291
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
292
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
293
+ https://dashboard.example.com); defaults to the value from `aoox login`
294
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
295
+ --stack=<value> Compose stack ID, instead of an application
296
+
297
+ GLOBAL FLAGS
298
+ --json Format output as json.
299
+
300
+ DESCRIPTION
301
+ Show the variable set environments the linked application (or --stack) uses, in merge order, with the variables a
302
+ later link or the own env overrides
303
+
304
+ EXAMPLES
305
+ $ aoox env links
306
+
307
+ $ aoox env links --stack <id>
308
+ ```
309
+
310
+ _See code: [src/commands/env/links.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/links.ts)_
311
+
312
+ ## `aoox env list`
313
+
314
+ 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
315
+
316
+ ```
317
+ USAGE
318
+ $ aoox env list [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [--reveal]
319
+ [-s <value>]
320
+
321
+ FLAGS
322
+ -e, --env=<value> Environment name; lists its variable names (the set defaults like in the other env commands)
323
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
324
+ you can see
325
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
326
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
327
+ https://dashboard.example.com); defaults to the value from `aoox login`
328
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
329
+ --reveal Show the values (needs --env; the read is recorded in the audit log)
330
+ --stack=<value> Compose stack ID, instead of an application
331
+
332
+ GLOBAL FLAGS
333
+ --json Format output as json.
334
+
335
+ DESCRIPTION
336
+ List the variable sets you can see and their environments (with --set: one set; with --env: the variable names of one
337
+ environment). Values are masked unless --reveal is given
338
+
339
+ ALIASES
340
+ $ aoox env sets
341
+
342
+ EXAMPLES
343
+ $ aoox env list
344
+
345
+ $ aoox env list --set shared
346
+
347
+ $ aoox env list --set shared --env staging
348
+
349
+ $ aoox env list --set shared --env development --reveal
350
+ ```
351
+
352
+ _See code: [src/commands/env/list.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/list.ts)_
353
+
354
+ ## `aoox env promote`
355
+
356
+ 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)
357
+
358
+ ```
359
+ USAGE
360
+ $ aoox env promote --from <value> --to <value> [-t <value>] [-u <value>] [--stack <value> | --app <value>]
361
+ [--all] [-s <value>] [-y]
362
+
363
+ FLAGS
364
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
365
+ you can see
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
+ -y, --yes Do not ask for confirmation
370
+ --all Promote every variable of the source (those already equal are skipped)
371
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
372
+ --from=<value> (required) Environment to copy the values from
373
+ --stack=<value> Compose stack ID, instead of an application
374
+ --to=<value> (required) Environment to copy the values into
375
+
376
+ DESCRIPTION
377
+ Copy variables (and their secret flag) from one environment of a variable set to another (name them, or use --all).
378
+ Needs the right to read the source and to change the target. The target keeps its comments and order; new variables
379
+ are appended. Shows what changes and asks before writing (unless --yes)
380
+
381
+ EXAMPLES
382
+ $ aoox env promote --set shared --from staging --to production API_URL FEATURE_X
383
+
384
+ $ aoox env promote --from development --to staging --all --yes
385
+ ```
386
+
387
+ _See code: [src/commands/env/promote.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/promote.ts)_
388
+
389
+ ## `aoox env pull`
390
+
391
+ 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
392
+
393
+ ```
394
+ USAGE
395
+ $ aoox env pull [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
396
+ [--file <value>] [--force] [--format dotenv|json|shell]
397
+
398
+ FLAGS
399
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment
400
+ of the set the linked application links
401
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only
402
+ set you can see
403
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
404
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
405
+ https://dashboard.example.com); defaults to the value from `aoox login`
406
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
407
+ --file=<value> File to write, relative to the current folder; "-" writes to standard output (nothing else is
408
+ printed there). Default: .env, .env.json or .env.sh by format
409
+ --force Overwrite the file if it exists
410
+ --format=<option> [default: dotenv] dotenv (the stored text, comments kept), json ({"KEY":"value"}) or shell
411
+ (export KEY='value' lines for eval)
412
+ <options: dotenv|json|shell>
413
+ --stack=<value> Compose stack ID, instead of an application
414
+
415
+ DESCRIPTION
416
+ Write the variables of a variable set environment to a local file (mode 0600), or to standard output with --file -.
417
+ Refuses to overwrite unless --force. The read is recorded in the audit log
418
+
419
+ EXAMPLES
420
+ $ aoox env pull
421
+
422
+ $ aoox env pull --set shared --env staging --file .env.staging
423
+
424
+ $ aoox env pull --force
425
+
426
+ $ aoox env pull --format json --file -
427
+
428
+ $ aoox env pull --format shell --file -
429
+ ```
430
+
431
+ _See code: [src/commands/env/pull.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/pull.ts)_
432
+
433
+ ## `aoox env push`
434
+
435
+ 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
436
+
437
+ ```
438
+ USAGE
439
+ $ aoox env push --file <value> [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
440
+ <value>] [-y]
441
+
442
+ FLAGS
443
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
444
+ the set the linked application links
445
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
446
+ you can see
447
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
448
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
449
+ https://dashboard.example.com); defaults to the value from `aoox login`
450
+ -y, --yes Do not ask for confirmation
451
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
452
+ --file=<value> (required) The .env file to upload
453
+ --stack=<value> Compose stack ID, instead of an application
454
+
455
+ DESCRIPTION
456
+ Replace the whole text of a variable set environment with a local .env file. Shows what is added, changed and removed
457
+ and asks before writing (unless --yes); the write fails if someone else changed the environment in between
458
+
459
+ EXAMPLES
460
+ $ aoox env push --file .env
461
+
462
+ $ aoox env push --file .env.staging --set shared --env staging --yes
463
+ ```
464
+
465
+ _See code: [src/commands/env/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/push.ts)_
466
+
467
+ ## `aoox env set ASSIGNMENTS`
468
+
469
+ 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
470
+
471
+ ```
472
+ USAGE
473
+ $ aoox env set ASSIGNMENTS... [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s
474
+ <value>] [--secret]
475
+
476
+ ARGUMENTS
477
+ ASSIGNMENTS... KEY=VALUE (the value is stored exactly as given)
478
+
479
+ FLAGS
480
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
481
+ the set the linked application links
482
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
483
+ you can see
484
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
485
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
486
+ https://dashboard.example.com); defaults to the value from `aoox login`
487
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
488
+ --[no-]secret Mark the variables as secret (--secret: always masked in logs) or explicitly not secret
489
+ (--no-secret: never masked). Without either the flag is left as it is
490
+ --stack=<value> Compose stack ID, instead of an application
491
+
492
+ DESCRIPTION
493
+ Set one or more variables in a variable set environment. Existing comments and order are kept; the write fails if
494
+ someone else changed the environment in between
495
+
496
+ EXAMPLES
497
+ $ aoox env set API_URL=https://api.example.com --set shared --env production
498
+
499
+ $ aoox env set GREETING="hello world" QUERY=a=b --env staging
500
+
501
+ $ aoox env set API_TOKEN=abc123 --secret
502
+ ```
503
+
504
+ _See code: [src/commands/env/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/set.ts)_
505
+
506
+ ## `aoox env sets`
507
+
508
+ 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
509
+
510
+ ```
511
+ USAGE
512
+ $ aoox env sets [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [--reveal]
513
+ [-s <value>]
514
+
515
+ FLAGS
516
+ -e, --env=<value> Environment name; lists its variable names (the set defaults like in the other env commands)
517
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
518
+ you can see
519
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
520
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
521
+ https://dashboard.example.com); defaults to the value from `aoox login`
522
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
523
+ --reveal Show the values (needs --env; the read is recorded in the audit log)
524
+ --stack=<value> Compose stack ID, instead of an application
525
+
526
+ GLOBAL FLAGS
527
+ --json Format output as json.
528
+
529
+ DESCRIPTION
530
+ List the variable sets you can see and their environments (with --set: one set; with --env: the variable names of one
531
+ environment). Values are masked unless --reveal is given
532
+
533
+ ALIASES
534
+ $ aoox env sets
535
+
536
+ EXAMPLES
537
+ $ aoox env sets
538
+
539
+ $ aoox env sets --set shared
540
+
541
+ $ aoox env sets --set shared --env staging
542
+
543
+ $ aoox env sets --set shared --env development --reveal
544
+ ```
545
+
546
+ ## `aoox env unlink`
547
+
548
+ 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
549
+
550
+ ```
551
+ USAGE
552
+ $ aoox env unlink [--json] [-t <value>] [-u <value>] [--stack <value> | --app <value>] [--position <value> |
553
+ -s <value> | -e <value>]
554
+
555
+ FLAGS
556
+ -e, --env=<value> Environment of the set
557
+ -s, --set=<value> Variable set slug (or name)
558
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
559
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
560
+ https://dashboard.example.com); defaults to the value from `aoox login`
561
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
562
+ --position=<value> 1-based position as shown by `aoox env links`
563
+ --stack=<value> Compose stack ID, instead of an application
564
+
565
+ GLOBAL FLAGS
566
+ --json Format output as json.
567
+
568
+ DESCRIPTION
569
+ Remove a variable set environment from the linked application (or --stack). Name it with --set and --env, or with its
570
+ --position from `aoox env links`. Takes effect on the next deploy
571
+
572
+ EXAMPLES
573
+ $ aoox env unlink --set shared --env staging
574
+
575
+ $ aoox env unlink --position 2
576
+ ```
577
+
578
+ _See code: [src/commands/env/unlink.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/unlink.ts)_
579
+
580
+ ## `aoox env unset KEYS`
581
+
582
+ 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
583
+
584
+ ```
585
+ USAGE
586
+ $ aoox env unset KEYS... [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
587
+
588
+ ARGUMENTS
589
+ KEYS... Variable name(s) to remove
590
+
591
+ FLAGS
592
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
593
+ the set the linked application links
594
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
595
+ you can see
596
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
597
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
598
+ https://dashboard.example.com); defaults to the value from `aoox login`
599
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
600
+ --stack=<value> Compose stack ID, instead of an application
601
+
602
+ DESCRIPTION
603
+ Remove one or more variables from a variable set environment. Comments and the other variables are kept; the write
604
+ fails if someone else changed the environment in between
605
+
606
+ EXAMPLES
607
+ $ aoox env unset OLD_KEY
608
+
609
+ $ aoox env unset A B --set shared --env staging
610
+ ```
611
+
612
+ _See code: [src/commands/env/unset.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/env/unset.ts)_
70
613
 
71
614
  ## `aoox help [COMMAND]`
72
615
 
@@ -88,6 +631,94 @@ DESCRIPTION
88
631
 
89
632
  _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.3.0/src/commands/help.ts)_
90
633
 
634
+ ## `aoox install`
635
+
636
+ Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
637
+
638
+ ```
639
+ USAGE
640
+ $ aoox install [--acme-email <value>] [--admin-name <value> --admin-email <value>] [--admin-password
641
+ <value> ] [--api-domain <value> --web-domain <value>] [--dir <value>] [--force] [--no-terminal-authorize]
642
+ [--terminal-ssh-user <value>] [-y]
643
+
644
+ FLAGS
645
+ -y, --yes Do not ask for any confirmation
646
+ --acme-email=<value> Required with --web-domain/--api-domain (Let’s Encrypt)
647
+ --admin-email=<value> Create the first owner without going through /setup in the browser
648
+ --admin-name=<value> Name of the first owner
649
+ --admin-password=<value> Password of the first owner (min. 8 characters)
650
+ --api-domain=<value> Domain for the API, served through the bundled proxy
651
+ --dir=<value> [default: /opt/aoox] Installation directory
652
+ --force Overwrite an existing installation in --dir
653
+ --no-terminal-authorize Do not create/authorize the web Terminal SSH key automatically (do it in Settings >
654
+ Terminal instead)
655
+ --terminal-ssh-user=<value> SSH user the web Terminal uses to log in to this host (default: the user running
656
+ sudo, or root if there is none)
657
+ --web-domain=<value> Domain for the web panel, served through the bundled proxy
658
+
659
+ DESCRIPTION
660
+ Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
661
+
662
+ EXAMPLES
663
+ sudo aoox install
664
+
665
+ sudo aoox install --web-domain panel.example.com --api-domain api.panel.example.com --acme-email me@example.com
666
+ ```
667
+
668
+ _See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/install.ts)_
669
+
670
+ ## `aoox link`
671
+
672
+ Link this folder to an application in the panel (used by `aoox deploy`/`aoox logs`)
673
+
674
+ ```
675
+ USAGE
676
+ $ aoox link [-t <value>] [-u <value>] [--app <value>] [--project <value>]
677
+
678
+ FLAGS
679
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
680
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
681
+ https://dashboard.example.com); defaults to the value from `aoox login`
682
+ --app=<value> Application ID; skip the interactive selection
683
+ --project=<value> Project ID; skip the interactive selection
684
+
685
+ DESCRIPTION
686
+ Link this folder to an application in the panel (used by `aoox deploy`/`aoox logs`)
687
+
688
+ EXAMPLES
689
+ $ aoox link
690
+
691
+ $ aoox link --project <id> --app <id>
692
+ ```
693
+
694
+ _See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/link.ts)_
695
+
696
+ ## `aoox login`
697
+
698
+ Save the dashboard address and API token for other commands (the API address is discovered automatically)
699
+
700
+ ```
701
+ USAGE
702
+ $ aoox login [-t <value>] [-u <value>]
703
+
704
+ FLAGS
705
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
706
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
707
+ https://dashboard.example.com); defaults to the value from `aoox login`
708
+
709
+ DESCRIPTION
710
+ Save the dashboard address and API token for other commands (the API address is discovered automatically)
711
+
712
+ EXAMPLES
713
+ $ aoox login
714
+
715
+ $ aoox login --url https://dashboard.example.com --token aoox_xxx
716
+
717
+ $ aoox login --url 203.0.113.10:3000 --token aoox_xxx
718
+ ```
719
+
720
+ _See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/login.ts)_
721
+
91
722
  ## `aoox plugins`
92
723
 
93
724
  List installed plugins.
@@ -377,6 +1008,249 @@ DESCRIPTION
377
1008
  ```
378
1009
 
379
1010
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.5.2/src/commands/plugins/update.ts)_
1011
+
1012
+ ## `aoox registry build IMAGE`
1013
+
1014
+ Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
1015
+
1016
+ ```
1017
+ USAGE
1018
+ $ aoox registry build IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>] [--context <value>] [-f
1019
+ <value>] [--push]
1020
+
1021
+ ARGUMENTS
1022
+ IMAGE Image name and version, e.g. myapp:1.0.0
1023
+
1024
+ FLAGS
1025
+ -f, --dockerfile=<value> [default: Dockerfile] Path to the Dockerfile
1026
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1027
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1028
+ https://dashboard.example.com); defaults to the value from `aoox login`
1029
+ --context=<value> [default: .] Docker build context
1030
+ --force Overwrite a version that already exists in the registry
1031
+ --push Push the image to the registry right after the build
1032
+ --registry=<value> Registry ID; defaults to the self-hosted registry
1033
+
1034
+ DESCRIPTION
1035
+ Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
1036
+
1037
+ EXAMPLES
1038
+ $ aoox registry build myapp:1.0.0
1039
+
1040
+ $ aoox registry build myapp:1.0.0 --push
1041
+
1042
+ $ aoox registry build team/api:2.1.0 -f docker/Dockerfile --context .
1043
+
1044
+ $ aoox registry build myapp:1.0.0 --force
1045
+ ```
1046
+
1047
+ _See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/registry/build.ts)_
1048
+
1049
+ ## `aoox registry domain`
1050
+
1051
+ Set or remove the custom domain for the self-hosted registry
1052
+
1053
+ ```
1054
+ USAGE
1055
+ $ aoox registry domain [-t <value>] [-u <value>] [--clear] [--set <value>]
1056
+
1057
+ FLAGS
1058
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1059
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1060
+ https://dashboard.example.com); defaults to the value from `aoox login`
1061
+ --clear Remove the domain, falling back to host:port
1062
+ --set=<value> Domain for the self-hosted registry
1063
+
1064
+ DESCRIPTION
1065
+ Set or remove the custom domain for the self-hosted registry
1066
+
1067
+ EXAMPLES
1068
+ $ aoox registry domain --set registry.example.com
1069
+
1070
+ $ aoox registry domain --clear
1071
+ ```
1072
+
1073
+ _See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/registry/domain.ts)_
1074
+
1075
+ ## `aoox registry push IMAGE`
1076
+
1077
+ Push a local image to the aoox registry (refuses a version that already exists there)
1078
+
1079
+ ```
1080
+ USAGE
1081
+ $ aoox registry push IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>]
1082
+
1083
+ ARGUMENTS
1084
+ IMAGE Image name and version (short or full), e.g. myapp:1.0.0
1085
+
1086
+ FLAGS
1087
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1088
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1089
+ https://dashboard.example.com); defaults to the value from `aoox login`
1090
+ --force Overwrite a version that already exists in the registry
1091
+ --registry=<value> Registry ID; defaults to the self-hosted registry
1092
+
1093
+ DESCRIPTION
1094
+ Push a local image to the aoox registry (refuses a version that already exists there)
1095
+
1096
+ EXAMPLES
1097
+ $ aoox registry push myapp:1.0.0
1098
+
1099
+ $ aoox registry push registry.example.com/myapp:1.0.0
1100
+
1101
+ $ aoox registry push myapp:1.0.0 --force
1102
+ ```
1103
+
1104
+ _See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/registry/push.ts)_
1105
+
1106
+ ## `aoox reinstall`
1107
+
1108
+ Repair/refresh an existing aoox installation without losing data: rewrite compose, merge .env.dist (secrets are never regenerated), then pull + recreate
1109
+
1110
+ ```
1111
+ USAGE
1112
+ $ aoox reinstall [--dir <value>] [--dry-run] [--no-pull] [--terminal-ssh-user <value>] [-y]
1113
+
1114
+ FLAGS
1115
+ -y, --yes Do not ask for confirmation
1116
+ --dir=<value> [default: /opt/aoox] Installation directory
1117
+ --dry-run Print the plan (changed files, keys to add, compose commands) without changing
1118
+ anything
1119
+ --no-pull Skip docker compose pull (use the images already present)
1120
+ --terminal-ssh-user=<value> Set/overwrite TERMINAL_SSH_USER in .env.dist during repair
1121
+
1122
+ DESCRIPTION
1123
+ Repair/refresh an existing aoox installation without losing data: rewrite compose, merge .env.dist (secrets are never
1124
+ regenerated), then pull + recreate
1125
+
1126
+ EXAMPLES
1127
+ sudo aoox reinstall --dry-run
1128
+
1129
+ sudo aoox reinstall
1130
+
1131
+ sudo aoox reinstall --yes --terminal-ssh-user root
1132
+ ```
1133
+
1134
+ _See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/reinstall.ts)_
1135
+
1136
+ ## `aoox run`
1137
+
1138
+ 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
1139
+
1140
+ ```
1141
+ USAGE
1142
+ $ aoox run [-t <value>] [-u <value>] [--stack <value> | --app <value>] [-e <value>] [-s <value>]
1143
+ [--file <value>] [-q]
1144
+
1145
+ FLAGS
1146
+ -e, --env=<value> Environment of the set (e.g. development, staging, production). Default: the only environment of
1147
+ the set the linked application links
1148
+ -q, --quiet Do not print the "Injecting N variables" line or the informational notes. Warnings about
1149
+ unresolved references and excluded Infisical secrets are always printed
1150
+ -s, --set=<value> Variable set slug (or name). Default: the only set the linked application links, or the only set
1151
+ you can see
1152
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1153
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1154
+ https://dashboard.example.com); defaults to the value from `aoox login`
1155
+ --app=<value> Application ID; defaults to the application linked with `aoox link`
1156
+ --file=<value> A local .env file layered on top (it wins over aoox, which wins over the current environment).
1157
+ Only read, never written
1158
+ --stack=<value> Compose stack ID, instead of an application
1159
+
1160
+ DESCRIPTION
1161
+ Run a command with the variables the linked application gets at deploy time, without writing them to disk: its linked
1162
+ variable set environments in order (a later one wins), then its own env on top. With --set/--env, exactly one set
1163
+ environment instead. Put the command after `--`; its exit code is forwarded. Before the command starts, one line on
1164
+ stderr says how many variables aoox injects and from which layers (colour only on a terminal; NO_COLOR turns it off,
1165
+ FORCE_COLOR forces it); --quiet hides it, but never the warnings. Every read is recorded in the audit log
1166
+
1167
+ EXAMPLES
1168
+ $ aoox run -- npm run dev
1169
+
1170
+ $ aoox run --set shared --env staging -- node server.js
1171
+
1172
+ $ aoox run --file .env.local -- npm run dev
1173
+
1174
+ $ aoox run --stack <id> -- docker compose config
1175
+
1176
+ $ aoox run --quiet -- npm run dev
1177
+ ```
1178
+
1179
+ _See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/run.ts)_
1180
+
1181
+ ## `aoox update`
1182
+
1183
+ Update the aoox CLI itself (use `aoox update panel` to update the panel)
1184
+
1185
+ ```
1186
+ USAGE
1187
+ $ aoox update [--check]
1188
+
1189
+ FLAGS
1190
+ --check Only report whether a newer version exists; change nothing
1191
+
1192
+ DESCRIPTION
1193
+ Update the aoox CLI itself (use `aoox update panel` to update the panel)
1194
+
1195
+ EXAMPLES
1196
+ $ aoox update
1197
+
1198
+ $ aoox update --check
1199
+ ```
1200
+
1201
+ _See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/update.ts)_
1202
+
1203
+ ## `aoox update panel`
1204
+
1205
+ Check for or apply updates to the aoox panel itself (the aoox-api and aoox-web images)
1206
+
1207
+ ```
1208
+ USAGE
1209
+ $ aoox update panel [-t <value>] [-u <value>] [--apply]
1210
+
1211
+ FLAGS
1212
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1213
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1214
+ https://dashboard.example.com); defaults to the value from `aoox login`
1215
+ --apply Apply the update if one is available (pull + restart)
1216
+
1217
+ DESCRIPTION
1218
+ Check for or apply updates to the aoox panel itself (the aoox-api and aoox-web images)
1219
+
1220
+ EXAMPLES
1221
+ $ aoox update panel
1222
+
1223
+ $ aoox update panel --apply
1224
+ ```
1225
+
1226
+ _See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/update/panel.ts)_
1227
+
1228
+ ## `aoox whoami`
1229
+
1230
+ Show the account and panel in use
1231
+
1232
+ ```
1233
+ USAGE
1234
+ $ aoox whoami [--json] [-t <value>] [-u <value>]
1235
+
1236
+ FLAGS
1237
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1238
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1239
+ https://dashboard.example.com); defaults to the value from `aoox login`
1240
+
1241
+ GLOBAL FLAGS
1242
+ --json Format output as json.
1243
+
1244
+ DESCRIPTION
1245
+ Show the account and panel in use
1246
+
1247
+ EXAMPLES
1248
+ $ aoox whoami
1249
+
1250
+ $ aoox whoami --json
1251
+ ```
1252
+
1253
+ _See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.10/src/commands/whoami.ts)_
380
1254
  <!-- commandsstop -->
381
1255
 
382
1256
  ## Versioning