Repository navigation
Expand file tree
/
Copy pathzeroshot-cli.html
More file actions
1051 lines (792 loc) · 41.4 KB
/
Copy pathzeroshot-cli.html
File metadata and controls
1051 lines (792 loc) · 41.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<!-- @generated by `cargo run -p zeroshot --example generate_cli_docs -- --write`; do not edit. -->
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>zeroshot CLI reference</title>
<style>
:root { color-scheme: light dark; font-family: system-ui, sans-serif; }
body { margin: 0 auto; max-width: 72rem; padding: 2rem; line-height: 1.5; }
nav ul { columns: 2; padding-left: 1.25rem; }
code, pre { font-family: ui-monospace, SFMono-Regular, Consolas, monospace; }
pre { overflow-x: auto; padding: 1rem; border: 1px solid #8886; border-radius: .4rem; background: #8881; }
section { margin-block: 2.5rem; }
.generated { color: #666; }
@media (max-width: 40rem) { body { padding: 1rem; } nav ul { columns: 1; } }
</style>
</head>
<body>
<main>
<h1>zeroshot CLI reference</h1>
<p class="generated">Generated from the typed Clap command model and its Rust doc comments. Regenerate with <code>cargo run -p zeroshot --example generate_cli_docs -- --write</code>.</p>
<nav aria-label="Command index"><h2>Commands</h2><ul>
<li><a href="#zeroshot"><code>zeroshot</code></a></li>
<li><a href="#zeroshot-acp"><code>zeroshot acp</code></a></li>
<li><a href="#zeroshot-ui"><code>zeroshot ui</code></a></li>
<li><a href="#zeroshot-target"><code>zeroshot target</code></a></li>
<li><a href="#zeroshot-target-add"><code>zeroshot target add</code></a></li>
<li><a href="#zeroshot-target-login"><code>zeroshot target login</code></a></li>
<li><a href="#zeroshot-target-serve"><code>zeroshot target serve</code></a></li>
<li><a href="#zeroshot-target-help"><code>zeroshot target help</code></a></li>
<li><a href="#zeroshot-connection"><code>zeroshot connection</code></a></li>
<li><a href="#zeroshot-connection-list"><code>zeroshot connection list</code></a></li>
<li><a href="#zeroshot-connection-set"><code>zeroshot connection set</code></a></li>
<li><a href="#zeroshot-connection-delete"><code>zeroshot connection delete</code></a></li>
<li><a href="#zeroshot-connection-help"><code>zeroshot connection help</code></a></li>
<li><a href="#zeroshot-profile"><code>zeroshot profile</code></a></li>
<li><a href="#zeroshot-profile-list"><code>zeroshot profile list</code></a></li>
<li><a href="#zeroshot-profile-set"><code>zeroshot profile set</code></a></li>
<li><a href="#zeroshot-profile-show"><code>zeroshot profile show</code></a></li>
<li><a href="#zeroshot-profile-remove"><code>zeroshot profile remove</code></a></li>
<li><a href="#zeroshot-profile-default"><code>zeroshot profile default</code></a></li>
<li><a href="#zeroshot-profile-help"><code>zeroshot profile help</code></a></li>
<li><a href="#zeroshot-template"><code>zeroshot template</code></a></li>
<li><a href="#zeroshot-template-list"><code>zeroshot template list</code></a></li>
<li><a href="#zeroshot-template-show"><code>zeroshot template show</code></a></li>
<li><a href="#zeroshot-template-help"><code>zeroshot template help</code></a></li>
<li><a href="#zeroshot-plan"><code>zeroshot plan</code></a></li>
<li><a href="#zeroshot-plan-validate"><code>zeroshot plan validate</code></a></li>
<li><a href="#zeroshot-plan-submit"><code>zeroshot plan submit</code></a></li>
<li><a href="#zeroshot-plan-status"><code>zeroshot plan status</code></a></li>
<li><a href="#zeroshot-plan-watch"><code>zeroshot plan watch</code></a></li>
<li><a href="#zeroshot-plan-force-stop"><code>zeroshot plan force-stop</code></a></li>
<li><a href="#zeroshot-plan-help"><code>zeroshot plan help</code></a></li>
<li><a href="#zeroshot-run"><code>zeroshot run</code></a></li>
<li><a href="#zeroshot-update"><code>zeroshot update</code></a></li>
<li><a href="#zeroshot-list"><code>zeroshot list</code></a></li>
<li><a href="#zeroshot-status"><code>zeroshot status</code></a></li>
<li><a href="#zeroshot-watch"><code>zeroshot watch</code></a></li>
<li><a href="#zeroshot-logs"><code>zeroshot logs</code></a></li>
<li><a href="#zeroshot-attach"><code>zeroshot attach</code></a></li>
<li><a href="#zeroshot-force-stop"><code>zeroshot force-stop</code></a></li>
<li><a href="#zeroshot-resume"><code>zeroshot resume</code></a></li>
<li><a href="#zeroshot-checkpoints"><code>zeroshot checkpoints</code></a></li>
<li><a href="#zeroshot-discard-workspace"><code>zeroshot discard-workspace</code></a></li>
<li><a href="#zeroshot-version"><code>zeroshot version</code></a></li>
<li><a href="#zeroshot-help"><code>zeroshot help</code></a></li>
</ul></nav>
<section id="zeroshot"><h2><code>zeroshot</code></h2>
<pre><code>Run multi-agent graphs locally or on named Zeroshot targets.
Single-result commands write JSON. Foreground `run`, `watch`, `logs`, and `attach` stream newline-delimited JSON (NDJSON).
Usage: zeroshot [COMMAND]
Commands:
acp Serve one local Zeroshot profile as an experimental ACP agent over stdio
ui Serve the local profile editor and live or recorded run history
target Manage named targets or serve a direct target
connection Inspect and manage named runtime connections
profile Manage reusable graph/runtime profiles
template Inspect built-in graph templates
plan Validate, submit, and observe hosted merge plans
run Submit a graph run locally or to a named target
update Update this executable and managed agent skill to the newest canonical release
list List runs as JSON
status Read a run's current status as JSON
watch Follow a run's durable event stream as NDJSON
logs Follow a run's log stream as NDJSON
attach Attach to an execution's interactive event stream as NDJSON
force-stop Force a run to stop and write the result as JSON
resume Start a new attempt from a failed run's retained workspace or a saved checkpoint
checkpoints List one page of a run's saved workspace checkpoints as JSON
discard-workspace Permanently delete an abandoned retained target workspace
version Print the Zeroshot version
help Print this message or the help of the given subcommand(s)
Options:
-V, --version
Print the Zeroshot version
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-acp"><h3><code>zeroshot acp</code></h3>
<pre><code>Serve one local Zeroshot profile as an experimental ACP agent over stdio.
The MVP supports one active session and text prompts. The profile must accept one task string and return one response string from every success node. It supports local Codex or Claude node-instance sessions, without maps, delivery, connections, MCP, or session reload.
Usage: zeroshot acp --profile <local:NAME>
Options:
--profile <local:NAME>
Local profile exposed by this agent process, in local:NAME form
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-ui"><h3><code>zeroshot ui</code></h3>
<pre><code>Serve the local profile editor and live or recorded run history.
Open the printed /ui/ URL. Profiles always use the CLI's local store. Run history uses the local controller unless --target selects a configured target. Ctrl-C stops the UI server; active runs continue.
Usage: zeroshot ui [OPTIONS]
Options:
--listen <LISTEN>
Loopback address for the local UI
[default: 127.0.0.1:4173]
--target <NAME>
Read run history from this configured target. Profiles remain local
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-target"><h3><code>zeroshot target</code></h3>
<pre><code>Manage named targets or serve a direct target.
The built-in `cloud` target points to https://api.cloud.zeroshot.sh. Run `zeroshot target login cloud` to sign in.
Usage: zeroshot target <COMMAND>
Commands:
add Register a named target
login Authenticate with a hosted named target
serve Serve an unauthenticated direct target
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-target-add"><h4><code>zeroshot target add</code></h4>
<pre><code>Register a named target
Usage: zeroshot target add [OPTIONS] --url <ORIGIN> <NAME>
Arguments:
<NAME>
Local name used to select this target
Options:
--url <ORIGIN>
Target origin URL
--direct
Use unauthenticated direct access instead of hosted authentication
-h, --help
Print help</code></pre></section>
<section id="zeroshot-target-login"><h4><code>zeroshot target login</code></h4>
<pre><code>Authenticate with a hosted named target.
On Linux, desktop sessions prefer Secret Service and headless sessions use a durable private file. Set ZEROSHOT_CREDENTIAL_STORE to auto, system, or file to override automatic selection.
Usage: zeroshot target login <NAME>
Arguments:
<NAME>
Local target name
Options:
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-target-serve"><h4><code>zeroshot target serve</code></h4>
<pre><code>Serve an unauthenticated direct target.
Builds with UI support also serve the profile editor and run history at /ui/. The UI shares this listener and stores profiles under --storage.
Direct mode is unauthenticated. Bind or publish it only on trusted networks.
Usage: zeroshot target serve --listen <ADDRESS> --public-origin <ORIGIN> --storage <DIRECTORY>
Options:
--listen <ADDRESS>
IP socket address on which the target listens
--public-origin <ORIGIN>
Public HTTP(S) origin advertised to clients.
Must match the browser's origin, including the published port, when using the UI.
--storage <DIRECTORY>
Directory that stores target state, UI profiles, and run data
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-target-help"><h4><code>zeroshot target help</code></h4>
<pre><code>Print this message or the help of the given subcommand(s)
Usage: zeroshot target help [COMMAND]
Commands:
add Register a named target
login Authenticate with a hosted named target
serve Serve an unauthenticated direct target
help Print this message or the help of the given subcommand(s)</code></pre></section>
<section id="zeroshot-connection"><h3><code>zeroshot connection</code></h3>
<pre><code>Inspect and manage named runtime connections
Usage: zeroshot connection <COMMAND>
Commands:
list List connection metadata without secret values
set Create or replace one static connection
delete Delete one connection
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
CONNECTIONS
A runtime declares a connection key and the exact environment fields it needs. Zeroshot injects
only those fields; secret values never belong in runtime configuration.
`list` returns each key, scope, kind, and field names, never secret values. `set` creates or replaces
a complete static connection, so include every required field. Omit --target for local storage; use
--target NAME for hosted storage. Organization scope requires a hosted target.
Target-managed dynamic kinds are configured through the target rather than `connection set`; `list`
reports each connection's kind.
When a run reports `connection_unavailable`, list connections for the same target and scope, then
set the named key with every required field.
EXAMPLES
zeroshot connection list
zeroshot connection list --target prod --scope org
zeroshot connection set openrouter --field OPENROUTER_API_KEY
zeroshot connection set openrouter --target prod --field OPENROUTER_API_KEY</code></pre></section>
<section id="zeroshot-connection-list"><h4><code>zeroshot connection list</code></h4>
<pre><code>List connection metadata without secret values
Usage: zeroshot connection list [OPTIONS]
Options:
--target <NAME>
Use this named hosted target. If omitted, use local connections
--scope <SCOPE>
Select user- or organization-scoped connections
[default: user]
[possible values: user, org]
-h, --help
Print help</code></pre></section>
<section id="zeroshot-connection-set"><h4><code>zeroshot connection set</code></h4>
<pre><code>Create or replace one static connection
Usage: zeroshot connection set [OPTIONS] <--field <ENV>|--json-stdin> <KEY>
Arguments:
<KEY>
Unique connection key within the selected scope
Options:
--field <ENV>
Prompt without echo for this environment field. Repeat for multiple fields
--json-stdin
Read one JSON object of environment field names to secret values from standard input
--target <NAME>
Use this named hosted target. If omitted, use local connections
--scope <SCOPE>
Select user- or organization-scoped connections
[default: user]
[possible values: user, org]
-h, --help
Print help (see a summary with '-h')
INPUT
Use --field ENV to prompt without echo; repeat it for every required field. Use --json-stdin to read
one non-empty JSON object mapping field names to secret values.
`set` replaces the complete stored static connection for KEY. Existing fields not supplied are
removed. Do not put secret values in shell arguments or runtime configuration.</code></pre></section>
<section id="zeroshot-connection-delete"><h4><code>zeroshot connection delete</code></h4>
<pre><code>Delete one connection
Usage: zeroshot connection delete [OPTIONS] <KEY>
Arguments:
<KEY>
Unique connection key within the selected scope
Options:
--target <NAME>
Use this named hosted target. If omitted, use local connections
--scope <SCOPE>
Select user- or organization-scoped connections
[default: user]
[possible values: user, org]
-h, --help
Print help</code></pre></section>
<section id="zeroshot-connection-help"><h4><code>zeroshot connection help</code></h4>
<pre><code>Print this message or the help of the given subcommand(s)
Usage: zeroshot connection help [COMMAND]
Commands:
list List connection metadata without secret values
set Create or replace one static connection
delete Delete one connection
help Print this message or the help of the given subcommand(s)</code></pre></section>
<section id="zeroshot-profile"><h3><code>zeroshot profile</code></h3>
<pre><code>Manage reusable graph/runtime profiles
Usage: zeroshot profile <COMMAND>
Commands:
list List profile metadata
set Create or replace a fully materialized profile
show Show one profile with its graph and runtime
remove Remove one profile
default Set the scope's default profile, or clear it when NAME is omitted
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help</code></pre></section>
<section id="zeroshot-profile-list"><h4><code>zeroshot profile list</code></h4>
<pre><code>List profile metadata
Usage: zeroshot profile list [OPTIONS]
Options:
--target <NAME>
Use this named hosted target. If omitted, use local profiles
--scope <SCOPE>
Select user- or organization-scoped hosted profiles
[default: user]
[possible values: user, org]
-h, --help
Print help</code></pre></section>
<section id="zeroshot-profile-set"><h4><code>zeroshot profile set</code></h4>
<pre><code>Create or replace a fully materialized profile
Usage: zeroshot profile set [OPTIONS] <--graph <FILE>|--template <TEMPLATE>> <--runtime-config <FILE>|--uniform-runtime-config <FILE>> <NAME>
Arguments:
<NAME>
Options:
--graph <FILE>
--template <TEMPLATE>
Possible values:
- single-worker: A single general-purpose worker
- software-change: A review, validation, and optional delivery workflow for code changes
- auto-research: Ten bounded research iterations with independent evidence gates
--runtime-config <FILE>
--uniform-runtime-config <FILE>
--default
--delivery <MODE>
Materialize this template-owned delivery mode
--push
Commit and push the managed run branch without opening a pull request
--pr
Materialize pull-request delivery for the software-change template
--ship
Materialize merge delivery for the software-change template.
Named-target runs forward GH_TOKEN for the generated GitHub merge operation.
--no-pr-feedback
Do not route visible pull-request feedback through the autonomous repair loop
--target <NAME>
Use this named hosted target. If omitted, use local profiles
--scope <SCOPE>
Select user- or organization-scoped hosted profiles
[default: user]
[possible values: user, org]
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-profile-show"><h4><code>zeroshot profile show</code></h4>
<pre><code>Show one profile with its graph and runtime
Usage: zeroshot profile show [OPTIONS] <NAME>
Arguments:
<NAME>
Profile name
Options:
--target <NAME>
Use this named hosted target. If omitted, use local profiles
--scope <SCOPE>
Select user- or organization-scoped hosted profiles
[default: user]
[possible values: user, org]
-h, --help
Print help</code></pre></section>
<section id="zeroshot-profile-remove"><h4><code>zeroshot profile remove</code></h4>
<pre><code>Remove one profile
Usage: zeroshot profile remove [OPTIONS] <NAME>
Arguments:
<NAME>
Profile name
Options:
--target <NAME>
Use this named hosted target. If omitted, use local profiles
--scope <SCOPE>
Select user- or organization-scoped hosted profiles
[default: user]
[possible values: user, org]
-h, --help
Print help</code></pre></section>
<section id="zeroshot-profile-default"><h4><code>zeroshot profile default</code></h4>
<pre><code>Set the scope's default profile, or clear it when NAME is omitted
Usage: zeroshot profile default [OPTIONS] [NAME]
Arguments:
[NAME]
Profile name. Omit to clear the selected scope's default
Options:
--target <NAME>
Use this named hosted target. If omitted, use local profiles
--scope <SCOPE>
Select user- or organization-scoped hosted profiles
[default: user]
[possible values: user, org]
-h, --help
Print help</code></pre></section>
<section id="zeroshot-profile-help"><h4><code>zeroshot profile help</code></h4>
<pre><code>Print this message or the help of the given subcommand(s)
Usage: zeroshot profile help [COMMAND]
Commands:
list List profile metadata
set Create or replace a fully materialized profile
show Show one profile with its graph and runtime
remove Remove one profile
default Set the scope's default profile, or clear it when NAME is omitted
help Print this message or the help of the given subcommand(s)</code></pre></section>
<section id="zeroshot-template"><h3><code>zeroshot template</code></h3>
<pre><code>Inspect built-in graph templates
Usage: zeroshot template <COMMAND>
Commands:
list List built-in template names as JSON
show Write a built-in graph template as JSON
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help</code></pre></section>
<section id="zeroshot-template-list"><h4><code>zeroshot template list</code></h4>
<pre><code>List built-in template names as JSON
Usage: zeroshot template list
Options:
-h, --help
Print help</code></pre></section>
<section id="zeroshot-template-show"><h4><code>zeroshot template show</code></h4>
<pre><code>Write a built-in graph template as JSON
Usage: zeroshot template show [OPTIONS] <TEMPLATE>
Arguments:
<TEMPLATE>
Built-in graph template to render
Possible values:
- single-worker: A single general-purpose worker
- software-change: A review, validation, and optional delivery workflow for code changes
- auto-research: Ten bounded research iterations with independent evidence gates
Options:
--delivery <MODE>
Materialize this template-owned delivery mode
--push
Commit and push the managed run branch without opening a pull request
--pr
Materialize pull-request delivery for the software-change template
--ship
Materialize merge delivery for the software-change template.
Named-target runs forward GH_TOKEN for the generated GitHub merge operation.
--no-pr-feedback
Do not route visible pull-request feedback through the autonomous repair loop
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-template-help"><h4><code>zeroshot template help</code></h4>
<pre><code>Print this message or the help of the given subcommand(s)
Usage: zeroshot template help [COMMAND]
Commands:
list List built-in template names as JSON
show Write a built-in graph template as JSON
help Print this message or the help of the given subcommand(s)</code></pre></section>
<section id="zeroshot-plan"><h3><code>zeroshot plan</code></h3>
<pre><code>Validate, submit, and observe hosted merge plans
Usage: zeroshot plan <COMMAND>
Commands:
validate Validate a merge-plan manifest without contacting a target
submit Atomically submit every node in a merge-plan manifest
status Read a merge plan's aggregate status as JSON
watch Poll a merge plan and stream changed snapshots as NDJSON
force-stop Force every nonterminal run in a merge plan to stop
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
MANIFEST
The JSON manifest is strict and self-contained:
{
"schema": "zeroshot.merge-plan/v1",
"title": "Release checkout update",
"source": {"repository": "owner/repo", "branch": "main"},
"profile": "org:software-change",
"expiresAt": "<RFC3339 timestamp within 7 days>",
"runs": {
"backend": {"input": {"task": "Update the API."}},
"integrate": {"needs": ["backend"], "input": {"task": "Run release tests."}}
}
}
Every run uses the same source and profile. The profile must contain exactly one current Git merge delivery node;
pull-request delivery is rejected. Agent bindings must not declare `GH_TOKEN`; only the Git delivery
binding may declare it. `needs` gates readiness but does not pass output between runs.
Cloud assigns every run ID atomically at submission. After a node's dependencies succeed, Cloud
materializes it against an exact source revision. Once materialization completes, `readyAt` is set
and the node's queue deadline is the earlier of `expiresAt` and seven days after `readyAt`.
`expiresAt` must be in the future and no more than
seven days away. Plans cannot be edited or retried in place.</code></pre></section>
<section id="zeroshot-plan-validate"><h4><code>zeroshot plan validate</code></h4>
<pre><code>Validate a merge-plan manifest without contacting a target
Usage: zeroshot plan validate <FILE>
Arguments:
<FILE>
Merge-plan manifest JSON file
Options:
-h, --help
Print help</code></pre></section>
<section id="zeroshot-plan-submit"><h4><code>zeroshot plan submit</code></h4>
<pre><code>Atomically submit every node in a merge-plan manifest
Usage: zeroshot plan submit [OPTIONS] --target <NAME> --submission-key <KEY> <FILE>
Arguments:
<FILE>
Merge-plan manifest JSON file
Options:
--target <NAME>
Submit to this named hosted target
--submission-key <KEY>
Stable idempotency key for safely retrying the atomic submission
-d, --detach
Return after atomic submission instead of polling plan status
-h, --help
Print help</code></pre></section>
<section id="zeroshot-plan-status"><h4><code>zeroshot plan status</code></h4>
<pre><code>Read a merge plan's aggregate status as JSON
Usage: zeroshot plan status --target <NAME> <PLAN_ID>
Arguments:
<PLAN_ID>
Immutable merge-plan ID
Options:
--target <NAME>
Use this named hosted target
-h, --help
Print help</code></pre></section>
<section id="zeroshot-plan-watch"><h4><code>zeroshot plan watch</code></h4>
<pre><code>Poll a merge plan and stream changed snapshots as NDJSON
Usage: zeroshot plan watch --target <NAME> <PLAN_ID>
Arguments:
<PLAN_ID>
Immutable merge-plan ID
Options:
--target <NAME>
Use this named hosted target
-h, --help
Print help</code></pre></section>
<section id="zeroshot-plan-force-stop"><h4><code>zeroshot plan force-stop</code></h4>
<pre><code>Force every nonterminal run in a merge plan to stop
Usage: zeroshot plan force-stop --target <NAME> <PLAN_ID>
Arguments:
<PLAN_ID>
Immutable merge-plan ID
Options:
--target <NAME>
Use this named hosted target
-h, --help
Print help</code></pre></section>
<section id="zeroshot-plan-help"><h4><code>zeroshot plan help</code></h4>
<pre><code>Print this message or the help of the given subcommand(s)
Usage: zeroshot plan help [COMMAND]
Commands:
validate Validate a merge-plan manifest without contacting a target
submit Atomically submit every node in a merge-plan manifest
status Read a merge plan's aggregate status as JSON
watch Poll a merge plan and stream changed snapshots as NDJSON
force-stop Force every nonterminal run in a merge plan to stop
help Print this message or the help of the given subcommand(s)</code></pre></section>
<section id="zeroshot-run"><h3><code>zeroshot run</code></h3>
<pre><code>Submit a graph run locally or to a named target.
When --target is omitted, the run uses the current local repository. A foreground run follows NDJSON events until completion. --detach returns after submission. Ctrl-C before the submission attempt begins cancels the command; once it begins, Ctrl-C waits for the receipt and then detaches. During observation, Ctrl-C detaches without stopping the run. Named-target runs send GH_TOKEN, when set, for source checkout and Git delivery; providers receive it only when the runtime declares GH_TOKEN.
Usage: zeroshot run [OPTIONS] --title <TITLE> --input <FILE>
Options:
--title <TITLE>
Human-readable title recorded with the run
--graph <FILE>
Load a custom graph specification from this JSON file
--template <TEMPLATE>
Materialize and run this built-in graph template
Possible values:
- single-worker: A single general-purpose worker
- software-change: A review, validation, and optional delivery workflow for code changes
- auto-research: Ten bounded research iterations with independent evidence gates
--input <FILE>
Load the graph's initial input from this JSON file
--runtime-config <FILE>
Load an exact secret-free runtime plan from this JSON file
--uniform-runtime-config <FILE>
Expand one secret-free agent runtime across every executable graph node
--environment <FILE>
Load a JSON environment definition: setup, startup, public variables, and hook connections
--no-environment
Send an empty environment ({}) to bypass the target's configured default
--profile <[SCOPE:]NAME>
Use a profile: NAME, local:NAME, user:NAME, or org:NAME.
When no profile or inline graph/runtime is supplied, scoped defaults are checked.
--target <NAME>
Run on this named target; if omitted, run locally. Named targets receive GH_TOKEN when set.
The token is used for source checkout and Git delivery. A provider receives it only when the runtime configuration explicitly declares GH_TOKEN.
--repository <OWNER/NAME>
GitHub repository in owner/name form. Requires --target
--branch <BRANCH>
Source branch to resolve for the named run. Requires --target
--revision <SHA>
Exact source commit SHA. Requires --target
--submission-key <KEY>
Stable idempotency key for safely retrying submission
-d, --detach
Return after submission instead of following NDJSON run events
--validate-only
Validate and materialize the run without submitting it or running preparation scripts.
Remote profiles still require target access. This does not check dependency installation or connection availability.
--delivery <MODE>
Materialize this template-owned delivery mode
--push
Commit and push the managed run branch without opening a pull request
--pr
Materialize pull-request delivery for the software-change template
--ship
Materialize merge delivery for the software-change template.
Named-target runs forward GH_TOKEN for the generated GitHub merge operation.
--no-pr-feedback
Do not route visible pull-request feedback through the autonomous repair loop
-h, --help
Print help (see a summary with '-h')
RUNTIME CONFIGURATION
The file is secret-free JSON. For example:
{
"harness": "codex",
"provider": "openrouter",
"size": "medium",
"nodes": {
"worker": {
"kind": "agent",
"model": "provider-model-id",
"connections": {"openrouter": ["OPENROUTER_API_KEY"]}
}
}
}
Provider choices are codex/openai, codex/openrouter, codex/bedrock, claude/anthropic,
claude/openrouter, claude/bedrock, codex/gateway, claude/gateway, and copilot/github. Gateway connections
require GATEWAY_BASE_URL and GATEWAY_API_KEY; Codex uses Responses and Claude uses Messages.
Known-incompatible harness/provider pairs include
codex/anthropic and claude/openai. Local Copilot reuses its native user login; contained
Copilot uses a user-backed GitHub connection with COPILOT_GITHUB_TOKEN. Model IDs are passed
unchanged to the selected harness and
provider; Zeroshot does not maintain or validate provider model catalogs.
Sizes are small, medium, and large.
Every executable graph node needs a same-named binding. Agent bindings require kind and model.
Optional fields are effort (low, medium, high, xhigh, or max when supported), sessionScope
(execution or node_instance), and connections. Each connection key maps to the exact
environment variable names required by that node; never put values in this file.
Use `zeroshot template show TEMPLATE` to inspect node names. With --push, --pr, or --ship, omit the
template-owned delivery binding.
--uniform-runtime-config requires harness, provider, and model. It accepts optional size,
effort, sessionScope, and connections fields without nodes. Zeroshot expands that agent binding
across every executable graph node and supplies graph-visible Git delivery bindings itself.
Omitted connections reuse native local login for codex/openai, claude/anthropic, and
copilot/github; other local lanes and contained targets derive their canonical connection
requirements.
ENVIRONMENT PREPARATION
For Docker or Cloud targets, pass --environment environment.json with a separate, flat JSON
definition (not a profile field or an "environment" wrapper):
{
"setup": "apt-get update && apt-get install -y jq",
"startup": "npm ci",
"variables": {"CI": "true"}
}
Setup runs as root before checkout or workspace restore. Startup runs as the non-root
workspace owner in the checkout before any agent starts. Workers and reviewers share the
prepared workspace. Both hooks rerun on resume; startup must tolerate existing files.
Install OS packages in setup, project dependencies in startup, and shared executable tools
under $ZEROSHOT_TOOLS/bin (already on every hook and agent's PATH). Shell exports last only
for that hook; use variables for public values shared with agents. Scripts and variables
are public. If hooks need secrets, add e.g. "connections": {"package-registry": ["NPM_TOKEN"]}.
Hook connections are separate from node connections.
Hook failures stop the run before agents start and use no graph retry attempts.
Inspect `zeroshot logs RUN_ID --target NAME` for preparation output.
Omit both flags to allow host defaults; direct Docker defaults to the base environment.
--no-environment sends {} to bypass host defaults. Local runs use the invoking machine and
reject hooks and hook connections.
Installation, services, limits, and recovery:
https://the-open-engine.github.io/zeroshot/current/guides/runtime-environments/</code></pre></section>
<section id="zeroshot-update"><h3><code>zeroshot update</code></h3>
<pre><code>Update this executable and managed agent skill to the newest canonical release.
Downloads the declared archive and agent skill from the latest GitHub Release, verifies their SHA256SUMS entries and the executable version, then replaces this executable and any unchanged Zeroshot-managed skill copies. User-edited skills are preserved and reported as conflicts. The executable's directory must be writable; Zeroshot does not elevate privileges.
Usage: zeroshot update
Options:
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-list"><h3><code>zeroshot list</code></h3>
<pre><code>List runs as JSON
Usage: zeroshot list [OPTIONS]
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
-h, --help
Print help</code></pre></section>
<section id="zeroshot-status"><h3><code>zeroshot status</code></h3>
<pre><code>Read a run's current status as JSON
Usage: zeroshot status [OPTIONS] <RUN_ID>
Arguments:
<RUN_ID>
Public run ID
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
-h, --help
Print help</code></pre></section>
<section id="zeroshot-watch"><h3><code>zeroshot watch</code></h3>
<pre><code>Follow a run's durable event stream as NDJSON
Usage: zeroshot watch [OPTIONS] <RUN_ID>
Arguments:
<RUN_ID>
Public run ID
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
--after <CURSOR>
Resume strictly after this durable cursor
-h, --help
Print help</code></pre></section>
<section id="zeroshot-logs"><h3><code>zeroshot logs</code></h3>
<pre><code>Follow a run's log stream as NDJSON
Usage: zeroshot logs [OPTIONS] <RUN_ID>
Arguments:
<RUN_ID>
Public run ID
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
--after <CURSOR>
Resume strictly after this durable cursor
--execution <EXECUTION_REF>
Return records only for this opaque execution selector
-h, --help
Print help</code></pre></section>
<section id="zeroshot-attach"><h3><code>zeroshot attach</code></h3>
<pre><code>Attach to an execution's interactive event stream as NDJSON
Usage: zeroshot attach [OPTIONS] <RUN_ID> <EXECUTION_REF>
Arguments:
<RUN_ID>
Public run ID
<EXECUTION_REF>
Execution reference emitted by the run
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
-h, --help
Print help</code></pre></section>
<section id="zeroshot-force-stop"><h3><code>zeroshot force-stop</code></h3>
<pre><code>Force a run to stop and write the result as JSON
Usage: zeroshot force-stop [OPTIONS] <RUN_ID>
Arguments:
<RUN_ID>
Public run ID
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
-h, --help
Print help</code></pre></section>
<section id="zeroshot-resume"><h3><code>zeroshot resume</code></h3>
<pre><code>Start a new attempt from a failed run's retained workspace or a saved checkpoint.
By default, restart the original graph using its latest retained workspace. Use --from-checkpoint to continue from a checkpoint listed by `zeroshot checkpoints`. The successor resolves credentials again. Export GH_TOKEN before resuming a named-target run that needs it for private source checkout or Git delivery.
Target runs reuse the saved environment definition: setup runs before workspace restore, then startup runs before the graph. Startup must tolerate existing workspace files. Services, Docker state, and agent conversations are not restored.
Usage: zeroshot resume [OPTIONS] <RUN_ID>
Arguments:
<RUN_ID>
Public run ID
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
--from-checkpoint <ID>
Restore this checkpoint and continue from its saved graph boundary
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-checkpoints"><h3><code>zeroshot checkpoints</code></h3>
<pre><code>List one page of a run's saved workspace checkpoints as JSON.
Each entry restores the workspace and graph state before its named node or outer parallel/map group. Select its checkpointId with `zeroshot resume RUN_ID --from-checkpoint ID`. When nextAfter is present, pass it as --after to fetch the next page.
Usage: zeroshot checkpoints [OPTIONS] <RUN_ID>
Arguments:
<RUN_ID>
Public run ID
Options:
--target <NAME>
Use this named target. If omitted, use the local controller
--after <ID>
List checkpoints strictly after this checkpoint ID
--limit <COUNT>
Maximum checkpoints to return, from 1 to 100. Defaults to 50
-h, --help
Print help (see a summary with '-h')</code></pre></section>
<section id="zeroshot-discard-workspace"><h3><code>zeroshot discard-workspace</code></h3>