https://github.com/jrdpteam/vortex

A command-line tool for file encryption and decryption using AES-256, with strong password generation and management.
https://github.com/jrdpteam/vortex

aes aes-256 command-line-tool cryptography decryption encryption file-encryption password-management security

Last synced: about 1 month ago
JSON representation

A command-line tool for file encryption and decryption using AES-256, with strong password generation and management.

• Host: GitHub
• URL: https://github.com/jrdpteam/vortex
• Owner: jrdpteam
• Created: 2024-09-12T14:37:00.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T15:45:12.000Z (8 months ago)
• Last Synced: 2024-10-22T02:58:48.958Z (8 months ago)
• Topics: aes, aes-256, command-line-tool, cryptography, decryption, encryption, file-encryption, password-management, security
• Language: Python
• Homepage: https://jrdpteam.netlify.app
• Size: 15.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vortex

vortex is a file encryption and decryption tool that uses AES-256. It provides strong password generation and management, with a simple command-line interface.

## Installation

1. Clone or download the source code to your local machine.

2. Install the required libraries:

       pip3 install cryptography colorama

## Usage

### Encrypting a File

To encrypt a file, use the `-e` option. You must specify the password length (`-l`) and the character set (`-t`) for password generation.

    python3 vortex.py -f  -e -l  -t 

**Options:**

- `-f`, `--file`: Path to the file to encrypt.

- `-l`, `--password-length`: Length of the generated password.

- `-t`, `--chars`: Character set to use for the password. Options: `letter`, `number`, `extra`.

- `-c`, `--custom-password`: Use a custom password (if using this option, do not specify `-l` and `-t`).

Example:

    python3 vortex.py -f example.txt -e -l 12 -t letter number extra

### Decrypting a File

To decrypt a file, use the `-d` option. You will be prompted to enter the password.

    python3 vortex.py -f  -d

**Options:**

- `-f`, `--file`: Path to the encrypted file (`.vrtx` extension).

- `-d`, `--decrypt`: Decrypt the file.

Example:

    python3 vortex.py -f example.txt.vrtx -d

## Contact

For any questions or issues, please open an issue on GitHub or contact the project maintainers.