You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+64-2Lines changed: 64 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,12 +31,26 @@ cirup --help
31
31
32
32
## Global options
33
33
34
-
-`-v`, `-vv`, ...: increase log verbosity.
34
+
-`--output-format <jsonl|json|table>`: control stdout format. Default is `jsonl`.
35
+
-`--dry-run`: compute results without writing output files. If a command normally writes to a file, the result is rendered to stdout instead.
36
+
-`--check`: imply `--dry-run` and exit with code `2` when the command would produce changes.
37
+
-`--summary`: print a structured execution summary instead of full result rows. Combine it with `--dry-run` for inspect-only workflows.
38
+
-`--count-only`: print only the number of matching results to stdout.
39
+
-`--key-filter <pattern>`: keep only results whose key matches a simple regex-style pattern. Repeatable. Supported syntax: literals, `^`, `$`, `.`, and `.*`.
40
+
-`--value-filter <pattern>`: keep only results whose value matches the same simple regex-style syntax. Repeatable.
41
+
-`--limit <n>`: keep only the first `n` matching results.
42
+
-`--quiet`: only print errors to stderr.
43
+
-`--log-level <error|warn|info|debug|trace>`: set stderr verbosity explicitly.
44
+
-`-v`, `-vv`, ...: increase log verbosity starting from the default `warn` level.
35
45
-`-C`, `--show-changes`: for `file-diff`, include keys that exist in both files but have different values.
36
46
-`--touch`: force writing output files even when generated bytes are identical.
37
47
-`--output-encoding <utf8-no-bom|utf8-bom|utf8>`: control output file encoding. `utf8` behaves like `utf8-no-bom`.
38
48
39
-
By default, cirup avoids rewriting output files when content has not changed.
49
+
By default, cirup writes JSONL to stdout, logs at `warn` level, and avoids rewriting output files when content has not changed.
50
+
51
+
`--summary` emits compact metadata such as counts, write intent, and whether output would be truncated. `--check` is intended for automation and returns exit code `2` when a command would produce changes.
52
+
53
+
`--key-filter` and `--value-filter` are intentionally limited to a SQL-translatable subset. Unsupported syntax such as `|`, `()`, `[]`, `{m,n}`, `+`, and lookarounds is rejected instead of being interpreted as full regex.
40
54
41
55
## Common operations
42
56
@@ -46,12 +60,24 @@ By default, cirup avoids rewriting output files when content has not changed.
46
60
cirup file-print input.resx
47
61
```
48
62
63
+
Show a human-readable table instead:
64
+
65
+
```bash
66
+
cirup --output-format table file-print input.resx
67
+
```
68
+
49
69
Write the printed content to a file:
50
70
51
71
```bash
52
72
cirup file-print input.resx output.json
53
73
```
54
74
75
+
Preview the same operation without writing the output file:
76
+
77
+
```bash
78
+
cirup --dry-run file-print input.resx output.json
79
+
```
80
+
55
81
### Convert between formats
56
82
57
83
```bash
@@ -81,6 +107,18 @@ Show keys present in `file1` but missing in `file2`:
81
107
cirup file-diff file1.resx file2.resx
82
108
```
83
109
110
+
Count missing keys without writing the full result set:
0 commit comments