@rom-weaver/cli 0.16.1 → 0.18.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.
- package/README.md +9 -16
- package/docs/completions/_rom-weaver +114 -7
- package/docs/completions/rom-weaver.bash +135 -5
- package/docs/completions/rom-weaver.elv +68 -4
- package/docs/completions/rom-weaver.fish +75 -24
- package/docs/completions/rom-weaver.ps1 +74 -4
- package/docs/man/rom-weaver-compress.1 +1 -1
- package/docs/man/rom-weaver-patch-apply.1 +1 -1
- package/docs/man/rom-weaver-patch-create.1 +1 -1
- package/docs/man/rom-weaver-probe.1 +4 -1
- package/docs/man/rom-weaver-save-create.1 +86 -0
- package/docs/man/rom-weaver-save-list-games.1 +71 -0
- package/docs/man/rom-weaver-save.1 +6 -0
- package/docs/man/rom-weaver-weave.1 +1 -1
- package/docs/man/rom-weaver.1 +2 -2
- package/package.json +17 -15
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-probe \- Identify a file: its format, its platform, and any header it carries
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver probe\fR [\fB\-i\fR|\fB\-\-input\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\-ignore\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] [\fIFILE\fR]
|
|
7
|
+
\fBrom\-weaver probe\fR [\fB\-i\fR|\fB\-\-input\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\-ignore\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-\-split\-bin\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] [\fIFILE\fR]
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Identify a file. Reports what format it is, which console it is for, whether it
|
|
10
10
|
carries a copier header, and what is inside it if it is an archive.
|
|
@@ -43,6 +43,9 @@ Do not look inside archives; identify the file itself
|
|
|
43
43
|
\fB\-\-no\-ignore\fR
|
|
44
44
|
Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
|
|
45
45
|
.TP
|
|
46
|
+
\fB\-\-split\-bin\fR
|
|
47
|
+
List per\-track BIN files for a CD\-format CHD
|
|
48
|
+
.TP
|
|
46
49
|
\fB\-h\fR, \fB\-\-help\fR
|
|
47
50
|
Print help (see a summary with \*(Aq\-h\*(Aq)
|
|
48
51
|
.TP
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH rom-weaver-save-create 1 "rom-weaver-save-create "
|
|
4
|
+
.SH NAME
|
|
5
|
+
rom\-weaver\-save\-create \- Create a fresh save or a copy of an existing save template
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBrom\-weaver save create\fR [\fB\-\-game\fR] [\fB\-\-json\fR] [\fB\-\-template\fR] [\fB\-\-jsonl\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-progress\fR] [\fB\-\-force\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] [\fIFIELD=VALUE\fR]
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Create a fresh save or a copy of an existing save template
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-game\fR \fI<GAME_ID>\fR
|
|
13
|
+
Game to generate or use with a template
|
|
14
|
+
.TP
|
|
15
|
+
\fB\-\-template\fR \fI<SAVE>\fR
|
|
16
|
+
Existing save to copy before setting fields
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
|
|
19
|
+
Where to write the new save
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
22
|
+
Check the new save without writing it
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-force\fR
|
|
25
|
+
Replace an existing output file
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
28
|
+
Print help
|
|
29
|
+
.TP
|
|
30
|
+
[\fIFIELD=VALUE\fR]
|
|
31
|
+
Save property to set in the new file
|
|
32
|
+
.SH "GLOBAL OPTIONS"
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-json\fR
|
|
35
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-jsonl\fR
|
|
38
|
+
Stream JSON events, including progress, one object per line
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-progress\fR
|
|
41
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-no\-progress\fR
|
|
44
|
+
Hide progress
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
47
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
48
|
+
.br
|
|
49
|
+
|
|
50
|
+
.br
|
|
51
|
+
\fIPossible values:\fR
|
|
52
|
+
.RS 14
|
|
53
|
+
.IP \(bu 2
|
|
54
|
+
off
|
|
55
|
+
.IP \(bu 2
|
|
56
|
+
error
|
|
57
|
+
.IP \(bu 2
|
|
58
|
+
warn
|
|
59
|
+
.IP \(bu 2
|
|
60
|
+
info
|
|
61
|
+
.IP \(bu 2
|
|
62
|
+
debug
|
|
63
|
+
.IP \(bu 2
|
|
64
|
+
trace
|
|
65
|
+
.RE
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-v\fR, \fB\-\-verbose\fR
|
|
68
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-debug\fR
|
|
71
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
74
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-dep\-trace\fR
|
|
77
|
+
Also log trace output from bundled libraries (for bug reports)
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-\-color\fR
|
|
80
|
+
Keep colors even when output is piped
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-\-no\-color\fR
|
|
83
|
+
Turn colors off
|
|
84
|
+
.TP
|
|
85
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
86
|
+
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH rom-weaver-save-list-games 1 "rom-weaver-save-list-games "
|
|
4
|
+
.SH NAME
|
|
5
|
+
rom\-weaver\-save\-list\-games \- List supported games and fresh save generation support
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBrom\-weaver save list\-games\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
|
+
List supported games and fresh save generation support
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
13
|
+
Print help
|
|
14
|
+
.SH "GLOBAL OPTIONS"
|
|
15
|
+
.TP
|
|
16
|
+
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
17
|
+
Plan the command without changing files or downloading data
|
|
18
|
+
.TP
|
|
19
|
+
\fB\-\-json\fR
|
|
20
|
+
Print one complete JSON report; progress and diagnostics use stderr
|
|
21
|
+
.TP
|
|
22
|
+
\fB\-\-jsonl\fR
|
|
23
|
+
Stream JSON events, including progress, one object per line
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-\-progress\fR
|
|
26
|
+
Show progress on stderr (off by default; JSONL includes progress)
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-no\-progress\fR
|
|
29
|
+
Hide progress
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
|
|
32
|
+
How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
|
|
33
|
+
.br
|
|
34
|
+
|
|
35
|
+
.br
|
|
36
|
+
\fIPossible values:\fR
|
|
37
|
+
.RS 14
|
|
38
|
+
.IP \(bu 2
|
|
39
|
+
off
|
|
40
|
+
.IP \(bu 2
|
|
41
|
+
error
|
|
42
|
+
.IP \(bu 2
|
|
43
|
+
warn
|
|
44
|
+
.IP \(bu 2
|
|
45
|
+
info
|
|
46
|
+
.IP \(bu 2
|
|
47
|
+
debug
|
|
48
|
+
.IP \(bu 2
|
|
49
|
+
trace
|
|
50
|
+
.RE
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-v\fR, \fB\-\-verbose\fR
|
|
53
|
+
Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-debug\fR
|
|
56
|
+
Show developer diagnostics and trace events on stderr (same as \-vvv)
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
59
|
+
Hide optional diagnostics and progress; keep results, warnings, and errors
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-dep\-trace\fR
|
|
62
|
+
Also log trace output from bundled libraries (for bug reports)
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-color\fR
|
|
65
|
+
Keep colors even when output is piped
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-no\-color\fR
|
|
68
|
+
Turn colors off
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
71
|
+
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
@@ -71,6 +71,12 @@ Turn colors off
|
|
|
71
71
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
72
72
|
.SH SUBCOMMANDS
|
|
73
73
|
.TP
|
|
74
|
+
rom\-weaver\-save\-list\-games(1)
|
|
75
|
+
List supported games and fresh save generation support
|
|
76
|
+
.TP
|
|
77
|
+
rom\-weaver\-save\-create(1)
|
|
78
|
+
Create a fresh save or a copy of an existing save template
|
|
79
|
+
.TP
|
|
74
80
|
rom\-weaver\-save\-identify(1)
|
|
75
81
|
Identify a supported game save without changing it
|
|
76
82
|
.TP
|
|
@@ -379,7 +379,7 @@ Game Genie or GameShark/Pro Action Replay code to bake into the ROM. Repeat for
|
|
|
379
379
|
Console the \-\-code values are for (nes, snes, genesis, 32x, sms, gamegear, sg1000, gameboy, gba, psx), when the ROM header does not say
|
|
380
380
|
.TP
|
|
381
381
|
\fB\-\-code\-kind\fR \fI<CODE_KIND>\fR [default: auto]
|
|
382
|
-
|
|
382
|
+
Cheat scheme: auto, game\-genie, gameshark/par, xploder, pro\-action\-rocky, gold\-finger, game\-shark\-v1[\-raw], or action\-replay\-v3[\-raw]
|
|
383
383
|
.TP
|
|
384
384
|
\fB\-\-emit\-bundle\fR \fI<PATH>\fR
|
|
385
385
|
Also write a rom\-weaver\-bundle.json recording this run, so someone else can repeat it
|
package/docs/man/rom-weaver.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver 1 "rom-weaver 0.
|
|
3
|
+
.TH rom-weaver 1 "rom-weaver 0.18.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver \- Inspect, extract, checksum, compress, trim, and patch ROMs and disc images
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -148,4 +148,4 @@ Examples:
|
|
|
148
148
|
|
|
149
149
|
Full guide: https://rom\-weaver.com/docs/cli
|
|
150
150
|
.SH VERSION
|
|
151
|
-
v0.
|
|
151
|
+
v0.18.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rom-weaver/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.18.0",
|
|
4
4
|
"author": "Brandon Casey",
|
|
5
5
|
"license": "AGPL-3.0-or-later",
|
|
6
6
|
"description": "A command-line ROM toolkit: patch, compress, extract, convert, identify, bake in cheat codes, and edit supported game saves. No telemetry.",
|
|
@@ -59,10 +59,12 @@
|
|
|
59
59
|
"docs/man/rom-weaver-patch-validate.1",
|
|
60
60
|
"docs/man/rom-weaver-probe.1",
|
|
61
61
|
"docs/man/rom-weaver-save.1",
|
|
62
|
+
"docs/man/rom-weaver-save-create.1",
|
|
62
63
|
"docs/man/rom-weaver-save-export-schema.1",
|
|
63
64
|
"docs/man/rom-weaver-save-get.1",
|
|
64
65
|
"docs/man/rom-weaver-save-identify.1",
|
|
65
66
|
"docs/man/rom-weaver-save-inspect.1",
|
|
67
|
+
"docs/man/rom-weaver-save-list-games.1",
|
|
66
68
|
"docs/man/rom-weaver-save-set.1",
|
|
67
69
|
"docs/man/rom-weaver-setup.1",
|
|
68
70
|
"docs/man/rom-weaver-tools.1",
|
|
@@ -84,15 +86,15 @@
|
|
|
84
86
|
"node": ">=22"
|
|
85
87
|
},
|
|
86
88
|
"optionalDependencies": {
|
|
87
|
-
"@rom-weaver/darwin-arm64": "0.
|
|
88
|
-
"@rom-weaver/darwin-x64": "0.
|
|
89
|
-
"@rom-weaver/linux-arm64-musl": "0.
|
|
90
|
-
"@rom-weaver/linux-ia32-musl": "0.
|
|
91
|
-
"@rom-weaver/linux-x64-gnu": "0.
|
|
92
|
-
"@rom-weaver/linux-x64-musl": "0.
|
|
93
|
-
"@rom-weaver/win32-arm64-msvc": "0.
|
|
94
|
-
"@rom-weaver/win32-ia32-msvc": "0.
|
|
95
|
-
"@rom-weaver/win32-x64-msvc": "0.
|
|
89
|
+
"@rom-weaver/darwin-arm64": "0.18.0",
|
|
90
|
+
"@rom-weaver/darwin-x64": "0.18.0",
|
|
91
|
+
"@rom-weaver/linux-arm64-musl": "0.18.0",
|
|
92
|
+
"@rom-weaver/linux-ia32-musl": "0.18.0",
|
|
93
|
+
"@rom-weaver/linux-x64-gnu": "0.18.0",
|
|
94
|
+
"@rom-weaver/linux-x64-musl": "0.18.0",
|
|
95
|
+
"@rom-weaver/win32-arm64-msvc": "0.18.0",
|
|
96
|
+
"@rom-weaver/win32-ia32-msvc": "0.18.0",
|
|
97
|
+
"@rom-weaver/win32-x64-msvc": "0.18.0"
|
|
96
98
|
},
|
|
97
99
|
"scripts": {
|
|
98
100
|
"docs:lint": "markdownlint-cli2",
|
|
@@ -111,13 +113,13 @@
|
|
|
111
113
|
"version": "node scripts/sync-version.mjs"
|
|
112
114
|
},
|
|
113
115
|
"devDependencies": {
|
|
114
|
-
"@commitlint/cli": "21.2.
|
|
115
|
-
"@commitlint/config-conventional": "21.2.
|
|
116
|
+
"@commitlint/cli": "21.2.3",
|
|
117
|
+
"@commitlint/config-conventional": "21.2.3",
|
|
116
118
|
"cross-spawn": "7.0.6",
|
|
117
119
|
"doctoc": "2.5.0",
|
|
118
|
-
"lefthook": "2.1.
|
|
119
|
-
"markdownlint-cli2": "0.23.
|
|
120
|
-
"oxlint": "1.
|
|
120
|
+
"lefthook": "2.1.15",
|
|
121
|
+
"markdownlint-cli2": "0.23.3",
|
|
122
|
+
"oxlint": "1.86.0",
|
|
121
123
|
"tar": "7.5.22"
|
|
122
124
|
}
|
|
123
125
|
}
|