atomwrite 0.1.38

Atomic file operations CLI for LLM agents — read, write, edit, search, replace with NDJSON output
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchOutput",
  "description": "Records of `atomwrite batch`: one result per operation, progress, the rollback event and the terminal summary; `--input-schema` answers with the manifest schema instead.",
  "type": "object",
  "anyOf": [
    {
      "title": "BatchOpResult",
      "description": "NDJSON output for a single operation within a batch run.",
      "type": "object",
      "properties": {
        "type": {
          "description": "Event type discriminator.",
          "type": "string"
        },
        "index": {
          "description": "Zero-based index of this operation in the manifest.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "op": {
          "description": "Operation name (e.g. \"write\", \"delete\", \"replace\").",
          "type": "string"
        },
        "status": {
          "description": "Outcome: \"ok\" or \"error\".",
          "type": "string"
        },
        "details": {
          "description": "Additional details about the result.",
          "type": [
            "string",
            "null"
          ]
        },
        "error": {
          "description": "Error message if the operation failed.",
          "type": [
            "string",
            "null"
          ]
        },
        "write_strategy": {
          "description": "Write strategy the operation used, absent when it wrote no content.\n\nThe value is `'static` so the parallel fan-out can carry it across\nthreads without borrowing the manifest entry.",
          "type": "string"
        },
        "backup_skipped": {
          "description": "Why a requested backup was skipped, when the directory refused it.",
          "type": "string"
        },
        "backup_path": {
          "description": "Copy this operation created, or the snapshot the transaction already held.",
          "type": "string"
        },
        "warnings": {
          "description": "Advice the operation publishes because a flag changed nothing.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "elapsed_ms": {
          "description": "Operation duration in milliseconds.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        }
      },
      "required": [
        "type",
        "index",
        "op",
        "status",
        "elapsed_ms"
      ]
    },
    {
      "title": "ProgressEvent",
      "description": "Periodic progress heartbeat for long batch/replace jobs (v0.1.29 P1-3).",
      "type": "object",
      "properties": {
        "type": {
          "description": "Event type discriminator (`\"progress\"`).",
          "type": "string"
        },
        "done": {
          "description": "Items completed so far.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "total": {
          "description": "Total items known (0 if unknown).",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "rate_per_s": {
          "description": "Throughput estimate (items per second).",
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "eta_ms": {
          "description": "Estimated remaining milliseconds.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "phase": {
          "description": "Phase label (e.g. `replace`, `batch`).",
          "type": "string"
        }
      },
      "required": [
        "type",
        "done",
        "total",
        "phase"
      ]
    },
    {
      "title": "RollbackEvent",
      "description": "NDJSON event emitted when a transaction is rolled back.",
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "files_restored": {
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "files_removed": {
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "total_reverted": {
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "failed_paths": {
          "description": "Files the reversal could not put back, in reverse commit order.\n\nOmitted when every file came back, so an empty list never reads as a\nsuccess the run cannot vouch for.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "backups_preserved": {
          "description": "Snapshots the failed reversal left on disk, as absolute paths.\n\nA reversal that stops halfway cannot vouch for the tree, so the copies\nstay and this list names them. Omitted when nothing was preserved,\nbecause a successful reversal removes every snapshot it no longer needs.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ok": {
          "description": "Outcome of the run, stamped by the writer",
          "type": "boolean"
        },
        "code": {
          "description": "Machine error code, present when ok is false",
          "type": "string"
        },
        "exit": {
          "description": "Process exit status, present when ok is false",
          "type": "integer",
          "minimum": 0
        },
        "target_resolved": {
          "description": "Absolute targets the run resolved, in invocation order, and never a joined string, so a path holding `,` stays readable; a run with one target publishes a one-item array, so the shape never depends on the count",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "target_source": {
          "description": "Where the target came from: named in the invocation line, inherited from the workspace slot, or the standard-input stream",
          "type": "string",
          "enum": [
            "argv",
            "workspace",
            "stdin"
          ]
        },
        "workspace_source": {
          "description": "Where the workspace root came from: the `--workspace` flag or the process working directory",
          "type": "string",
          "enum": [
            "argv",
            "cwd"
          ]
        },
        "records_suppressed": {
          "description": "Records the writer dropped before the terminal event: `--filter` rejections, `--select` projections that emptied the record, dedupe duplicates and `--limit` cuts. It counts records, never files, so it does not compare with `files_matched`: one file can contribute several records",
          "type": "integer",
          "minimum": 0
        },
        "files_budget_dropped": {
          "description": "Entries the `--limit` budget dropped, in the unit the verb produces: files for walking verbs, records for streaming ones; a floor, because workers may stop before producing the rest",
          "type": "integer",
          "minimum": 0
        },
        "files_planned": {
          "description": "Files the run would have modified in `--dry-run` or `--preview`; absent from a run that really wrote",
          "type": "integer",
          "minimum": 0
        },
        "truncated": {
          "description": "The record itself was cut by `--truncate-content` or `--max-output-bytes`, so the fields are shorter than the source",
          "type": "boolean"
        },
        "truncated_records": {
          "description": "Records the writer cut this run, counted once per record",
          "type": "integer",
          "minimum": 0
        },
        "line_end": {
          "description": "1-based last line of that block, when the block spans more than a line.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint",
          "minimum": 0
        },
        "line": {
          "description": "1-based line of the block that holds the syntax error (v0.1.38).\n\nPresent only for [`AtomwriteError::SyntaxError`]. Without it the caller\nhad to re-read the file to learn where the refusal points.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint",
          "minimum": 0
        },
        "pairs_applied": {
          "description": "Pairs that were written to the target before the error (v0.1.37).\n\nAlways `0` for the all-or-nothing `EditPairFailed` abort (nothing is\nwritten) and `total - unmatched` for `edit-loop --partial`.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "message": {
          "description": "Human-readable error message.",
          "type": "string"
        },
        "path": {
          "description": "Filesystem path related to the error, if applicable.",
          "type": [
            "string",
            "null"
          ]
        },
        "error_class": {
          "description": "Error class: transient, conflict, `precondition_failed`, or permanent.",
          "type": "string"
        },
        "retryable": {
          "description": "Whether a retry may resolve this error.",
          "type": "boolean"
        },
        "suggestion": {
          "description": "Optional actionable suggestion for the caller.",
          "type": [
            "string",
            "null"
          ]
        },
        "suggestion_lang": {
          "description": "Language of `suggestion` when it is not English, so a consumer knows\nwhat it is reading.",
          "type": [
            "string",
            "null"
          ]
        },
        "workspace": {
          "description": "Workspace root used for jail validation, if applicable.",
          "type": [
            "string",
            "null"
          ]
        },
        "failed_pair_index": {
          "description": "1-based index of the failed `--old`/`--new` pair (multi-pair edit, G117).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "pairs_total": {
          "description": "Total number of `--old`/`--new` pairs in the invocation.\n\nEmitted by multi-pair edit (G117) and by a partial `edit-loop` run\n(v0.1.36) — one key, two producers.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "pair_results": {
          "description": "Per-pair diagnostics up to and including the failed pair (multi-pair edit, G117).\nPairs after the failure were never attempted and are absent.",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/PairResult"
          }
        },
        "best_candidate": {
          "description": "Closest near-miss when a match cascade fails (v0.1.29 P0-2).",
          "anyOf": [
            {
              "$ref": "#/$defs/BestCandidate"
            },
            {
              "type": "null"
            }
          ]
        },
        "candidates": {
          "description": "Additional near-miss candidates for `did_you_mean` (v0.1.30).",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/BestCandidate"
          }
        },
        "match_count": {
          "description": "Match count when ambiguity is reported (v0.1.30).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "similar_paths": {
          "description": "Similar basenames when path is missing (v0.1.30).",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "conflict_count": {
          "description": "Number of conflicting regions a three-way merge could not align (v0.1.36).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "missing_flag": {
          "description": "Flag literal the operation required but did not receive (v0.1.36).\n\nPresent only for [`AtomwriteError::MissingFlag`]; the duplicate `code`\non that variant is deliberate — callers branch on `missing_flag` and\nstill see the `INVALID_INPUT` family in `code`.",
          "type": [
            "string",
            "null"
          ]
        },
        "pairs_unmatched": {
          "description": "Pairs that did not match in a partial `edit-loop` run (v0.1.36).\n\n`pairs_total` already exists above for the multi-pair edit family and\nis reused by this variant instead of being duplicated.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        }
      },
      "required": [
        "type",
        "files_restored",
        "files_removed",
        "total_reverted"
      ]
    },
    {
      "title": "BatchSummary",
      "description": "Aggregate summary emitted at the end of a batch run.",
      "type": "object",
      "properties": {
        "type": {
          "description": "Event type discriminator.",
          "type": "string"
        },
        "operations": {
          "description": "Total operations in the manifest.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "succeeded": {
          "description": "Number of operations that succeeded.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "failed": {
          "description": "Number of operations that failed.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "dry_run": {
          "description": "Whether this was a dry-run execution.",
          "type": "boolean"
        },
        "elapsed_ms": {
          "description": "Total batch duration in milliseconds.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "transaction": {
          "description": "Whether transaction mode was active.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "committed": {
          "description": "Whether the transaction was committed (all operations succeeded).",
          "type": [
            "boolean",
            "null"
          ]
        },
        "backups_preserved": {
          "description": "Snapshots the commit kept because they are the only way back.\n\nA deletion or an overwritten destination has no other copy, so the\nsummary names them instead of leaving the caller to list the directory.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ok": {
          "description": "Outcome of the run, stamped by the writer",
          "type": "boolean"
        },
        "code": {
          "description": "Machine error code, present when ok is false",
          "type": "string"
        },
        "exit": {
          "description": "Process exit status, present when ok is false",
          "type": "integer",
          "minimum": 0
        },
        "target_resolved": {
          "description": "Absolute targets the run resolved, in invocation order, and never a joined string, so a path holding `,` stays readable; a run with one target publishes a one-item array, so the shape never depends on the count",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "target_source": {
          "description": "Where the target came from: named in the invocation line, inherited from the workspace slot, or the standard-input stream",
          "type": "string",
          "enum": [
            "argv",
            "workspace",
            "stdin"
          ]
        },
        "workspace_source": {
          "description": "Where the workspace root came from: the `--workspace` flag or the process working directory",
          "type": "string",
          "enum": [
            "argv",
            "cwd"
          ]
        },
        "records_suppressed": {
          "description": "Records the writer dropped before the terminal event: `--filter` rejections, `--select` projections that emptied the record, dedupe duplicates and `--limit` cuts. It counts records, never files, so it does not compare with `files_matched`: one file can contribute several records",
          "type": "integer",
          "minimum": 0
        },
        "files_budget_dropped": {
          "description": "Entries the `--limit` budget dropped, in the unit the verb produces: files for walking verbs, records for streaming ones; a floor, because workers may stop before producing the rest",
          "type": "integer",
          "minimum": 0
        },
        "files_planned": {
          "description": "Files the run would have modified in `--dry-run` or `--preview`; absent from a run that really wrote",
          "type": "integer",
          "minimum": 0
        },
        "truncated": {
          "description": "The record itself was cut by `--truncate-content` or `--max-output-bytes`, so the fields are shorter than the source",
          "type": "boolean"
        },
        "truncated_records": {
          "description": "Records the writer cut this run, counted once per record",
          "type": "integer",
          "minimum": 0
        },
        "line_end": {
          "description": "1-based last line of that block, when the block spans more than a line.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint",
          "minimum": 0
        },
        "line": {
          "description": "1-based line of the block that holds the syntax error (v0.1.38).\n\nPresent only for [`AtomwriteError::SyntaxError`]. Without it the caller\nhad to re-read the file to learn where the refusal points.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint",
          "minimum": 0
        },
        "pairs_applied": {
          "description": "Pairs that were written to the target before the error (v0.1.37).\n\nAlways `0` for the all-or-nothing `EditPairFailed` abort (nothing is\nwritten) and `total - unmatched` for `edit-loop --partial`.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "message": {
          "description": "Human-readable error message.",
          "type": "string"
        },
        "path": {
          "description": "Filesystem path related to the error, if applicable.",
          "type": [
            "string",
            "null"
          ]
        },
        "error_class": {
          "description": "Error class: transient, conflict, `precondition_failed`, or permanent.",
          "type": "string"
        },
        "retryable": {
          "description": "Whether a retry may resolve this error.",
          "type": "boolean"
        },
        "suggestion": {
          "description": "Optional actionable suggestion for the caller.",
          "type": [
            "string",
            "null"
          ]
        },
        "suggestion_lang": {
          "description": "Language of `suggestion` when it is not English, so a consumer knows\nwhat it is reading.",
          "type": [
            "string",
            "null"
          ]
        },
        "workspace": {
          "description": "Workspace root used for jail validation, if applicable.",
          "type": [
            "string",
            "null"
          ]
        },
        "failed_pair_index": {
          "description": "1-based index of the failed `--old`/`--new` pair (multi-pair edit, G117).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "pairs_total": {
          "description": "Total number of `--old`/`--new` pairs in the invocation.\n\nEmitted by multi-pair edit (G117) and by a partial `edit-loop` run\n(v0.1.36) — one key, two producers.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "pair_results": {
          "description": "Per-pair diagnostics up to and including the failed pair (multi-pair edit, G117).\nPairs after the failure were never attempted and are absent.",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/PairResult"
          }
        },
        "best_candidate": {
          "description": "Closest near-miss when a match cascade fails (v0.1.29 P0-2).",
          "anyOf": [
            {
              "$ref": "#/$defs/BestCandidate"
            },
            {
              "type": "null"
            }
          ]
        },
        "candidates": {
          "description": "Additional near-miss candidates for `did_you_mean` (v0.1.30).",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/BestCandidate"
          }
        },
        "match_count": {
          "description": "Match count when ambiguity is reported (v0.1.30).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "similar_paths": {
          "description": "Similar basenames when path is missing (v0.1.30).",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "conflict_count": {
          "description": "Number of conflicting regions a three-way merge could not align (v0.1.36).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "missing_flag": {
          "description": "Flag literal the operation required but did not receive (v0.1.36).\n\nPresent only for [`AtomwriteError::MissingFlag`]; the duplicate `code`\non that variant is deliberate — callers branch on `missing_flag` and\nstill see the `INVALID_INPUT` family in `code`.",
          "type": [
            "string",
            "null"
          ]
        },
        "pairs_unmatched": {
          "description": "Pairs that did not match in a partial `edit-loop` run (v0.1.36).\n\n`pairs_total` already exists above for the multi-pair edit family and\nis reused by this variant instead of being duplicated.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        }
      },
      "required": [
        "type",
        "operations",
        "succeeded",
        "failed",
        "dry_run",
        "elapsed_ms",
        "ok"
      ],
      "additionalProperties": false,
      "then": {
        "required": [
          "code",
          "exit"
        ]
      },
      "if": {
        "properties": {
          "ok": {
            "const": false
          }
        },
        "required": [
          "ok"
        ]
      }
    },
    {
      "description": "The JSON Schema document `batch --input-schema` prints instead of a stream.",
      "type": "object",
      "properties": {
        "$schema": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "properties": {
          "type": "object"
        },
        "required": {
          "type": "array"
        },
        "additionalProperties": {
          "type": "boolean"
        }
      },
      "required": [
        "$schema",
        "title",
        "properties"
      ]
    },
    {
      "title": "ErrorJson",
      "description": "Serializable error envelope emitted as a single NDJSON line.",
      "type": "object",
      "properties": {
        "ok": {
          "description": "Always false on error envelopes (GAP-2026-020 agent sentinel).\n\n`ok: false` together with `code` is the whole verdict: the redundant\n`error: true` duplicate left the envelope because every failure paid\nfor it and no caller branched on it alone.",
          "type": "boolean"
        },
        "code": {
          "description": "Machine-readable error code string.",
          "type": "string"
        },
        "exit": {
          "description": "Process exit status this failure maps to.",
          "type": "integer",
          "format": "uint8",
          "minimum": 0,
          "maximum": 255
        },
        "message": {
          "description": "Human-readable error message.",
          "type": "string"
        },
        "path": {
          "description": "Filesystem path related to the error, if applicable.",
          "type": [
            "string",
            "null"
          ]
        },
        "error_class": {
          "description": "Error class: transient, conflict, `precondition_failed`, or permanent.",
          "type": "string"
        },
        "retryable": {
          "description": "Whether a retry may resolve this error.",
          "type": "boolean"
        },
        "suggestion": {
          "description": "Optional actionable suggestion for the caller.",
          "type": [
            "string",
            "null"
          ]
        },
        "suggestion_lang": {
          "description": "Language of `suggestion` when it is not English, so a consumer knows\nwhat it is reading.",
          "type": [
            "string",
            "null"
          ]
        },
        "workspace": {
          "description": "Workspace root used for jail validation, if applicable.",
          "type": [
            "string",
            "null"
          ]
        },
        "failed_pair_index": {
          "description": "1-based index of the failed `--old`/`--new` pair (multi-pair edit, G117).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "pairs_total": {
          "description": "Total number of `--old`/`--new` pairs in the invocation.\n\nEmitted by multi-pair edit (G117) and by a partial `edit-loop` run\n(v0.1.36) — one key, two producers.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "pair_results": {
          "description": "Per-pair diagnostics up to and including the failed pair (multi-pair edit, G117).\nPairs after the failure were never attempted and are absent.",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/PairResult"
          }
        },
        "best_candidate": {
          "description": "Closest near-miss when a match cascade fails (v0.1.29 P0-2).",
          "anyOf": [
            {
              "$ref": "#/$defs/BestCandidate"
            },
            {
              "type": "null"
            }
          ]
        },
        "candidates": {
          "description": "Additional near-miss candidates for `did_you_mean` (v0.1.30).",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/BestCandidate"
          }
        },
        "match_count": {
          "description": "Match count when ambiguity is reported (v0.1.30).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "similar_paths": {
          "description": "Similar basenames when path is missing (v0.1.30).",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "conflict_count": {
          "description": "Number of conflicting regions a three-way merge could not align (v0.1.36).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "missing_flag": {
          "description": "Flag literal the operation required but did not receive (v0.1.36).\n\nPresent only for [`AtomwriteError::MissingFlag`]; the duplicate `code`\non that variant is deliberate — callers branch on `missing_flag` and\nstill see the `INVALID_INPUT` family in `code`.",
          "type": [
            "string",
            "null"
          ]
        },
        "pairs_unmatched": {
          "description": "Pairs that did not match in a partial `edit-loop` run (v0.1.36).\n\n`pairs_total` already exists above for the multi-pair edit family and\nis reused by this variant instead of being duplicated.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "pairs_applied": {
          "description": "Pairs that were written to the target before the error (v0.1.37).\n\nAlways `0` for the all-or-nothing `EditPairFailed` abort (nothing is\nwritten) and `total - unmatched` for `edit-loop --partial`.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "line": {
          "description": "1-based line of the block that holds the syntax error (v0.1.38).\n\nPresent only for [`AtomwriteError::SyntaxError`]. Without it the caller\nhad to re-read the file to learn where the refusal points.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint",
          "minimum": 0
        },
        "line_end": {
          "description": "1-based last line of that block, when the block spans more than a line.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint",
          "minimum": 0
        },
        "target_resolved": {
          "description": "Absolute targets the run resolved, in invocation order, and never a joined string, so a path holding `,` stays readable; a run with one target publishes a one-item array, so the shape never depends on the count",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "target_source": {
          "description": "Where the target came from: named in the invocation line, inherited from the workspace slot, or the standard-input stream",
          "type": "string",
          "enum": [
            "argv",
            "workspace",
            "stdin"
          ]
        },
        "workspace_source": {
          "description": "Where the workspace root came from: the `--workspace` flag or the process working directory",
          "type": "string",
          "enum": [
            "argv",
            "cwd"
          ]
        },
        "records_suppressed": {
          "description": "Records the writer dropped before the terminal event: `--filter` rejections, `--select` projections that emptied the record, dedupe duplicates and `--limit` cuts. It counts records, never files, so it does not compare with `files_matched`: one file can contribute several records",
          "type": "integer",
          "minimum": 0
        },
        "files_budget_dropped": {
          "description": "Entries the `--limit` budget dropped, in the unit the verb produces: files for walking verbs, records for streaming ones; a floor, because workers may stop before producing the rest",
          "type": "integer",
          "minimum": 0
        },
        "files_planned": {
          "description": "Files the run would have modified in `--dry-run` or `--preview`; absent from a run that really wrote",
          "type": "integer",
          "minimum": 0
        },
        "truncated": {
          "description": "The record itself was cut by `--truncate-content` or `--max-output-bytes`, so the fields are shorter than the source",
          "type": "boolean"
        },
        "truncated_records": {
          "description": "Records the writer cut this run, counted once per record",
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "ok",
        "code",
        "exit"
      ]
    }
  ],
  "$defs": {
    "PairResult": {
      "description": "Outcome of matching a single `--old`/`--new` pair in multi-pair edit mode.\n\nEmitted in `pair_results` on both success and error envelopes so agents\ncan verify each pair objectively without re-running the edit (G117).\nIn the default all-or-nothing mode, pairs after the first failure are\nnever attempted and are absent from the array.",
      "type": "object",
      "properties": {
        "index": {
          "description": "1-based position of the pair in the `--old`/`--new` invocation order.",
          "type": "integer",
          "format": "uint64",
          "minimum": 0
        },
        "matched": {
          "description": "Whether the pair matched and was applied to the content.",
          "type": "boolean"
        },
        "strategy": {
          "description": "Matching strategy that succeeded (e.g. `exact`, `whitespace_normalized`).",
          "type": [
            "string",
            "null"
          ]
        },
        "similarity": {
          "description": "Similarity score of the fuzzy match, 0.0-1.0 (block-anchor and context-aware only).",
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "source": {
          "description": "Source of the match/replacement content: `\"arg\"` or `\"file\"`.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "index",
        "matched"
      ]
    },
    "BestCandidate": {
      "description": "Closest near-miss when a fuzzy/exact match fails (v0.1.29 P0-2).\n\nAgents use this to correct `old` without re-reading the full file.",
      "type": "object",
      "properties": {
        "text": {
          "description": "Snippet of the best matching region (truncated to 500 chars).",
          "type": [
            "string",
            "null"
          ]
        },
        "line": {
          "description": "1-based line of the candidate start in the file.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "column": {
          "description": "1-based column of the candidate start.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint64",
          "minimum": 0
        },
        "similarity": {
          "description": "Similarity score 0.0–1.0 of the best attempt.",
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "strategy": {
          "description": "Strategy that produced this candidate score.",
          "type": [
            "string",
            "null"
          ]
        },
        "diff_preview": {
          "description": "Optional short unified-diff style preview.",
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}