zk-agent-cli 0.1.0-rc.9 → 1.0.1

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 +83 -12
  2. package/dist/index.js +916 -61
  3. package/package.json +10 -3
package/README.md CHANGED
@@ -1,18 +1,68 @@
1
1
  # zk-agent-cli
2
2
 
3
- `zk-agent-cli` is the packaged terminal CLI for the default zk-agent product path on
4
- zkSync Era and zkSync Sepolia.
3
+ `zk-agent-cli` is the packaged local-first, payment-first CLI for the default
4
+ zk-agent product path on zkSync Era and zkSync Sepolia.
5
+
6
+ **Prove one zkSync-native pay path in minutes, keep wallet control local, and
7
+ grow into Agent Pay on the same runtime.**
5
8
 
6
9
  This is the packaged CLI manual for the public product shell:
7
- `start -> next -> wallet create/reapprove -> next -> pay -> suite`,
10
+ `setup -> start -> wallet create --await-local -> next -> pay -> suite`,
8
11
  with `submit`, `workspace`, `handoff`, and `feed` as the current Agent Pay
9
12
  shortcuts.
10
13
 
11
- ## Why This CLI Exists
14
+ For npm users evaluating it quickly, the product claim is simple:
15
+
16
+ - pay first on one local-first zkSync-native path
17
+ - keep Agent Pay follow-up on the same runtime instead of splitting it into
18
+ another product
19
+ - use `payment publish -> payment serve` as the current public hosted-preview
20
+ proof, not as a claim of multi-tenant hosting
21
+
22
+ ## Install in 30 Seconds
23
+
24
+ Use the install path that matches your environment:
25
+
26
+ ```bash
27
+ npx skills add https://github.com/AgiWeb3/zk-agent-cli
28
+ npx zk-agent-cli --help
29
+ npm install -g zk-agent-cli
30
+ ```
31
+
32
+ - `skills add`: install into an agent harness
33
+ - `npx zk-agent-cli`: one-shot evaluation without a global install
34
+ - `npm install -g zk-agent-cli`: keep `zk-agent` on your shell path
35
+
36
+ ## First Minute After Install
37
+
38
+ If you only want the shortest public proof, do this and stop at the first
39
+ successful pay:
40
+
41
+ ```bash
42
+ zk-agent setup
43
+ zk-agent start
44
+ zk-agent wallet create --await-local
45
+ zk-agent next
46
+ zk-agent pay --wallet main --to <address> --amount <amount>
47
+ zk-agent suite
48
+ ```
12
49
 
13
- - keep wallet and session control local-first
14
- - keep the default execution story zkSync-native and `sed-lite`-first
15
- - add an Agent Pay request layer above direct workflow execution
50
+ That is the current packaged story in one minute:
51
+
52
+ - install once
53
+ - prove one zkSync-native pay path
54
+ - open the broader packaged surface only after that first success
55
+
56
+ ## Product Shell
57
+
58
+ - pay first: prove one zkSync-native send path before learning the broader
59
+ packaged surface
60
+ - stay on one runtime: keep Agent Pay follow-up, workspace, handoff, and feed
61
+ on the same wallet runtime
62
+ - current public hosted-preview proof:
63
+ `zk-agent payment publish` + `zk-agent payment serve`
64
+ already mark the hosted-preview boundary without claiming a multi-tenant
65
+ control plane
16
66
 
17
67
  ## What Makes It Different
18
68
 
@@ -22,12 +72,16 @@ shortcuts.
22
72
  execution
23
73
  - one Agent Pay layer that stays attached to the same wallet runtime instead
24
74
  of splitting into a separate product
75
+ - one public hosted-preview proof on top of that same request/export layer:
76
+ `payment publish -> payment serve`
25
77
 
26
78
  ## Best Fit
27
79
 
28
80
  - local-first wallet and session control on zkSync is the real need
29
81
  - the first proof should be one zkSync-native pay path, not broad multichain
30
82
  exploration
83
+ - the shortest path should be "prove one pay route first" instead of reading a
84
+ broad command catalog first
31
85
  - Agent Pay should stay attached to the same wallet runtime instead of
32
86
  becoming a separate operator tool
33
87
 
@@ -36,6 +90,8 @@ shortcuts.
36
90
  - hosted relay is still the fallback path, not the default onboarding story
37
91
  - Agent Pay is a local-first workbench today, not yet a hosted multi-tenant
38
92
  control plane
93
+ - the hosted-preview proof is real, but it is still one operator-controlled
94
+ boundary rather than a hosted platform or control plane
39
95
 
40
96
  Use:
41
97
 
@@ -72,7 +128,7 @@ the first proof from a clean machine:
72
128
 
73
129
  ```bash
74
130
  zk-agent setup
75
- zk-agent next
131
+ zk-agent start
76
132
  zk-agent wallet create --await-local
77
133
  zk-agent next
78
134
  zk-agent pay --wallet main --to <address> --amount <amount>
@@ -88,9 +144,11 @@ smallest matching entrypoint.
88
144
 
89
145
  `zk-agent start` is the public onboarding command that keeps the same output
90
146
  contract as `zk-agent next`. Use `start` when you want the shortest obvious
91
- first-touch command. Keep `next` as the canonical operator/runtime contract in
92
- scripts and JSON examples. If local defaults do not exist yet, both `start`
93
- and `next` still send you through `zk-agent setup` first.
147
+ first-touch command after install. Keep `next` as the canonical
148
+ operator/runtime contract in scripts and JSON examples. If local defaults do
149
+ not exist yet, both `start` and `next` still send you through `zk-agent setup`
150
+ first. On the public first-proof path, `start` is the front door and `next`
151
+ is the follow-up step after wallet approval.
94
152
 
95
153
  `zk-agent pay` is the public shortcut for the flagship send path. The scoped
96
154
  form remains `zk-agent workflow pay`.
@@ -101,6 +159,10 @@ single-request integration-ready Agent Pay export. The scoped form remains
101
159
  `zk-agent payment handoff`.
102
160
  `zk-agent feed` is the public shortcut for the integration-ready Agent Pay
103
161
  cross-request export. The scoped form remains `zk-agent payment feed`.
162
+ `zk-agent payment publish` materializes the current
163
+ `workspace` / `feed` / `handoff` Agent Pay bundle as a hostable static export.
164
+ `zk-agent payment serve` hosts that same bundle from one operator-controlled
165
+ static endpoint.
104
166
 
105
167
  If you are new, stop at the first successful `zk-agent pay`. Ignore
106
168
  `suite`, `payment`, and `relay` until that baseline path works once, unless
@@ -213,6 +275,15 @@ That path shows compact ingress, wallet-aware follow-up, approval readiness,
213
275
  workspace summary, single-request handoff bundling, and cross-request feed
214
276
  export without leaving the local-first surface.
215
277
 
278
+ That same `workspace -> handoff -> feed` chain is also the current public
279
+ Agent Pay proof on the hosted-preview boundary: an external dashboard, agent,
280
+ or backend can consume the stable exports today from the same runtime or one
281
+ operator-controlled host. `zk-agent payment publish` is the static half of
282
+ that proof, and `zk-agent payment serve` is the hosted half. That preview is
283
+ already proven on one stable public URL; the next step is to grow from that
284
+ proof toward clearer hosted platform semantics without claiming a
285
+ multi-tenant control plane too early.
286
+
216
287
  For the shortest product demo narrative behind that path, use
217
288
  [`docs/20-agent-pay-demo-narrative.md`](../../docs/20-agent-pay-demo-narrative.md).
218
289
 
@@ -523,7 +594,7 @@ Inside `suite`, the shortest way to think about Agent Pay is:
523
594
  - `feed`: export the stable cross-request batch view
524
595
 
525
596
  The shortest tracked route inside `suite` remains:
526
- `submit -> next -> approval -> workspace -> handoff -> feed`.
597
+ `submit -> payment next -> approval -> workspace -> handoff -> feed`.
527
598
 
528
599
  For the clearest Agent Pay proof path inside `suite`, follow:
529
600