Backuply

---

A Simple backup client with an emphasis on ease-of-use

🧐 About

Simple backup client written in NodeJS with an emphasis on ease-of-use. Has the ability to create both full backups and then differential backups to save space and time.

💾 Installation

Install Backuply using NPM

npm i -g backuply

👷‍♂️ Usage

Using backuply is simple by design. Simply start with the operation (backup, restore, or config) and specify any options to apply.

Usage: backuply <command> [options...]

Commands:
  backuply config   configure backuply
  backuply backup   performs a custom backup of a select directory(s)
  backuply restore  perform a restore from a target backup

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

Most functionality such as backup type is automatically determined based on how you are creating the backup. Backup options shown below

backuply backup

Descrtiption: Performs a custom backup of a select directory(s)

Positionals:
  name    the name for this backup                                      [string]
  source  the source directory to use for the backup. This is the directory that
          will be at the root of your backup                            [string]
  dest    the destination path which will contain the backup.           [string]

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
  --ref      a reference id or name for the full backup used in generating a dif
             ferential backup based on the reference.                   [string]
Examples:
  # Will create a full backup of the source directory
  - backuply backup <name> <source_path> <destination_path>
  # Will create a differential backup when recognizing referenced full backup
  - backuply backup <name> <source_path> <destination_path> --ref <name/uuid>

Restoring from an existing backup could not be easier.

backuply restore

Description: Perform a restore from a target backup

Positionals:
  ref   the full uuid or name for the backup to restore                 [string]
  dest  path to destination restore directory                           [string]

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

⚙️ App Configuration

Making changes to any app configuration can be done in a single one-line command which is capable of modifying multiple attributes at a time. See below for usage details and some examples

backuply config

Description: Configure backuply

Options:
  --help       Show help                                               [boolean]
  --version    Show version number                                     [boolean]
  --db.path    Configure the path to the local database used to store backup 
               metadata                                                 [string]
  --log.level  Configure the logging level                              [string]

Examples:
  # Enable debug logging
  - backuply config --log.level DEBUG
  # Change local db path
  - backuply config --db.path ~/Documents/backuply/db.json

Future iterations with more config options will follow the same format and will also be documented in the config --help subcommand.

🧩 Contributing

If you would like to contribute an idea, feature request, or bugfix please start by creating an issue

👷‍♂️ Authors

• Ben Sykes (SystemFiles)