tg_backup

Backup your messages from the Telegram messenger.

This is a very initial version of the software.

Installation

You can install tg_backup using Homebrew.

brew tap AlexPl292/tg_backup
brew install tg_backup

Please visit GitHub Releases for builds for other platforms.

Usage

• Run tg_backup auth. Follow the authentication process.
• Start tg_backup to back up your messages.

Notes

• At the moment only one-to-one chats are backed up
• By default, tg_backup creates a session file under $HOME$/.tg_backup directory.
  Use options to modify this behaviour.

Options

Please keep in mind that this list is updated along with the main branch.
Use --help flag to get the list of options for your version.

Main options

tg_backup --help

USAGE:
    tg_backup [FLAGS] [OPTIONS] [SUBCOMMAND]

FLAGS:
    -c, --clean
            If presented, the previous existing backup will be removed

    -h, --help
            Prints help information

        --panic-to-stderr
            By default, panics are saved to log file. Use this option to show panics in stderr.
            
            If enabled, panics will be printed in stderr and not in logs.

    -q, --quiet
            Show no output

    -V, --version
            Prints version information


OPTIONS:
        --batch-size <batch-size>
            Size of batches with messages [default: 1000]

    -e, --excluded-chats <excluded-chats>...
            List of chats that are going to be excluded from saving.
            
            If both included-chats and excluded_chats have the same value, the chat will be
            excluded.

    -i, --included-chats <included-chats>...
            List of chats that are going to be saved. All chats are saved by default.
            
            If both included-chats and excluded_chats have the same value, the chat will be
            excluded.

        --keep-last-n-logs <keep-last-n-logs>
            Amount of log files that would be kept in the log directory [default: 1000]

    -o, --output <output>
            Backup output directory

        --session-file <session-file>
            Path to custom session file [default: ~/.tg_backup/tg_backup.session]


SUBCOMMANDS:
    auth    
            Start authentication process

    help    
            Prints this message or the help of the given subcommand(s)

Auth subcommand options:

tg_backup auth --help

USAGE:
    tg_backup auth [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --session-file-dir <session-file-dir>
            Use this folder to create a session file [default: ~/.tg_backup]

        --session-file-name <session-file-name>
            Custom name for session file [default: tg_backup.session]

License

tg_backup is licensed under the terms of the GNU Public License version 3 or any later version.