rom-weaver 0.20.1 → 0.21.0

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.
@@ -0,0 +1,332 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-weave-create 1 "rom-weaver-weave-create "
4
+ .SH NAME
5
+ rom\-weaver\-weave\-create \- Write a rom\-weaver\-weave.json recipe from local ROM and patch files
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver weave create\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-assume\-in\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-rom\-url\fR] [\fB\-\-progress\fR] [\fB\-\-rom\-name\fR] [\fB\-\-no\-progress\fR] [\fB\-\-rom\-member\fR] [\fB\-\-log\-level\fR] [\fB\-\-patch\fR] [\fB\-\-patch\-id\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-patch\-version\fR] [\fB\-\-patch\-name\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\-description\fR] [\fB\-\-color\fR] [\fB\-\-patch\-author\fR] [\fB\-\-no\-color\fR] [\fB\-\-patch\-label\fR] [\fB\-\-patch\-optional\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-patch\-source\-url\fR] [\fB\-\-patch\-header\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-default\-patch\-basis\fR] [\fB\-\-patch\-expect\-in\fR] [\fB\-\-patch\-expect\-out\fR] [\fB\-\-expect\-out\fR] [\fB\-\-output\-name\fR] [\fB\-\-output\-header\fR] [\fB\-\-cheat\fR] [\fB\-\-cheat\-database\fR] [\fB\-\-cheat\-system\fR] [\fB\-\-game\fR] [\fB\-\-allow\-cheat\-conflicts\fR] [\fB\-\-weave\fR] [\fB\-\-weave\-rom\fR] [\fB\-\-no\-weave\-rom\fR] [\fB\-\-checksum\fR] [\fB\-\-from\fR] [\fB\-\-schema\-ref\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-o\fR|\fB\-\-output\fR>
8
+ .SH DESCRIPTION
9
+ Write a rom\-weaver\-weave.json recipe from local ROM and patch files.
10
+ .PP
11
+ A weave records which ROM the patches are for, what order they run in, and
12
+ what the result should hash to. Hand it to someone else and
13
+ `rom\-weaver patch apply \-\-weave` reproduces your exact result.
14
+ .PP
15
+ Checksums come from the real files, so nothing here is taken on faith. Every
16
+ \-\-patch\-* flag describes the \-\-patch before it.
17
+ .PP
18
+ \-\-output names the recipe itself; add .gz or .zst to compress it. \-\-weave
19
+ additionally packs the recipe and its files into one shareable archive.
20
+ .SH OPTIONS
21
+ .TP
22
+ \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
23
+ ROM the patches apply to. Its checksums and size are read from the file and recorded in the weave
24
+ .TP
25
+ \fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
26
+ Take the ROM\*(Aqs checksum and size on trust rather than reading it, as in crc32=1234abcd,size=1048576 (repeatable, comma\-separable)
27
+ .TP
28
+ \fB\-\-rom\-url\fR \fI<ROM_URL>\fR
29
+ Where the ROM can be downloaded from. With \-\-input, the local file still supplies the checksums; on its own, the weave records only this url
30
+ .TP
31
+ \fB\-\-rom\-name\fR \fI<ROM_NAME>\fR
32
+ Expected source ROM file name to show and use for output naming; a mismatch is advisory
33
+ .TP
34
+ \fB\-\-rom\-member\fR \fI<ROM_MEMBER>\fR
35
+ Use this exact archive member or disc track as the weave ROM target
36
+ .TP
37
+ \fB\-\-patch\fR \fI<PATCH>\fR
38
+ Patch to list in the weave. Repeat once per patch, in the order they should be
39
+ applied.
40
+
41
+ Every \-\-patch\-* flag describes the \-\-patch before it, so metadata for several
42
+ patches reads left to right:
43
+
44
+ \-\-patch tl.bps \-\-patch\-name \*(AqTranslation\*(Aq \-\-patch\-author \*(AqTeam A\*(Aq \\
45
+ \-\-patch fix.ips \-\-patch\-name \*(AqBugfixes\*(Aq \-\-patch\-optional true
46
+ .TP
47
+ \fB\-\-patch\-id\fR \fI<PATCH_ID>\fR
48
+ Identifier for the preceding \-\-patch that stays the same across releases, so a replacement keeps its settings
49
+
50
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
51
+
52
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
53
+ .TP
54
+ \fB\-\-patch\-version\fR \fI<PATCH_VERSION>\fR
55
+ Version of the preceding \-\-patch, in whatever form its author uses
56
+
57
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
58
+
59
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
60
+ .TP
61
+ \fB\-\-patch\-name\fR \fI<PATCH_NAME>\fR
62
+ Name to show for the preceding \-\-patch
63
+
64
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
65
+
66
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
67
+ .TP
68
+ \fB\-\-patch\-description\fR \fI<PATCH_DESCRIPTION>\fR
69
+ What the preceding \-\-patch does
70
+
71
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
72
+
73
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
74
+ .TP
75
+ \fB\-\-patch\-author\fR \fI<PATCH_AUTHOR>\fR
76
+ Who made the preceding \-\-patch
77
+
78
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
79
+
80
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
81
+ .TP
82
+ \fB\-\-patch\-label\fR \fI<PATCH_LABEL>\fR
83
+ Short status note for the preceding \-\-patch, such as beta or recommended
84
+
85
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
86
+
87
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
88
+ .TP
89
+ \fB\-\-patch\-optional\fR \fI<PATCH_OPTIONAL>\fR
90
+ Mark the preceding \-\-patch optional, so it starts switched off and needs \-\-with to run
91
+
92
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
93
+
94
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
95
+ .br
96
+
97
+ .br
98
+ \fIPossible values:\fR
99
+ .RS 14
100
+ .IP \(bu 2
101
+ true
102
+ .IP \(bu 2
103
+ false
104
+ .RE
105
+ .TP
106
+ \fB\-\-patch\-source\-url\fR \fI<PATCH_SOURCE_URL>\fR
107
+ Where the preceding \-\-patch can be downloaded from. The local file is still read to build the weave
108
+
109
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
110
+
111
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
112
+ .TP
113
+ \fB\-\-patch\-header\fR \fI<PATCH_HEADER>\fR
114
+ Whether the preceding \-\-patch applies to the ROM with or without its copier header: auto, keep, or strip
115
+
116
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
117
+
118
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
119
+ .br
120
+
121
+ .br
122
+ \fIPossible values:\fR
123
+ .RS 14
124
+ .IP \(bu 2
125
+ keep
126
+ .IP \(bu 2
127
+ strip
128
+ .IP \(bu 2
129
+ auto
130
+ .RE
131
+ .TP
132
+ \fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
133
+ Override the preceding \-\-patch input rule: base (the weave\*(Aqs ROM) or previous (the patch before it). Use auto to inherit the weave rule
134
+
135
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
136
+
137
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
138
+ .br
139
+
140
+ .br
141
+ \fIPossible values:\fR
142
+ .RS 14
143
+ .IP \(bu 2
144
+ auto
145
+ .IP \(bu 2
146
+ base
147
+ .IP \(bu 2
148
+ previous
149
+ .RE
150
+ .TP
151
+ \fB\-\-default\-patch\-basis\fR \fI<DEFAULT_PATCH_BASIS>\fR
152
+ Record one input ROM rule for every patch. An individual \-\-patch\-basis overrides it.
153
+
154
+ base Every patch was made from the original ROM.
155
+ previous Each later patch was made from the previous result.
156
+ auto Infer the input ROM from checksums (the default).
157
+ .br
158
+
159
+ .br
160
+ \fIPossible values:\fR
161
+ .RS 14
162
+ .IP \(bu 2
163
+ auto
164
+ .IP \(bu 2
165
+ base
166
+ .IP \(bu 2
167
+ previous
168
+ .RE
169
+ .TP
170
+ \fB\-\-patch\-expect\-in\fR \fI<ALGO=HEX>\fR
171
+ Checksum the ROM should have before the preceding \-\-patch runs. Recorded only when it differs from the weave\*(Aqs ROM checksums (repeatable, comma\-separable)
172
+
173
+ This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
174
+
175
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
176
+ .TP
177
+ \fB\-\-patch\-expect\-out\fR \fI<ALGO=HEX>\fR
178
+ Checksum the ROM should have after the preceding \-\-patch runs. Recorded only when it differs from the final output checksums (repeatable, comma\-separable)
179
+ .TP
180
+ \fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
181
+ Checksum the ROM should have once every patch has run, so users can confirm they got the right result (repeatable, comma\-separable)
182
+ .TP
183
+ \fB\-\-output\-name\fR \fI<OUTPUT_NAME>\fR
184
+ File name the weave suggests for the patched ROM
185
+ .TP
186
+ \fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
187
+ Whether the patched ROM should keep its copier header: auto, keep, or strip
188
+ .br
189
+
190
+ .br
191
+ \fIPossible values:\fR
192
+ .RS 14
193
+ .IP \(bu 2
194
+ keep
195
+ .IP \(bu 2
196
+ strip
197
+ .IP \(bu 2
198
+ auto
199
+ .RE
200
+ .TP
201
+ \fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
202
+ Where to write the weave. Name it rom\-weaver\-weave.json, or add .gz or .zst to compress it
203
+ .TP
204
+ \fB\-\-weave\fR \fI<BUNDLE>\fR
205
+ Also pack the weave and its ROM and patches into one shareable archive, such as release.zip
206
+ .TP
207
+ \fB\-\-weave\-rom\fR \fI<BUNDLE_ROM>\fR
208
+ Pack this file into \-\-weave as the ROM, while \-\-input supplies the checksums and metadata
209
+ .TP
210
+ \fB\-\-no\-weave\-rom\fR
211
+ Keep the ROM out of \-\-weave and record only its checksums, so whoever applies the weave brings their own copy
212
+ .TP
213
+ \fB\-\-checksum\fR \fI<ALGO>\fR
214
+ Which checksums to record for the ROM (repeatable, comma\-separable) [default: crc32,md5,sha1]
215
+ .br
216
+
217
+ .br
218
+ \fIPossible values:\fR
219
+ .RS 14
220
+ .IP \(bu 2
221
+ crc32
222
+ .IP \(bu 2
223
+ md5
224
+ .IP \(bu 2
225
+ sha1
226
+ .IP \(bu 2
227
+ sha256
228
+ .IP \(bu 2
229
+ blake3
230
+ .IP \(bu 2
231
+ crc32c
232
+ .IP \(bu 2
233
+ crc16
234
+ .IP \(bu 2
235
+ adler32
236
+ .RE
237
+ .TP
238
+ \fB\-\-from\fR \fI<FILE>\fR
239
+ Build the weave from a hand\-written rom\-weaver\-weave.json instead of flags.
240
+ Use \- to read it from stdin.
241
+
242
+ Write the file with local paths and leave the checksums out; they are filled in
243
+ from the real files. Get the schema with `rom\-weaver weave schema` so your
244
+ editor can check the file as you write it.
245
+
246
+ Any flag you also pass overrides what the file says.
247
+ .TP
248
+ \fB\-\-schema\-ref\fR \fI<URL>\fR
249
+ Record this $schema URL in the weave so editors can validate it. Left out unless asked for
250
+ .TP
251
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
252
+ How many threads to use at most. auto uses every core; a format may still use fewer
253
+ .TP
254
+ \fB\-\-force\fR
255
+ Overwrite the output if it already exists (without this, the command stops instead)
256
+ .TP
257
+ \fB\-h\fR, \fB\-\-help\fR
258
+ Print help (see a summary with \*(Aq\-h\*(Aq)
259
+ .SH CHEATS
260
+ .TP
261
+ \fB\-\-cheat\fR \fI<ID_OR_DESCRIPTION>\fR
262
+ Database cheat to use, by record ID or exact description. Repeat for each cheat
263
+ .TP
264
+ \fB\-\-cheat\-database\fR \fI<DIR>\fR
265
+ Directory holding the cheat shards and optional manifest.json. Defaults to $ROM_WEAVER_CHEAT_DATABASE, then matching shards in per\-user and packaged data trees
266
+ .TP
267
+ \fB\-\-cheat\-system\fR \fI<SYS>\fR
268
+ Console the cheat shard is for (nes, snes, genesis, gameboy, gameboy\-color, gba), when the ROM header does not say
269
+ .TP
270
+ \fB\-\-game\fR \fI<ID>\fR
271
+ Use this database game ID instead of matching the ROM by checksum or title
272
+ .TP
273
+ \fB\-\-allow\-cheat\-conflicts\fR
274
+ Let a later cheat overwrite an earlier one at the same offset instead of failing
275
+ .SH "GLOBAL OPTIONS"
276
+ .TP
277
+ \fB\-n\fR, \fB\-\-dry\-run\fR
278
+ Plan the command without changing files or downloading data
279
+ .TP
280
+ \fB\-\-json\fR
281
+ Print one complete JSON report; progress and diagnostics use stderr
282
+ .TP
283
+ \fB\-\-jsonl\fR
284
+ Stream JSON events, including progress, one object per line
285
+ .TP
286
+ \fB\-\-progress\fR
287
+ Show progress on stderr (automatic on terminals; JSONL includes progress)
288
+ .TP
289
+ \fB\-\-no\-progress\fR
290
+ Hide progress
291
+ .TP
292
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
293
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
294
+ .br
295
+
296
+ .br
297
+ \fIPossible values:\fR
298
+ .RS 14
299
+ .IP \(bu 2
300
+ off
301
+ .IP \(bu 2
302
+ error
303
+ .IP \(bu 2
304
+ warn
305
+ .IP \(bu 2
306
+ info
307
+ .IP \(bu 2
308
+ debug
309
+ .IP \(bu 2
310
+ trace
311
+ .RE
312
+ .TP
313
+ \fB\-v\fR, \fB\-\-verbose\fR
314
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
315
+ .TP
316
+ \fB\-\-debug\fR
317
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
318
+ .TP
319
+ \fB\-q\fR, \fB\-\-quiet\fR
320
+ Hide optional diagnostics and progress; keep results, warnings, and errors
321
+ .TP
322
+ \fB\-\-dep\-trace\fR
323
+ Also log trace output from bundled libraries (for bug reports)
324
+ .TP
325
+ \fB\-\-color\fR
326
+ Keep colors even when output is piped
327
+ .TP
328
+ \fB\-\-no\-color\fR
329
+ Turn colors off
330
+ .TP
331
+ \fB\-y\fR, \fB\-\-yes\fR
332
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -0,0 +1,110 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-weave-parse 1 "rom-weaver-weave-parse "
4
+ .SH NAME
5
+ rom\-weaver\-weave\-parse \- Read a rom\-weaver\-weave.json recipe and report what it points at
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver weave parse\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-filter\fR] [\fB\-\-jsonl\fR] [\fB\-\-no\-extract\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
8
+ .SH DESCRIPTION
9
+ Read a rom\-weaver\-weave.json recipe, check that it is valid, and report the
10
+ ROM and patches it points at.
11
+ .PP
12
+ The input can be a plain rom\-weaver\-weave.json, a compressed one (.gz, .bz2,
13
+ \&.xz, or .zst), or an archive with the recipe at its root alongside the files it
14
+ names.
15
+ .PP
16
+ Entries that name a file are looked for in the archive, or next to the recipe.
17
+ Pass \-\-output to write those files out and get real paths back. Entries that
18
+ name a url are reported as they are; nothing is downloaded.
19
+ .PP
20
+ To actually run a weave, use `rom\-weaver patch apply \-\-weave` instead.
21
+ .SH OPTIONS
22
+ .TP
23
+ \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
24
+ Weave file, or an archive with a weave at its root
25
+ .TP
26
+ \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
27
+ Handle only the weave entries whose file name matches this exact name, prefix, or glob (repeatable)
28
+ .TP
29
+ \fB\-\-filter\fR \fI<FILTER>\fR
30
+ Handle only the weave\*(Aqs rom entry or only its patch entries (repeatable, comma\-separable)
31
+ .br
32
+
33
+ .br
34
+ \fIPossible values:\fR
35
+ .RS 14
36
+ .IP \(bu 2
37
+ rom
38
+ .IP \(bu 2
39
+ patch
40
+ .RE
41
+ .TP
42
+ \fB\-\-no\-extract\fR
43
+ Report what the weave contains without unpacking any of it
44
+ .TP
45
+ \fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
46
+ Directory to unpack the weave\*(Aqs files into. Without it, files packed in an archive are listed but not written out
47
+ .TP
48
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
49
+ How many threads to use at most. auto uses every core; a format may still use fewer
50
+ .TP
51
+ \fB\-h\fR, \fB\-\-help\fR
52
+ Print help (see a summary with \*(Aq\-h\*(Aq)
53
+ .SH "GLOBAL OPTIONS"
54
+ .TP
55
+ \fB\-n\fR, \fB\-\-dry\-run\fR
56
+ Plan the command without changing files or downloading data
57
+ .TP
58
+ \fB\-\-json\fR
59
+ Print one complete JSON report; progress and diagnostics use stderr
60
+ .TP
61
+ \fB\-\-jsonl\fR
62
+ Stream JSON events, including progress, one object per line
63
+ .TP
64
+ \fB\-\-progress\fR
65
+ Show progress on stderr (automatic on terminals; JSONL includes progress)
66
+ .TP
67
+ \fB\-\-no\-progress\fR
68
+ Hide progress
69
+ .TP
70
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
71
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
72
+ .br
73
+
74
+ .br
75
+ \fIPossible values:\fR
76
+ .RS 14
77
+ .IP \(bu 2
78
+ off
79
+ .IP \(bu 2
80
+ error
81
+ .IP \(bu 2
82
+ warn
83
+ .IP \(bu 2
84
+ info
85
+ .IP \(bu 2
86
+ debug
87
+ .IP \(bu 2
88
+ trace
89
+ .RE
90
+ .TP
91
+ \fB\-v\fR, \fB\-\-verbose\fR
92
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
93
+ .TP
94
+ \fB\-\-debug\fR
95
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
96
+ .TP
97
+ \fB\-q\fR, \fB\-\-quiet\fR
98
+ Hide optional diagnostics and progress; keep results, warnings, and errors
99
+ .TP
100
+ \fB\-\-dep\-trace\fR
101
+ Also log trace output from bundled libraries (for bug reports)
102
+ .TP
103
+ \fB\-\-color\fR
104
+ Keep colors even when output is piped
105
+ .TP
106
+ \fB\-\-no\-color\fR
107
+ Turn colors off
108
+ .TP
109
+ \fB\-y\fR, \fB\-\-yes\fR
110
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -0,0 +1,79 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-weave-schema 1 "rom-weaver-weave-schema "
4
+ .SH NAME
5
+ rom\-weaver\-weave\-schema \- Print the rom\-weaver\-weave.json JSON Schema, for editors and hand\-authoring
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver weave schema\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR]
8
+ .SH DESCRIPTION
9
+ Print the rom\-weaver\-weave.json JSON Schema to stdout.
10
+ .PP
11
+ Save it and point your editor at it, and the editor will check and autocomplete
12
+ a weave as you write it:
13
+ .PP
14
+ rom\-weaver weave schema > rom\-weaver\-weave\-v2.schema.json
15
+ .PP
16
+ Then `weave create \-\-from <your file>` turns what you wrote into a finished
17
+ weave with the checksums filled in.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-h\fR, \fB\-\-help\fR
21
+ Print help (see a summary with \*(Aq\-h\*(Aq)
22
+ .SH "GLOBAL OPTIONS"
23
+ .TP
24
+ \fB\-n\fR, \fB\-\-dry\-run\fR
25
+ Plan the command without changing files or downloading data
26
+ .TP
27
+ \fB\-\-json\fR
28
+ Print one complete JSON report; progress and diagnostics use stderr
29
+ .TP
30
+ \fB\-\-jsonl\fR
31
+ Stream JSON events, including progress, one object per line
32
+ .TP
33
+ \fB\-\-progress\fR
34
+ Show progress on stderr (automatic on terminals; JSONL includes progress)
35
+ .TP
36
+ \fB\-\-no\-progress\fR
37
+ Hide progress
38
+ .TP
39
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
40
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
41
+ .br
42
+
43
+ .br
44
+ \fIPossible values:\fR
45
+ .RS 14
46
+ .IP \(bu 2
47
+ off
48
+ .IP \(bu 2
49
+ error
50
+ .IP \(bu 2
51
+ warn
52
+ .IP \(bu 2
53
+ info
54
+ .IP \(bu 2
55
+ debug
56
+ .IP \(bu 2
57
+ trace
58
+ .RE
59
+ .TP
60
+ \fB\-v\fR, \fB\-\-verbose\fR
61
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
62
+ .TP
63
+ \fB\-\-debug\fR
64
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
65
+ .TP
66
+ \fB\-q\fR, \fB\-\-quiet\fR
67
+ Hide optional diagnostics and progress; keep results, warnings, and errors
68
+ .TP
69
+ \fB\-\-dep\-trace\fR
70
+ Also log trace output from bundled libraries (for bug reports)
71
+ .TP
72
+ \fB\-\-color\fR
73
+ Keep colors even when output is piped
74
+ .TP
75
+ \fB\-\-no\-color\fR
76
+ Turn colors off
77
+ .TP
78
+ \fB\-y\fR, \fB\-\-yes\fR
79
+ Answer yes to every confirmation instead of asking. Does not choose between candidates