@hyperscale0/cli 1.0.0-beta.30 → 1.0.0-beta.32

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 (3) hide show
  1. package/README.md +34 -13
  2. package/hyperscale.js +59 -49
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -14,15 +14,40 @@ Use `bunx @hyperscale0/cli@latest` or `npx @hyperscale0/cli@latest`
14
14
  without a global install. Browser login requests read-only scopes through
15
15
  portal consent. Request different scopes with `auth login --scopes <scope,...>`.
16
16
  The login summary shows the authority actually returned by the server.
17
+ Headless email login uses `auth login --email founder@example.com --no-browser`
18
+ in sandbox or live. The password prompt requires a TTY. Passwords and temporary sessions never
19
+ enter files or saved replay requests. Use browser sign-in for terms.
20
+ Default scopes include blueprints:read for `compose check`. Creation requires
21
+ explicit reauthorization:
22
+
23
+ ```sh
24
+ env -u HYPERSCALE_TOKEN hyperscale auth login --base-url https://dev.hyperscale0.ai --environment sandbox --scopes activity:read,billing:read,blueprints:read,catalog:read,finance:read,products:read,blueprints:write
25
+ ```
26
+
17
27
  Headless callers can use `auth login --no-browser --token <pat>`.
18
28
 
19
29
  ## Product commands
20
30
 
21
31
  `product select <id>` saves a Product. Member PATs use that Product's route.
22
- `product actions` lists the selected Build's exact public action names.
23
- `product run <instrument.action> --input-file request.json` runs one.
24
- Product API keys still work through `HYPERSCALE_API_KEY` or `--api-key`.
25
- The server's frozen operation set resolves aliases, never the bundled catalog.
32
+ Use a Product API key in `HYPERSCALE_API_KEY` for object operations.
33
+ Keep Product identity in the input and omit the global `--product` flag:
34
+
35
+ ```sh
36
+ hyperscale call product.objects.discover --input '{"productId":"<product-id>"}' --json
37
+ hyperscale call product.objects.create --input '{"productId":"<product-id>","kind":"<kind>"}' --idempotency-key object-001 --json
38
+ hyperscale call product.objects.actions --input '{"productId":"<product-id>","kind":"<kind>","objectId":"<object-id>"}' --json
39
+ hyperscale call product.objects.execute --input-file action.json --idempotency-key action-001 --json
40
+ ```
41
+
42
+ Copy action.name, productBuildId, digest and target from the chosen available
43
+ action into action.json. Also include productId, kind, objectId, expectedRevision
44
+ from the actions response, and required fields and input. Copy instanceId when
45
+ present in target. Object creation never enters an agreement or moves money.
46
+ Use product.objects.list and product.objects.retrieve for stored objects.
47
+ See https://hyperscale0.ai/docs/runtime.md for the complete request shape.
48
+
49
+ Low-level `product actions` and `product run` remain for admitted operations.
50
+ Instrument creation stays internal to object attachment execution.
26
51
 
27
52
  `ops list --catalog` browses catalog command data without authentication.
28
53
  `ops list` discovers operations for the active credential and Product.
@@ -30,18 +55,16 @@ The server's frozen operation set resolves aliases, never the bundled catalog.
30
55
  `compose check/plan/apply <file.hsx>` uses the server composer.
31
56
  Run `hyperscale help <command>` for options and examples.
32
57
 
33
- ## Review and resume
58
+ ## Resume
34
59
 
35
- HTTP 409 `approval_required` prints the server review URL, approval request
36
- ID, waiting state and a local resume reference. Review happens in the browser.
60
+ A transport failure or interrupted dispatch prints a local resume reference.
37
61
  Then run `hyperscale resume <reference>`. Resume replays the same origin,
38
62
  environment, credential, path, body bytes and idempotency key from secure local
39
- storage. Body and credential overrides are refused. `--yes` cannot approve
40
- money. Approval is not evidence of execution.
63
+ storage. Body and credential overrides are refused.
41
64
 
42
65
  A lost response does not mean failure. Keep the printed operation reference
43
66
  and read its status before retrying. Resume never creates a new idempotency key.
44
- Successful requests remove their saved credential copy. Review and uncertain
67
+ Successful requests remove their saved credential copy. Uncertain
45
68
  requests remain local until they complete. Logout removes the login credential;
46
69
  it does not revoke separately saved pending requests. Use portal token revocation
47
70
  if those requests must lose server authority.
@@ -50,9 +73,7 @@ if those requests must lose server authority.
50
73
 
51
74
  `--json` writes success to stdout and one error object to stderr on failure.
52
75
  Errors retain HTTP status, code, message, fix, details and available correlation
53
- IDs. Approval details include `approvalRequestId`, `reviewUrl`, `state`
54
- and `resumeReference`. Exit 0 means success, 1 means failure or waiting for
55
- review, and 2 means composer refusal. JSON help is also available.
76
+ IDs. Exit 0 means success, 1 means failure, and 2 means composer refusal. JSON help is also available.
56
77
 
57
78
  Human output honors non-TTY streams, narrow terminals and NO_COLOR, including
58
79
  an empty NO_COLOR value. Identifiers are never shortened.