Skip to content

Commit 92ad55b

Browse files
authored
Update README.md
1 parent 6dd58ec commit 92ad55b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,22 @@ You can also import the Python library into your own code like so:
127127
`diff` will now contain the same data structure as the output in the `--json` example above.
128128

129129
If the columns in the CSV have changed, those added or removed columns will be ignored when calculating changes made to specific rows.
130+
131+
## Full CLI Helptext
132+
133+
`Usage: db-diff \[OPTIONS\] PREVIOUS CURRENT
134+
135+
Compare the differences between two CSV or JSON files to find differences.
136+
137+
Options:
138+
--format TEXT Explicitly specify input format. Available (csv|tsv|json) \[default: auto-detect based on file extension\]
139+
--encoding TEXT Input File Encoding. Available: (utf-8|utf-16|utf-16le|utf-16be|latin1|cp1252|ascii|...) \[default: utf-8\]
140+
--key TEXT Column to use as a unique ID for each row (ex: --key=Id) \[default: first column if not specified\]
141+
--output TEXT Output format. Available: (readable|json|jsonfile) \[default: readable\]
142+
--outputfile FILE File to write JSON output to (only used with --output=jsonfile)
143+
--showunchanged If a record is changed, show ALL fields, not just the changed fields.
144+
--time Measure and display elapsed time for the diff operation
145+
--version Show the version and exit.
146+
-h, --help Show this message and exit.
147+
148+
Example: db-diff old.csv new.csv --key=Id --output=jsonfile --outputfile=diff.json`

0 commit comments

Comments
 (0)