@hyperscale0/cli 1.0.0-beta.2 → 1.0.0-beta.3

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 +26 -17
  2. package/hyperscale.js +58 -37
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,18 +2,20 @@
2
2
 
3
3
  The Hyperscale founder command line. It logs a founder in, discovers public
4
4
  Blueprints, composes Products, manages sandbox API keys, and runs one Product's
5
- frozen public verbs.
5
+ frozen public actions.
6
6
 
7
7
  ## Use
8
8
 
9
- Request access at https://hyperscale0.ai/request-access.
9
+ Mint a founder PAT in the portal at https://hyperscale0.ai/desk. Open Security,
10
+ then Personal access tokens. Unapproved founders can request access at
11
+ https://hyperscale0.ai/request-access.
10
12
 
11
13
  ```bash
12
14
  export HYPERSCALE_TOKEN=<your founder PAT>
13
15
  bunx @hyperscale0/cli auth login
14
16
  bunx @hyperscale0/cli whoami
15
17
  bunx @hyperscale0/cli blueprint list
16
- bunx @hyperscale0/cli product create --blueprint vehicle-escrow-marketplace --name "Vehicle Escrow"
18
+ bunx @hyperscale0/cli product create --blueprint luxury-goods-consignment-escrow --name "Luxury Consignment"
17
19
  bunx @hyperscale0/cli key create --name "Founder laptop"
18
20
  bunx @hyperscale0/cli compose check product.hsx
19
21
  bunx @hyperscale0/cli compose plan product.hsx
@@ -24,15 +26,16 @@ bunx @hyperscale0/cli activity list
24
26
  bunx @hyperscale0/cli ops list payment
25
27
 
26
28
  export HYPERSCALE_API_KEY=<your Product API key>
27
- bunx @hyperscale0/cli product verbs
28
- bunx @hyperscale0/cli product verbs escrow.release --json
29
- bunx @hyperscale0/cli product run escrow.release --input '{"saleId":"sale_sandbox_..."}'
29
+ bunx @hyperscale0/cli product actions
30
+ bunx @hyperscale0/cli product actions escrow_order.placeBuyerHold --json
31
+ bunx @hyperscale0/cli product run escrow_order.placeBuyerHold --input '{"escrowOrderId":"eord_sandbox_..."}'
30
32
  bunx @hyperscale0/cli call account.list --input '{"limit":5}'
31
33
  ```
32
34
 
33
- `product verbs` lists the frozen Product surface. Pass one exact public
34
- operation id such as `escrow.release` to return its full input schema, output
35
- schema, policies, build id, surface version, and operation-set digest.
35
+ `product actions` lists the frozen Product surface. Pass one exact public
36
+ operation id such as `escrow_order.placeBuyerHold` to return its full input
37
+ schema, output schema, policies, build id, surface version, and operation-set
38
+ digest.
36
39
  `compose check` compiles textual HSX and runs the independent composer check.
37
40
  `compose plan` diffs it against the selected Product. `compose apply`
38
41
  recomposes that Product and requires `--confirm`, or `--yes` for an agent.
@@ -40,18 +43,24 @@ Compiler or composer refusal exits 2. Transport and server failure exit 1.
40
43
  `npx @hyperscale0/cli` runs the same commands. Add
41
44
  `--json` for machine-readable success and failure output.
42
45
 
43
- Founder control commands, including `ops`, `team`, and `activity`, use
44
- `HYPERSCALE_TOKEN`. Product-key commands use
45
- `HYPERSCALE_API_KEY` and need no founder login profile. On a clean machine,
46
- set the Product API key and pass `--product <id>`. Use `--base-url` and
46
+ Founder PAT commands are `auth`, `whoami`, `product create/list/show`,
47
+ `compose plan/apply`, `key`, `team`, and `activity`. They use
48
+ `--token`, `HYPERSCALE_TOKEN`, or a stored login in that order. Product API
49
+ key commands are `product actions/run`, `ops list`, and `call`. They use
50
+ `HYPERSCALE_API_KEY` and need no founder login profile. `compose check`
51
+ runs locally when no founder credential exists. On a clean machine, set the
52
+ Product API key and pass `--product <id>`. Use `--base-url` and
47
53
  `--environment` when their defaults do not name the Product's plane.
48
54
 
49
55
  Point it at another host with `--base-url`, and at the live plane with
50
56
  `--environment live`. Live keys and sandbox keys are never interchangeable.
51
- The CLI stores the founder PAT in macOS Keychain, with a 0600 file fallback on
52
- systems where Keychain is unavailable. `auth logout` deletes local state and
53
- does not revoke the PAT. `auth logout --revoke` revokes the active PAT before
54
- deleting local state. Passkey login stays in the portal at
57
+ The CLI stores the founder PAT in macOS Keychain by default. If Keychain is
58
+ unavailable, it falls back to an owner-only 0600 file under
59
+ `HYPERSCALE_CONFIG_DIR`, or `~/.config/hyperscale` by default. Set
60
+ `HYPERSCALE_CREDENTIAL_STORE=file` to choose that file store and skip
61
+ Keychain access. `auth logout` deletes local state and does not revoke the
62
+ PAT. `auth logout --revoke` revokes the active PAT before deleting local
63
+ state. Passkey login stays in the portal at
55
64
  https://hyperscale0.ai/signin.
56
65
 
57
66
  Run `bunx @hyperscale0/cli --help` for the full option list.