@hideandseeklab/aoox 0.1.0-alpha.7 → 0.1.0-alpha.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +430 -30
- package/dist/commands/deploy.js +18 -18
- package/dist/commands/domain/set.js +2 -0
- package/dist/commands/env/diff.d.ts +18 -0
- package/dist/commands/env/diff.js +46 -0
- package/dist/commands/env/history.d.ts +15 -0
- package/dist/commands/env/history.js +46 -0
- package/dist/commands/env/list.d.ts +31 -0
- package/dist/commands/env/list.js +91 -0
- package/dist/commands/env/promote.d.ts +20 -0
- package/dist/commands/env/promote.js +99 -0
- package/dist/commands/env/pull.d.ts +15 -0
- package/dist/commands/env/pull.js +69 -0
- package/dist/commands/env/push.d.ts +15 -0
- package/dist/commands/env/push.js +81 -0
- package/dist/commands/env/set.d.ts +17 -0
- package/dist/commands/env/set.js +76 -0
- package/dist/commands/env/unset.d.ts +16 -0
- package/dist/commands/env/unset.js +56 -0
- package/dist/commands/link.js +2 -0
- package/dist/commands/login.d.ts +2 -0
- package/dist/commands/login.js +56 -8
- package/dist/commands/registry/build.d.ts +24 -0
- package/dist/commands/registry/build.js +42 -0
- package/dist/commands/registry/domain.js +2 -0
- package/dist/commands/registry/push.d.ts +19 -0
- package/dist/commands/registry/push.js +31 -0
- package/dist/commands/run.d.ts +16 -0
- package/dist/commands/run.js +108 -0
- package/dist/commands/update/panel.d.ts +18 -0
- package/dist/commands/update/panel.js +62 -0
- package/dist/commands/update.d.ts +4 -5
- package/dist/commands/update.js +54 -40
- package/dist/commands/whoami.js +2 -0
- package/dist/help.d.ts +9 -0
- package/dist/help.js +16 -0
- package/dist/lib/api.d.ts +1 -1
- package/dist/lib/api.js +2 -2
- package/dist/lib/config.d.ts +4 -0
- package/dist/lib/config.js +5 -1
- package/dist/lib/connection-summary.d.ts +30 -0
- package/dist/lib/connection-summary.js +105 -0
- package/dist/lib/discovery.d.ts +47 -0
- package/dist/lib/discovery.js +222 -0
- package/dist/lib/docker.d.ts +8 -0
- package/dist/lib/docker.js +30 -0
- package/dist/lib/env-command.d.ts +61 -0
- package/dist/lib/env-command.js +156 -0
- package/dist/lib/env-file.d.ts +21 -0
- package/dist/lib/env-file.js +61 -0
- package/dist/lib/env-plan.d.ts +23 -0
- package/dist/lib/env-plan.js +34 -0
- package/dist/lib/env-run.d.ts +24 -0
- package/dist/lib/env-run.js +56 -0
- package/dist/lib/env-text.d.ts +97 -0
- package/dist/lib/env-text.js +262 -0
- package/dist/lib/flags.d.ts +7 -0
- package/dist/lib/flags.js +18 -3
- package/dist/lib/image-ref.d.ts +16 -0
- package/dist/lib/image-ref.js +66 -0
- package/dist/lib/outdated.d.ts +9 -0
- package/dist/lib/outdated.js +23 -0
- package/dist/lib/panel-addresses.d.ts +35 -0
- package/dist/lib/panel-addresses.js +122 -0
- package/dist/lib/registry-check.d.ts +35 -0
- package/dist/lib/registry-check.js +102 -0
- package/dist/lib/registry-image-command.d.ts +40 -0
- package/dist/lib/registry-image-command.js +146 -0
- package/dist/lib/registry-select.d.ts +21 -0
- package/dist/lib/registry-select.js +48 -0
- package/dist/lib/self-update.d.ts +30 -0
- package/dist/lib/self-update.js +94 -0
- package/dist/lib/types.d.ts +64 -0
- package/dist/lib/version.d.ts +7 -0
- package/dist/lib/version.js +57 -0
- package/oclif.manifest.json +888 -29
- package/package.json +13 -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.
|
|
30
|
+
@hideandseeklab/aoox/0.1.0-alpha.9 linux-x64 node-v24.21.0
|
|
31
31
|
$ aoox --help [COMMAND]
|
|
32
32
|
USAGE
|
|
33
33
|
$ aoox COMMAND
|
|
@@ -57,14 +57,12 @@ for every environment variable it accepts (pinning a version, a custom install d
|
|
|
57
57
|
|
|
58
58
|
## npm (Windows, Alpine, or if you already have Node.js)
|
|
59
59
|
|
|
60
|
-
`aoox` is still in **alpha** — published to npm under the `alpha` dist-tag, not `latest`
|
|
61
|
-
(the package has never had a stable release, so `npm install -g @hideandseeklab/aoox` without a
|
|
62
|
-
tag will fail to find a version). Install explicitly with this tag:
|
|
63
|
-
|
|
64
60
|
```sh-session
|
|
65
|
-
npm install -g @hideandseeklab/aoox
|
|
61
|
+
npm install -g @hideandseeklab/aoox
|
|
66
62
|
```
|
|
67
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
|
+
|
|
68
66
|
`aoox` is then available globally. This also applies to `aoox install` on a new VPS —
|
|
69
67
|
Node ≥22 must already be installed on that VPS **before** the step above (`aoox install`
|
|
70
68
|
itself needs Node to run, so it cannot install Node for you first) — or use the install script
|
|
@@ -87,6 +85,14 @@ npm link # or: npm install -g .
|
|
|
87
85
|
<!-- commands -->
|
|
88
86
|
* [`aoox deploy`](#aoox-deploy)
|
|
89
87
|
* [`aoox domain set`](#aoox-domain-set)
|
|
88
|
+
* [`aoox env diff FROM TO`](#aoox-env-diff-from-to)
|
|
89
|
+
* [`aoox env history`](#aoox-env-history)
|
|
90
|
+
* [`aoox env list`](#aoox-env-list)
|
|
91
|
+
* [`aoox env promote FROM TO`](#aoox-env-promote-from-to)
|
|
92
|
+
* [`aoox env pull`](#aoox-env-pull)
|
|
93
|
+
* [`aoox env push`](#aoox-env-push)
|
|
94
|
+
* [`aoox env set ASSIGNMENTS`](#aoox-env-set-assignments)
|
|
95
|
+
* [`aoox env unset KEYS`](#aoox-env-unset-keys)
|
|
90
96
|
* [`aoox help [COMMAND]`](#aoox-help-command)
|
|
91
97
|
* [`aoox install`](#aoox-install)
|
|
92
98
|
* [`aoox link`](#aoox-link)
|
|
@@ -101,9 +107,13 @@ npm link # or: npm install -g .
|
|
|
101
107
|
* [`aoox plugins uninstall [PLUGIN]`](#aoox-plugins-uninstall-plugin)
|
|
102
108
|
* [`aoox plugins unlink [PLUGIN]`](#aoox-plugins-unlink-plugin)
|
|
103
109
|
* [`aoox plugins update`](#aoox-plugins-update)
|
|
110
|
+
* [`aoox registry build IMAGE`](#aoox-registry-build-image)
|
|
104
111
|
* [`aoox registry domain`](#aoox-registry-domain)
|
|
112
|
+
* [`aoox registry push IMAGE`](#aoox-registry-push-image)
|
|
105
113
|
* [`aoox reinstall`](#aoox-reinstall)
|
|
114
|
+
* [`aoox run`](#aoox-run)
|
|
106
115
|
* [`aoox update`](#aoox-update)
|
|
116
|
+
* [`aoox update panel`](#aoox-update-panel)
|
|
107
117
|
* [`aoox whoami`](#aoox-whoami)
|
|
108
118
|
|
|
109
119
|
## `aoox deploy`
|
|
@@ -118,7 +128,8 @@ USAGE
|
|
|
118
128
|
FLAGS
|
|
119
129
|
-f, --dockerfile=<value> [default: Dockerfile] Path to the Dockerfile
|
|
120
130
|
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
121
|
-
-u, --url=<value> [env: AOOX_URL]
|
|
131
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
132
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
122
133
|
--context=<value> [default: .] Docker build context
|
|
123
134
|
--registry=<value> Registry ID to push to; defaults to the self-hosted registry
|
|
124
135
|
--tag=<value> Image tag; defaults to the git short SHA (+ -dirty)
|
|
@@ -132,7 +143,7 @@ EXAMPLES
|
|
|
132
143
|
$ aoox deploy --tag v1.2.3
|
|
133
144
|
```
|
|
134
145
|
|
|
135
|
-
_See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
146
|
+
_See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/deploy.ts)_
|
|
136
147
|
|
|
137
148
|
## `aoox domain set`
|
|
138
149
|
|
|
@@ -144,7 +155,8 @@ USAGE
|
|
|
144
155
|
|
|
145
156
|
FLAGS
|
|
146
157
|
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
147
|
-
-u, --url=<value> [env: AOOX_URL]
|
|
158
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
159
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
148
160
|
--acme-email=<value> Email for the Let's Encrypt certificate
|
|
149
161
|
--api=<value> (required) Domain for the panel API
|
|
150
162
|
--web=<value> (required) Domain for the panel dashboard
|
|
@@ -158,7 +170,267 @@ EXAMPLES
|
|
|
158
170
|
$ aoox domain set --web panel.example.com --api api.example.com --acme-email you@example.com
|
|
159
171
|
```
|
|
160
172
|
|
|
161
|
-
_See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
173
|
+
_See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/domain/set.ts)_
|
|
174
|
+
|
|
175
|
+
## `aoox env diff FROM TO`
|
|
176
|
+
|
|
177
|
+
Compare two environments key by key: which variables exist on one side only and which have different values. Prints names only, never values
|
|
178
|
+
|
|
179
|
+
```
|
|
180
|
+
USAGE
|
|
181
|
+
$ aoox env diff FROM TO [--json] [-t <value>] [-u <value>] [--project <value>]
|
|
182
|
+
|
|
183
|
+
ARGUMENTS
|
|
184
|
+
FROM Environment to compare from
|
|
185
|
+
TO Environment to compare to
|
|
186
|
+
|
|
187
|
+
FLAGS
|
|
188
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
189
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
190
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
191
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
192
|
+
|
|
193
|
+
GLOBAL FLAGS
|
|
194
|
+
--json Format output as json.
|
|
195
|
+
|
|
196
|
+
DESCRIPTION
|
|
197
|
+
Compare two environments key by key: which variables exist on one side only and which have different values. Prints
|
|
198
|
+
names only, never values
|
|
199
|
+
|
|
200
|
+
EXAMPLES
|
|
201
|
+
$ aoox env diff staging production
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
_See code: [src/commands/env/diff.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/diff.ts)_
|
|
205
|
+
|
|
206
|
+
## `aoox env history`
|
|
207
|
+
|
|
208
|
+
Show the version history of an environment: when, who, and which variable names were added (+), changed (~) or removed (-). Values are never shown
|
|
209
|
+
|
|
210
|
+
```
|
|
211
|
+
USAGE
|
|
212
|
+
$ aoox env history [--json] [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--limit <value>]
|
|
213
|
+
|
|
214
|
+
FLAGS
|
|
215
|
+
-e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
|
|
216
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
217
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
218
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
219
|
+
--limit=<value> [default: 20] How many versions to show (newest first)
|
|
220
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
221
|
+
|
|
222
|
+
GLOBAL FLAGS
|
|
223
|
+
--json Format output as json.
|
|
224
|
+
|
|
225
|
+
DESCRIPTION
|
|
226
|
+
Show the version history of an environment: when, who, and which variable names were added (+), changed (~) or removed
|
|
227
|
+
(-). Values are never shown
|
|
228
|
+
|
|
229
|
+
EXAMPLES
|
|
230
|
+
$ aoox env history --env production
|
|
231
|
+
|
|
232
|
+
$ aoox env history --limit 5 --json
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
_See code: [src/commands/env/history.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/history.ts)_
|
|
236
|
+
|
|
237
|
+
## `aoox env list`
|
|
238
|
+
|
|
239
|
+
List the project environments, or (with --env) the variable names of one. Values are masked unless --reveal is given
|
|
240
|
+
|
|
241
|
+
```
|
|
242
|
+
USAGE
|
|
243
|
+
$ aoox env list [--json] [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--reveal]
|
|
244
|
+
|
|
245
|
+
FLAGS
|
|
246
|
+
-e, --env=<value> Environment name; without it the environments of the project are listed
|
|
247
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
248
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
249
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
250
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
251
|
+
--reveal Show the values (needs --env; the read is recorded in the audit log)
|
|
252
|
+
|
|
253
|
+
GLOBAL FLAGS
|
|
254
|
+
--json Format output as json.
|
|
255
|
+
|
|
256
|
+
DESCRIPTION
|
|
257
|
+
List the project environments, or (with --env) the variable names of one. Values are masked unless --reveal is given
|
|
258
|
+
|
|
259
|
+
EXAMPLES
|
|
260
|
+
$ aoox env list
|
|
261
|
+
|
|
262
|
+
$ aoox env list --env staging
|
|
263
|
+
|
|
264
|
+
$ aoox env list --env development --reveal
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
_See code: [src/commands/env/list.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/list.ts)_
|
|
268
|
+
|
|
269
|
+
## `aoox env promote FROM TO`
|
|
270
|
+
|
|
271
|
+
Copy variables from one environment to another (name them, or use --all). Needs the right to read the source and to change the target. The target keeps its comments and order; new variables are appended. Shows what changes and asks before writing (unless --yes)
|
|
272
|
+
|
|
273
|
+
```
|
|
274
|
+
USAGE
|
|
275
|
+
$ aoox env promote FROM... TO... [-t <value>] [-u <value>] [--project <value>] [--all] [-y]
|
|
276
|
+
|
|
277
|
+
ARGUMENTS
|
|
278
|
+
FROM... Environment to copy the values from
|
|
279
|
+
TO... Environment to copy the values into
|
|
280
|
+
|
|
281
|
+
FLAGS
|
|
282
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
283
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
284
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
285
|
+
-y, --yes Do not ask for confirmation
|
|
286
|
+
--all Promote every variable of the source (those already equal are skipped)
|
|
287
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
288
|
+
|
|
289
|
+
DESCRIPTION
|
|
290
|
+
Copy variables from one environment to another (name them, or use --all). Needs the right to read the source and to
|
|
291
|
+
change the target. The target keeps its comments and order; new variables are appended. Shows what changes and asks
|
|
292
|
+
before writing (unless --yes)
|
|
293
|
+
|
|
294
|
+
EXAMPLES
|
|
295
|
+
$ aoox env promote staging production API_URL FEATURE_X
|
|
296
|
+
|
|
297
|
+
$ aoox env promote development staging --all --yes
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
_See code: [src/commands/env/promote.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/promote.ts)_
|
|
301
|
+
|
|
302
|
+
## `aoox env pull`
|
|
303
|
+
|
|
304
|
+
Write the variables of an environment to a local file (mode 0600), or to standard output with --file -. Refuses to overwrite unless --force. The read is recorded in the audit log
|
|
305
|
+
|
|
306
|
+
```
|
|
307
|
+
USAGE
|
|
308
|
+
$ aoox env pull [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--file <value>] [--force]
|
|
309
|
+
[--format dotenv|json|shell]
|
|
310
|
+
|
|
311
|
+
FLAGS
|
|
312
|
+
-e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
|
|
313
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
314
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
315
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
316
|
+
--file=<value> File to write, relative to the current folder; "-" writes to standard output (nothing else is
|
|
317
|
+
printed there). Default: .env, .env.json or .env.sh by format
|
|
318
|
+
--force Overwrite the file if it exists
|
|
319
|
+
--format=<option> [default: dotenv] dotenv (the stored text, comments kept), json ({"KEY":"value"}) or shell
|
|
320
|
+
(export KEY='value' lines for eval)
|
|
321
|
+
<options: dotenv|json|shell>
|
|
322
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
323
|
+
|
|
324
|
+
DESCRIPTION
|
|
325
|
+
Write the variables of an environment to a local file (mode 0600), or to standard output with --file -. Refuses to
|
|
326
|
+
overwrite unless --force. The read is recorded in the audit log
|
|
327
|
+
|
|
328
|
+
EXAMPLES
|
|
329
|
+
$ aoox env pull
|
|
330
|
+
|
|
331
|
+
$ aoox env pull --env staging --file .env.staging
|
|
332
|
+
|
|
333
|
+
$ aoox env pull --force
|
|
334
|
+
|
|
335
|
+
$ aoox env pull --format json --file -
|
|
336
|
+
|
|
337
|
+
$ aoox env pull --format shell --file -
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
_See code: [src/commands/env/pull.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/pull.ts)_
|
|
341
|
+
|
|
342
|
+
## `aoox env push`
|
|
343
|
+
|
|
344
|
+
Replace the whole text of an environment with a local .env file. Shows what is added, changed and removed and asks before writing (unless --yes); the write fails if someone else changed the environment in between
|
|
345
|
+
|
|
346
|
+
```
|
|
347
|
+
USAGE
|
|
348
|
+
$ aoox env push --file <value> [-t <value>] [-u <value>] [--project <value>] [-e <value>] [-y]
|
|
349
|
+
|
|
350
|
+
FLAGS
|
|
351
|
+
-e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
|
|
352
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
353
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
354
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
355
|
+
-y, --yes Do not ask for confirmation
|
|
356
|
+
--file=<value> (required) The .env file to upload
|
|
357
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
358
|
+
|
|
359
|
+
DESCRIPTION
|
|
360
|
+
Replace the whole text of an environment with a local .env file. Shows what is added, changed and removed and asks
|
|
361
|
+
before writing (unless --yes); the write fails if someone else changed the environment in between
|
|
362
|
+
|
|
363
|
+
EXAMPLES
|
|
364
|
+
$ aoox env push --file .env
|
|
365
|
+
|
|
366
|
+
$ aoox env push --file .env.staging --env staging --yes
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
_See code: [src/commands/env/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/push.ts)_
|
|
370
|
+
|
|
371
|
+
## `aoox env set ASSIGNMENTS`
|
|
372
|
+
|
|
373
|
+
Set one or more variables in an environment. Existing comments and order are kept; the write fails if someone else changed the environment in between
|
|
374
|
+
|
|
375
|
+
```
|
|
376
|
+
USAGE
|
|
377
|
+
$ aoox env set ASSIGNMENTS... [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--secret]
|
|
378
|
+
|
|
379
|
+
ARGUMENTS
|
|
380
|
+
ASSIGNMENTS... KEY=VALUE (the value is stored exactly as given)
|
|
381
|
+
|
|
382
|
+
FLAGS
|
|
383
|
+
-e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
|
|
384
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
385
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
386
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
387
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
388
|
+
--[no-]secret Mark the variables as secret (--secret: always masked in logs) or explicitly not secret
|
|
389
|
+
(--no-secret: never masked). Without either the flag is left as it is
|
|
390
|
+
|
|
391
|
+
DESCRIPTION
|
|
392
|
+
Set one or more variables in an environment. Existing comments and order are kept; the write fails if someone else
|
|
393
|
+
changed the environment in between
|
|
394
|
+
|
|
395
|
+
EXAMPLES
|
|
396
|
+
$ aoox env set API_URL=https://api.example.com
|
|
397
|
+
|
|
398
|
+
$ aoox env set GREETING="hello world" QUERY=a=b --env staging
|
|
399
|
+
|
|
400
|
+
$ aoox env set API_TOKEN=abc123 --secret
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
_See code: [src/commands/env/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/set.ts)_
|
|
404
|
+
|
|
405
|
+
## `aoox env unset KEYS`
|
|
406
|
+
|
|
407
|
+
Remove one or more variables from an environment. Comments and the other variables are kept; the write fails if someone else changed the environment in between
|
|
408
|
+
|
|
409
|
+
```
|
|
410
|
+
USAGE
|
|
411
|
+
$ aoox env unset KEYS... [-t <value>] [-u <value>] [--project <value>] [-e <value>]
|
|
412
|
+
|
|
413
|
+
ARGUMENTS
|
|
414
|
+
KEYS... Variable name(s) to remove
|
|
415
|
+
|
|
416
|
+
FLAGS
|
|
417
|
+
-e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
|
|
418
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
419
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
420
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
421
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
422
|
+
|
|
423
|
+
DESCRIPTION
|
|
424
|
+
Remove one or more variables from an environment. Comments and the other variables are kept; the write fails if
|
|
425
|
+
someone else changed the environment in between
|
|
426
|
+
|
|
427
|
+
EXAMPLES
|
|
428
|
+
$ aoox env unset OLD_KEY
|
|
429
|
+
|
|
430
|
+
$ aoox env unset A B --env staging
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
_See code: [src/commands/env/unset.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/env/unset.ts)_
|
|
162
434
|
|
|
163
435
|
## `aoox help [COMMAND]`
|
|
164
436
|
|
|
@@ -214,7 +486,7 @@ EXAMPLES
|
|
|
214
486
|
sudo aoox install --web-domain panel.example.com --api-domain api.panel.example.com --acme-email me@example.com
|
|
215
487
|
```
|
|
216
488
|
|
|
217
|
-
_See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
489
|
+
_See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/install.ts)_
|
|
218
490
|
|
|
219
491
|
## `aoox link`
|
|
220
492
|
|
|
@@ -226,7 +498,8 @@ USAGE
|
|
|
226
498
|
|
|
227
499
|
FLAGS
|
|
228
500
|
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
229
|
-
-u, --url=<value> [env: AOOX_URL]
|
|
501
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
502
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
230
503
|
--app=<value> Application ID; skip the interactive selection
|
|
231
504
|
--project=<value> Project ID; skip the interactive selection
|
|
232
505
|
|
|
@@ -239,11 +512,11 @@ EXAMPLES
|
|
|
239
512
|
$ aoox link --project <id> --app <id>
|
|
240
513
|
```
|
|
241
514
|
|
|
242
|
-
_See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
515
|
+
_See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/link.ts)_
|
|
243
516
|
|
|
244
517
|
## `aoox login`
|
|
245
518
|
|
|
246
|
-
Save the
|
|
519
|
+
Save the dashboard address and API token for other commands (the API address is discovered automatically)
|
|
247
520
|
|
|
248
521
|
```
|
|
249
522
|
USAGE
|
|
@@ -251,18 +524,21 @@ USAGE
|
|
|
251
524
|
|
|
252
525
|
FLAGS
|
|
253
526
|
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
254
|
-
-u, --url=<value> [env: AOOX_URL]
|
|
527
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
528
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
255
529
|
|
|
256
530
|
DESCRIPTION
|
|
257
|
-
Save the
|
|
531
|
+
Save the dashboard address and API token for other commands (the API address is discovered automatically)
|
|
258
532
|
|
|
259
533
|
EXAMPLES
|
|
260
534
|
$ aoox login
|
|
261
535
|
|
|
262
|
-
$ aoox login --url https://
|
|
536
|
+
$ aoox login --url https://dashboard.example.com --token aoox_xxx
|
|
537
|
+
|
|
538
|
+
$ aoox login --url 203.0.113.10:3000 --token aoox_xxx
|
|
263
539
|
```
|
|
264
540
|
|
|
265
|
-
_See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
541
|
+
_See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/login.ts)_
|
|
266
542
|
|
|
267
543
|
## `aoox plugins`
|
|
268
544
|
|
|
@@ -554,6 +830,43 @@ DESCRIPTION
|
|
|
554
830
|
|
|
555
831
|
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.5.2/src/commands/plugins/update.ts)_
|
|
556
832
|
|
|
833
|
+
## `aoox registry build IMAGE`
|
|
834
|
+
|
|
835
|
+
Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
|
|
836
|
+
|
|
837
|
+
```
|
|
838
|
+
USAGE
|
|
839
|
+
$ aoox registry build IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>] [--context <value>] [-f
|
|
840
|
+
<value>] [--push]
|
|
841
|
+
|
|
842
|
+
ARGUMENTS
|
|
843
|
+
IMAGE Image name and version, e.g. myapp:1.0.0
|
|
844
|
+
|
|
845
|
+
FLAGS
|
|
846
|
+
-f, --dockerfile=<value> [default: Dockerfile] Path to the Dockerfile
|
|
847
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
848
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
849
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
850
|
+
--context=<value> [default: .] Docker build context
|
|
851
|
+
--force Overwrite a version that already exists in the registry
|
|
852
|
+
--push Push the image to the registry right after the build
|
|
853
|
+
--registry=<value> Registry ID; defaults to the self-hosted registry
|
|
854
|
+
|
|
855
|
+
DESCRIPTION
|
|
856
|
+
Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
|
|
857
|
+
|
|
858
|
+
EXAMPLES
|
|
859
|
+
$ aoox registry build myapp:1.0.0
|
|
860
|
+
|
|
861
|
+
$ aoox registry build myapp:1.0.0 --push
|
|
862
|
+
|
|
863
|
+
$ aoox registry build team/api:2.1.0 -f docker/Dockerfile --context .
|
|
864
|
+
|
|
865
|
+
$ aoox registry build myapp:1.0.0 --force
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
_See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/registry/build.ts)_
|
|
869
|
+
|
|
557
870
|
## `aoox registry domain`
|
|
558
871
|
|
|
559
872
|
Set or remove the custom domain for the self-hosted registry
|
|
@@ -564,7 +877,8 @@ USAGE
|
|
|
564
877
|
|
|
565
878
|
FLAGS
|
|
566
879
|
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
567
|
-
-u, --url=<value> [env: AOOX_URL]
|
|
880
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
881
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
568
882
|
--clear Remove the domain, falling back to host:port
|
|
569
883
|
--set=<value> Domain for the self-hosted registry
|
|
570
884
|
|
|
@@ -577,7 +891,38 @@ EXAMPLES
|
|
|
577
891
|
$ aoox registry domain --clear
|
|
578
892
|
```
|
|
579
893
|
|
|
580
|
-
_See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
894
|
+
_See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/registry/domain.ts)_
|
|
895
|
+
|
|
896
|
+
## `aoox registry push IMAGE`
|
|
897
|
+
|
|
898
|
+
Push a local image to the aoox registry (refuses a version that already exists there)
|
|
899
|
+
|
|
900
|
+
```
|
|
901
|
+
USAGE
|
|
902
|
+
$ aoox registry push IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>]
|
|
903
|
+
|
|
904
|
+
ARGUMENTS
|
|
905
|
+
IMAGE Image name and version (short or full), e.g. myapp:1.0.0
|
|
906
|
+
|
|
907
|
+
FLAGS
|
|
908
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
909
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
910
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
911
|
+
--force Overwrite a version that already exists in the registry
|
|
912
|
+
--registry=<value> Registry ID; defaults to the self-hosted registry
|
|
913
|
+
|
|
914
|
+
DESCRIPTION
|
|
915
|
+
Push a local image to the aoox registry (refuses a version that already exists there)
|
|
916
|
+
|
|
917
|
+
EXAMPLES
|
|
918
|
+
$ aoox registry push myapp:1.0.0
|
|
919
|
+
|
|
920
|
+
$ aoox registry push registry.example.com/myapp:1.0.0
|
|
921
|
+
|
|
922
|
+
$ aoox registry push myapp:1.0.0 --force
|
|
923
|
+
```
|
|
924
|
+
|
|
925
|
+
_See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/registry/push.ts)_
|
|
581
926
|
|
|
582
927
|
## `aoox reinstall`
|
|
583
928
|
|
|
@@ -607,31 +952,85 @@ EXAMPLES
|
|
|
607
952
|
sudo aoox reinstall --yes --terminal-ssh-user root
|
|
608
953
|
```
|
|
609
954
|
|
|
610
|
-
_See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
955
|
+
_See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/reinstall.ts)_
|
|
956
|
+
|
|
957
|
+
## `aoox run`
|
|
958
|
+
|
|
959
|
+
Run a command with the variables of an environment, without writing them to disk. Put the command after `--`; its exit code is forwarded. The read is recorded in the audit log
|
|
960
|
+
|
|
961
|
+
```
|
|
962
|
+
USAGE
|
|
963
|
+
$ aoox run [-t <value>] [-u <value>] [--project <value>] [-e <value>] [--file <value>]
|
|
964
|
+
|
|
965
|
+
FLAGS
|
|
966
|
+
-e, --env=<value> [default: development] Environment name (development, staging, production, or a custom one)
|
|
967
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
968
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
969
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
970
|
+
--file=<value> A local .env file layered on top of the environment (it wins over aoox, which wins over the
|
|
971
|
+
current environment). Only read, never written
|
|
972
|
+
--project=<value> Project ID or name; defaults to the project of the application linked with `aoox link`
|
|
973
|
+
|
|
974
|
+
DESCRIPTION
|
|
975
|
+
Run a command with the variables of an environment, without writing them to disk. Put the command after `--`; its exit
|
|
976
|
+
code is forwarded. The read is recorded in the audit log
|
|
977
|
+
|
|
978
|
+
EXAMPLES
|
|
979
|
+
$ aoox run -- npm run dev
|
|
980
|
+
|
|
981
|
+
$ aoox run --env staging -- node server.js
|
|
982
|
+
|
|
983
|
+
$ aoox run --file .env.local -- npm run dev
|
|
984
|
+
```
|
|
985
|
+
|
|
986
|
+
_See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/run.ts)_
|
|
611
987
|
|
|
612
988
|
## `aoox update`
|
|
613
989
|
|
|
614
|
-
|
|
990
|
+
Update the aoox CLI itself (use `aoox update panel` to update the panel)
|
|
991
|
+
|
|
992
|
+
```
|
|
993
|
+
USAGE
|
|
994
|
+
$ aoox update [--check]
|
|
995
|
+
|
|
996
|
+
FLAGS
|
|
997
|
+
--check Only report whether a newer version exists; change nothing
|
|
998
|
+
|
|
999
|
+
DESCRIPTION
|
|
1000
|
+
Update the aoox CLI itself (use `aoox update panel` to update the panel)
|
|
1001
|
+
|
|
1002
|
+
EXAMPLES
|
|
1003
|
+
$ aoox update
|
|
1004
|
+
|
|
1005
|
+
$ aoox update --check
|
|
1006
|
+
```
|
|
1007
|
+
|
|
1008
|
+
_See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/update.ts)_
|
|
1009
|
+
|
|
1010
|
+
## `aoox update panel`
|
|
1011
|
+
|
|
1012
|
+
Check for or apply updates to the aoox panel itself (the aoox-api and aoox-web images)
|
|
615
1013
|
|
|
616
1014
|
```
|
|
617
1015
|
USAGE
|
|
618
|
-
$ aoox update [-t <value>] [-u <value>] [--apply]
|
|
1016
|
+
$ aoox update panel [-t <value>] [-u <value>] [--apply]
|
|
619
1017
|
|
|
620
1018
|
FLAGS
|
|
621
1019
|
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
622
|
-
-u, --url=<value> [env: AOOX_URL]
|
|
1020
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
1021
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
623
1022
|
--apply Apply the update if one is available (pull + restart)
|
|
624
1023
|
|
|
625
1024
|
DESCRIPTION
|
|
626
|
-
Check for or apply updates to the aoox panel itself
|
|
1025
|
+
Check for or apply updates to the aoox panel itself (the aoox-api and aoox-web images)
|
|
627
1026
|
|
|
628
1027
|
EXAMPLES
|
|
629
|
-
$ aoox update
|
|
1028
|
+
$ aoox update panel
|
|
630
1029
|
|
|
631
|
-
$ aoox update --apply
|
|
1030
|
+
$ aoox update panel --apply
|
|
632
1031
|
```
|
|
633
1032
|
|
|
634
|
-
_See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1033
|
+
_See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/update/panel.ts)_
|
|
635
1034
|
|
|
636
1035
|
## `aoox whoami`
|
|
637
1036
|
|
|
@@ -643,7 +1042,8 @@ USAGE
|
|
|
643
1042
|
|
|
644
1043
|
FLAGS
|
|
645
1044
|
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
646
|
-
-u, --url=<value> [env: AOOX_URL]
|
|
1045
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
1046
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
647
1047
|
|
|
648
1048
|
GLOBAL FLAGS
|
|
649
1049
|
--json Format output as json.
|
|
@@ -657,7 +1057,7 @@ EXAMPLES
|
|
|
657
1057
|
$ aoox whoami --json
|
|
658
1058
|
```
|
|
659
1059
|
|
|
660
|
-
_See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1060
|
+
_See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.9/src/commands/whoami.ts)_
|
|
661
1061
|
<!-- commandsstop -->
|
|
662
1062
|
|
|
663
1063
|
## Versioning
|