@haakco/hostingctl 1.0.412 → 1.0.522
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 +29 -18
- package/dist/main.js +2006 -619
- package/dist/main.js.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -7,14 +7,16 @@ generates its own client from `api/openapi.json`, so its request and response ty
|
|
|
7
7
|
|
|
8
8
|
Generation does **not** decide which operations have a command — a generated function nobody calls is a
|
|
9
9
|
feature nobody can use. That accounting lives in `src/commands/operation-map.ts`, which names every published
|
|
10
|
-
operation and either the route that reaches it, a shared read, a protocol consumer,
|
|
11
|
-
|
|
10
|
+
operation and either the route that reaches it, a shared read, a protocol consumer, a route that exists only to
|
|
11
|
+
refuse, or the milestone that owes it a command; `just cli-test` fails when an operation is unaccounted for or a
|
|
12
|
+
mapped route does not exist.
|
|
12
13
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
14
|
+
Every published operation is accounted for, and the map holds the current totals rather than this page: each one
|
|
15
|
+
is reachable from a command, a file route a command redeems with a single-use grant it minted, a protocol consumer
|
|
16
|
+
the API calls rather than a person, the refusal-only rollback route (the platform refuses every call, and recovery
|
|
17
|
+
is a new reviewed release), or a billing operation the panel will own (plan 120). `just cli-test` fails when an
|
|
18
|
+
operation is unaccounted for, when a route names a command that does not exist, and when a planned entry is
|
|
19
|
+
already reachable.
|
|
18
20
|
|
|
19
21
|
## Install
|
|
20
22
|
|
|
@@ -201,10 +203,14 @@ metadata and compared against it in CI. The groups, in one line each:
|
|
|
201
203
|
| Command | Covers |
|
|
202
204
|
| --- | --- |
|
|
203
205
|
| `whoami`, `environments`, `system`, `diagnostics` | The session's identity and reach, every environment in a company, what the cluster still holds, and the platform's health answer |
|
|
204
|
-
| `watch` |
|
|
206
|
+
| `watch` | The same environment reads as a screen that refreshes itself. It ships in the Rust build the platform packages carry; the JavaScript bundle has no `watch` |
|
|
207
|
+
| `billing` | The issuer, the price book, the discount codes a client can redeem, a month's run, the invoices and credit notes we issued, and the client's own documents |
|
|
208
|
+
| `purchases` | What a company was sold: the record, its size and its term |
|
|
209
|
+
| `backup-destination` | The company's own bucket that also receives its backups |
|
|
210
|
+
| `secret-connection` | An environment's connections to a customer's own secret manager |
|
|
205
211
|
| `company` | The company itself, its members and roles, its activity, its logo and favicon, and the invitation journey |
|
|
206
212
|
| `environment` | Create, read, scale, retry; profile coverage, domains and redirects, databases and exports, configuration and secrets, services, site access, shared runtime and application, tools, tuning, retention, portable export, and the release bundle |
|
|
207
|
-
| `application` | Create, rename, remove; build and deploy, build logs, runs and run logs, process schedules; recovery review and confirm; the HTTP cache and path routes; source binding; site access; the WordPress import and URL repair; the administrator credential |
|
|
213
|
+
| `application` | Create, rename, remove; build and deploy, build logs, runs and run logs, process schedules; recovery review and confirm; the HTTP cache and path routes; source binding; site access; the WordPress import and URL repair; the administrator credential; the component's publishable anonymous key |
|
|
208
214
|
| `access` | Who may reach one environment: settings, grants, SSH keys, the shared password, and the per-user view |
|
|
209
215
|
| `site-user` | The accounts that sign in to a company's sites |
|
|
210
216
|
| `keys` | The account's personal SSH keys and where each is granted |
|
|
@@ -216,8 +222,11 @@ metadata and compared against it in CI. The groups, in one line each:
|
|
|
216
222
|
| `realm`, `repository` | One environment's deployment realm; the GitHub connections an application deploys from |
|
|
217
223
|
| `platform` | Platform-only work: domain claims and purge attestations, the client directory, company and account closure, alerts, the GitHub App, Yahoo feedback, and the prepared-content catalogue |
|
|
218
224
|
| `login`, `auth` | Signing in and out; the session's own reads, the account's settings, push tokens and impersonation |
|
|
225
|
+
| `update`, `completion`, `help`, `reference` | This machine only: update this copy, print a shell completion, and print help or the generated command reference |
|
|
219
226
|
|
|
220
|
-
Every write needs `--confirm`; `--dry-run` describes the change and sends
|
|
227
|
+
Every write needs `--confirm`; `--dry-run` describes the change and sends no write. It is not a promise of
|
|
228
|
+
silence: a command whose description needs the API's own metadata still reads it, so `environment create
|
|
229
|
+
--dry-run` reads the package catalogue before it prints the change it would make.
|
|
221
230
|
|
|
222
231
|
Options: `--api-url` (or `HOSTINGCTL_API_URL`) — the API base **including `/api/v1`**, which is
|
|
223
232
|
also the frontend's `VITE_API_URL` default — `--token` (or `HOSTINGCTL_TOKEN`), `--json`, `--help`.
|
|
@@ -332,8 +341,10 @@ hostingctl mailbox recovery verify --token-file ~/token --confirm
|
|
|
332
341
|
hostingctl mailbox recovery reset --token-file ~/token --password-file ~/password --confirm
|
|
333
342
|
```
|
|
334
343
|
|
|
335
|
-
These three
|
|
336
|
-
|
|
344
|
+
These three are the only API commands that run with **no token and no session**: `login` establishes a session,
|
|
345
|
+
`auth register`/`forgot-password`/`reset-password` are the public account routes, and `help`, `completion`,
|
|
346
|
+
`reference` and `update` answer on this machine and never reach the API at all. Point the recovery commands at
|
|
347
|
+
the API with `--api-url` or `HOSTINGCTL_API_URL`. The recovery token and the new password are read from a
|
|
337
348
|
`--<name>-file` (a regular file no wider than mode 600) or `--<name>-stdin`, never from an argument, and
|
|
338
349
|
are never printed. `verify` confirms a fallback address; `reset` sets a new confirmed password and
|
|
339
350
|
reports that the change is recorded and applied in the background. A password reset does not change your
|
|
@@ -421,14 +432,14 @@ document. Uploading and previewing writes nothing; the confirmed import is `emai
|
|
|
421
432
|
capability as creating one mailbox by hand.
|
|
422
433
|
|
|
423
434
|
```text
|
|
424
|
-
hostingctl
|
|
425
|
-
hostingctl
|
|
426
|
-
hostingctl
|
|
435
|
+
hostingctl mailbox import preview <email-domain-uuid> --company acme --format csv --file mailboxes.csv
|
|
436
|
+
hostingctl mailbox import confirm <email-domain-uuid> --company acme --format yaml --file mailboxes.yaml --dry-run
|
|
437
|
+
hostingctl mailbox import confirm <email-domain-uuid> --company acme --format yaml --file mailboxes.yaml --confirm
|
|
427
438
|
```
|
|
428
439
|
|
|
429
|
-
The `--file` is a `localPart,quota` CSV
|
|
430
|
-
|
|
431
|
-
|
|
440
|
+
The `--file` is a `localPart,quota` CSV or a versioned YAML document, and `--format` says which of the two it is
|
|
441
|
+
(`csv` or `yaml`), because the CLI does not guess a format from a filename; the file is read from disk, bounded,
|
|
442
|
+
and never printed. `preview` classifies every declaration against the name and reports what
|
|
432
443
|
it would create, what already matches and what is refused, without writing anything. `confirm`
|
|
433
444
|
re-runs that review to obtain the digest the API requires, then creates the reviewed declarations. It
|
|
434
445
|
needs `--confirm`; `--dry-run` describes the batch without sending it. An import is create-only: a
|