Skip to content

A CLI tool to handle encrypted compressed backups of files or directory

License

Notifications You must be signed in to change notification settings

MikyStar/bkp-node

Repository files navigation

BKP (Node)

Create and extract backups of a file or directory compressed with tgz and encrypted with aes-256-cbc with both your password and a generated initialization vector

Installation

Requires NPM

npm i -g bkp-node # Install package

bkp --version # Print installed version
bkp --help # Print the manuel

Use

Create backup

# Prototype
bkp <c|create> <source path> [<destination path>]

# Examples
bkp c myFile # Create a backup named 'myFile.bkp'
bkp c myFile here # Create a backup named 'here'

source path : Absolute or relative path to what you want to backup

destination path : Optional, absolute or relative path to where you want your backup file, default: '.bkp'

It will then prompt you for the password you want to set

After encryption, a initialization vector will be outputed, you must store it in order to decrypt afterwards


Extract backup

# Prototype
bkp <x|extract> <source path> [<destination path>]

# Examples
bkp x myFile.bkp # Extract the backup inside 'myFile'
bkp x myFile.bkp here # Extract the backup inside 'here'
bkp x myFile # Extract the backup inside 'myFile.dec'

source path : Absolute or relative path to your backup location

destination path : Optional, absolute or relative path to where you want your clear content, if you have used the default '.bkp' extension it will be trimmed, otherwise it will append the prefix '.dec'

It will then prompt you for the password you have set

Then, you provide the initialization vector that was generated during the backup creation

About

A CLI tool to handle encrypted compressed backups of files or directory

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published