Vilo: A Lightweight backup CLI Tool

Vilo is a simple version control and backup system written in Go, designed to handle file versioning, encryption, and compression using AES and Gzip.

Features

1. Initialize: Create the required .vilo directory structure.
2. Add: Stage files to the staging area.
3. Commit: Encrypt, compress, and save staged files into the .vilo/objects directory.
4. Secure Storage: Files are stored securely with AES encryption.
5. Custom Commit Messages: Tag your commits with meaningful messages.
6. Rollback: Rollback to previous commits.

---

Installation

Prerequisites

• Go (Golang) version 1.16 or higher

Clone the Repository

$ git clone https://github.com/ammargit93/vilo.git
$ cd Vilo

Build the CLI

Run the following command to build the executable:

$ go build -o vilo.exe .

This will create the vilo.exe executable in the current directory.

---

Usage

Initialize Vilo

Initialize a new repository in the current directory:

$ ./vilo init

This creates a .vilo directory containing:

• .vilo/HEAD: Stores commit hashes
• .vilo/stage.json: Tracks staged files
• .vilo/objects/: Stores committed files

Add Files to Staging Area

Add files to the staging area using the add command:

$ ./vilo add --files file1.txt,file2.txt

Output:

/path/to/file1.txt Staged for commit
/path/to/file2.txt Staged for commit

Commit Files

Commit files with a custom message:

$ ./vilo commit --Message "Initial commit"

Output:

Commit successful!

Committed files are encrypted, compressed, and saved into .vilo/objects/<hash>/.

View commits

$ vilo show

Rollback

Rollbacks to specified commit with the hash values mentioned with the '--hash' flag, descrypts and decompresses inside the directory specified by the '--foldername' flag.

$ vilo rollback --hash <commit-hash> --foldername <directory>

---

Encryption & Compression

Files are:

1. Compressed using Gzip to save space.
2. Encrypted using AES (CFB mode) for secure storage.

.vilo Directory Structure

After a commit, the structure looks like this:

.vilo/
├── HEAD
├── history
├── stage.json
└── objects/
    └── <commit-hash>/
        ├── file1.txt.enc
        └── file2.txt.enc

---

Future Improvements

• Remote sync with Google drive, dropbox, AWS S3.
• Watch-mode to auto sync and commit on regular time intervals.
• Authentication to secrets and custom AES keys.
• Storing diffs instead of whole files.

Contributing

Feel free to fork this repository and submit pull requests!

Author

Ammar Ansari