calvin.erfmann/WhatsApp-Chat-Exporter
1
0
Fork 0
mirror of https://github.com/KnugiHK/WhatsApp-Chat-Exporter.git synced 2026-04-23 14:31:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
KnugiHK
2025-03-02 15:45:28 +08:00
parent 0074acca7a
commit d75c485a3d
1 changed files with 66 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
README.md
View File

@@ -135,55 +135,73 @@ After extracting, you will get these:
Invoke the wtsexporter with --help option will show you all options available. Invoke the wtsexporter with --help option will show you all options available.
```sh ```sh
> wtsexporter --help > wtsexporter --help
usage: wtsexporter [-h] [-a] [-i] [-e EXPORTED] [-w WA] [-m MEDIA] [-b BACKUP] [-o OUTPUT] [-j [JSON]] usage: wtsexporter [-h] [-a] [-i] [-e EXPORTED] [-w WA] [-m MEDIA] [-b BACKUP] [-d DB] [-k [KEY]]
[--avoid-encoding-json] [--pretty-print-json [PRETTY_PRINT_JSON]] [-d DB] [-k KEY] [-t TEMPLATE] [--call-db [CALL_DB_IOS]] [--wab WAB] [-o OUTPUT] [-j [JSON]] [--txt [TEXT_FORMAT]] [--no-html]
[-s] [-c] [--offline OFFLINE] [--size [SIZE]] [--no-html] [--check-update] [--assume-first-as-me] [--size [SIZE]] [--avoid-encoding-json] [--pretty-print-json [PRETTY_PRINT_JSON]] [--per-chat]
[--no-avatar] [--import] [--business] [--wab WAB] [--time-offset {-12 to 14}] [--date DATE] [--import] [-t TEMPLATE] [--offline OFFLINE] [--no-avatar] [--experimental-new-theme]
[--headline HEADLINE] [-c] [--create-separated-media] [--time-offset {-12 to 14}] [--date DATE]
[--date-format FORMAT] [--include [phone number ...]] [--exclude [phone number ...]] [--date-format FORMAT] [--include [phone number ...]] [--exclude [phone number ...]]
[--dont-filter-empty] [--per-chat] [--create-separated-media] [--dont-filter-empty] [--enrich-from-vcards ENRICH_FROM_VCARDS]
[--decrypt-chunk-size DECRYPT_CHUNK_SIZE] [--enrich-from-vcards ENRICH_FROM_VCARDS] [--default-country-code DEFAULT_COUNTRY_CODE] [-s] [--check-update] [--assume-first-as-me]
[--default-country-code DEFAULT_CONTRY_CODE] [--txt [TEXT_FORMAT]] [--experimental-new-theme] [--business] [--decrypt-chunk-size DECRYPT_CHUNK_SIZE]
[--call-db [CALL_DB_IOS]] [--headline HEADLINE] [--max-bruteforce-worker MAX_BRUTEFORCE_WORKER]
A customizable Android and iOS/iPadOS WhatsApp database parser that will give you the history of your WhatsApp A customizable Android and iOS/iPadOS WhatsApp database parser that will give you the history of your WhatsApp
conversations in HTML and JSON. Android Backup Crypt12, Crypt14 and Crypt15 supported. conversations in HTML and JSON. Android Backup Crypt12, Crypt14 and Crypt15 supported.
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
Device Type:
-a, --android Define the target as Android -a, --android Define the target as Android
-i, --ios, Define the target as iPhone/iPad -i, --ios Define the target as iPhone/iPad
-e EXPORTED, --exported EXPORTED -e, --exported EXPORTED
Define the target as exported chat file and specify the path to the file Define the target as exported chat file and specify the path to the file
-w WA, --wa WA Path to contact database (default: wa.db/ContactsV2.sqlite)
-m MEDIA, --media MEDIA Input Files:
Path to WhatsApp media folder (default: WhatsApp) -w, --wa WA Path to contact database (default: wa.db/ContactsV2.sqlite)
-b BACKUP, --backup BACKUP -m, --media MEDIA Path to WhatsApp media folder (default: WhatsApp)
Path to Android (must be used together with -k)/iOS WhatsApp backup -b, --backup BACKUP Path to Android (must be used together with -k)/iOS WhatsApp backup
-o OUTPUT, --output OUTPUT -d, --db DB Path to database file (default: msgstore.db/7c7fba66680ef796b916b067077cc246adacf01d)
Output to specific directory (default: result) -k, --key [KEY] Path to key file. If this option is set for crypt15 backup but nothing is specified, you will
-j [JSON], --json [JSON] be prompted to enter the key.
Save the result to a single JSON file (default if present: result.json) --call-db [CALL_DB_IOS]
Path to call database (default: 1b432994e958845fffe8e2f190f26d1511534088) iOS only
--wab, --wa-backup WAB
Path to contact database in crypt15 format
Output Options:
-o, --output OUTPUT Output to specific directory (default: result)
-j, --json [JSON] Save the result to a single JSON file (default if present: result.json)
--txt [TEXT_FORMAT] Export chats in text format similar to what WhatsApp officially provided (default if present:
result/)
--no-html Do not output html files
--size, --output-size, --split [SIZE]
Maximum (rough) size of a single output file in bytes, 0 for auto
JSON Options:
--avoid-encoding-json --avoid-encoding-json
Don't encode non-ascii characters in the output JSON files Don't encode non-ascii characters in the output JSON files
--pretty-print-json [PRETTY_PRINT_JSON] --pretty-print-json [PRETTY_PRINT_JSON]
Pretty print the output JSON. Pretty print the output JSON.
-d DB, --db DB Path to database file (default: msgstore.db/7c7fba66680ef796b916b067077cc246adacf01d) --per-chat Output the JSON file per chat
-k KEY, --key KEY Path to key file
-t TEMPLATE, --template TEMPLATE
Path to custom HTML template
-s, --showkey Show the HEX key used to decrypt the database
-c, --move-media Move the media directory to output directory if the flag is set, otherwise copy it
--offline OFFLINE Relative path to offline static files
--size [SIZE], --output-size [SIZE], --split [SIZE]
Maximum (rough) size of a single output file in bytes, 0 for auto
--no-html Do not output html files
--check-update Check for updates (require Internet access)
--assume-first-as-me Assume the first message in a chat as sent by me (must be used together with -e)
--no-avatar Do not render avatar in HTML output
--import Import JSON file and convert to HTML output --import Import JSON file and convert to HTML output
--business Use Whatsapp Business default files (iOS only)
--wab WAB, --wa-backup WAB HTML Options:
Path to contact database in crypt15 format -t, --template TEMPLATE
Path to custom HTML template
--offline OFFLINE Relative path to offline static files
--no-avatar Do not render avatar in HTML output
--experimental-new-theme
Use the newly designed WhatsApp-alike theme
--headline HEADLINE The custom headline for the HTML output. Use '??' as a placeholder for the chat name
Media Handling:
-c, --move-media Move the media directory to output directory if the flag is set, otherwise copy it
--create-separated-media
Create a copy of the media seperated per chat in <MEDIA>/separated/ directory
Filtering Options:
--time-offset {-12 to 14} --time-offset {-12 to 14}
Offset in hours (-12 to 14) for time displayed in the output Offset in hours (-12 to 14) for time displayed in the output
--date DATE The date filter in specific format (inclusive) --date DATE The date filter in specific format (inclusive)
@@ -194,24 +212,24 @@ options:
Exclude chats that match the supplied phone number Exclude chats that match the supplied phone number
--dont-filter-empty By default, the exporter will not render chats with no valid message. Setting this flag will --dont-filter-empty By default, the exporter will not render chats with no valid message. Setting this flag will
cause the exporter to render those. This is useful if chat(s) are missing from the output cause the exporter to render those. This is useful if chat(s) are missing from the output
--per-chat Output the JSON file per chat
--create-separated-media Contact Enrichment:
Create a copy of the media seperated per chat in <MEDIA>/separated/ directory
--decrypt-chunk-size DECRYPT_CHUNK_SIZE
Specify the chunk size for decrypting iOS backup, which may affect the decryption speed.
--enrich-from-vcards ENRICH_FROM_VCARDS --enrich-from-vcards ENRICH_FROM_VCARDS
Path to an exported vcf file from Google contacts export. Add names missing from WhatsApp's Path to an exported vcf file from Google contacts export. Add names missing from WhatsApp's
default database default database
--default-country-code DEFAULT_CONTRY_CODE --default-country-code DEFAULT_COUNTRY_CODE
Use with --enrich-from-vcards. When numbers in the vcf file does not have a country code, this Use with --enrich-from-vcards. When numbers in the vcf file does not have a country code, this
will be used. 1 is for US, 66 for Thailand etc. Most likely use the number of your own country will be used. 1 is for US, 66 for Thailand etc. Most likely use the number of your own country
--txt [TEXT_FORMAT] Export chats in text format similar to what WhatsApp officially provided (default if present:
result/) Miscellaneous:
--experimental-new-theme -s, --showkey Show the HEX key used to decrypt the database
Use the newly designed WhatsApp-alike theme --check-update Check for updates (require Internet access)
--call-db [CALL_DB_IOS] --assume-first-as-me Assume the first message in a chat as sent by me (must be used together with -e)
Path to call database (default: 1b432994e958845fffe8e2f190f26d1511534088) iOS only --business Use Whatsapp Business default files (iOS only)
--headline HEADLINE The custom headline for the HTML output. Use '??' as a placeholder for the chat name --decrypt-chunk-size DECRYPT_CHUNK_SIZE
Specify the chunk size for decrypting iOS backup, which may affect the decryption speed.
--max-bruteforce-worker MAX_BRUTEFORCE_WORKER
Specify the maximum number of worker for bruteforce decryption.
WhatsApp Chat Exporter: 0.11.2 Licensed with MIT. See https://wts.knugi.dev/docs?dest=osl for all open source WhatsApp Chat Exporter: 0.11.2 Licensed with MIT. See https://wts.knugi.dev/docs?dest=osl for all open source
licenses. licenses.