diff --git a/README.md b/README.md new file mode 100644 index 0000000..ba1bf6f --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# backup-dc-from-db-cli + +This is a small CLI tool to open a DeltaChat directory +and export it in the format +which can be imported by any Delta Chat client. + +## Setup + +``` +git clone https://git.0x90.space/missytake/backup_dc_from_db_cli +cd backup_dc_from_db_cli +poetry install +``` + +## Usage + +``` +$ poetry run backup-dc-from-db-cli -h +usage: backup-dc-from-db-cli [-h] [--db_path DB_PATH] [--account ACCOUNT] [--output OUTPUT] [--passphrase PASSPHRASE] [-v] + +options: + -h, --help show this help message and exit + --db_path DB_PATH Path to DeltaChat directory + --account ACCOUNT email address of the account to backup + --output OUTPUT output file name + --passphrase PASSPHRASE + passphrase to encrypt the backup file. environment variable: DC_BACKUP_PASSPHRASE + -v, --verbose print logs +$ poetry run backup-dc-from-db-cli --account user@example.org --output ~/Desktop/backup.tar +``` +