Added short flags and updated readme

Author: sdatar-akamai

README.md

@@ -13,7 +13,7 @@ File Encryptor is a command-line tool written in Go that provides secure file en
 - Support for **all file types**: text, images (JPG, PNG), videos, spreadsheets, and more
 - Parallel processing for faster encryption and decryption of large files
 
-**File Support Note**: 
+**File Support Note**:
 - The tool supports all file types, including:
   - **Text**: TXT, CSV, JSON
   - **Media**: JPG, PNG, MP4
@@ -32,7 +32,7 @@ Example usage ensures seamless encryption and decryption without data corruption
 
 2. Clone this repository:
    ```bash
-   git clone https://github.com/yourusername/file-encryptor.git
+   git clone https://github.com/sd416/file-encryptor.git
    ```
 
 3. Navigate to the project directory:
@@ -42,7 +42,7 @@ Example usage ensures seamless encryption and decryption without data corruption
 
 4. Build the project:
    ```bash
-   go build -o file-encryptor main.go
+   go build -o file-encryptor cmd/file-encryptor/main.go
    ```
 
 ## Usage
@@ -60,21 +60,29 @@ ssh-keygen -t rsa -b 4096 -f my_ssh_key
 
 #### Encrypt a file using an RSA public key:
 ```bash
-./file-encryptor -e --file <input_file> --key my_ssh_key.pub
+./file-encryptor -e --file <input_file> --key <public_key_file>
+# or using short flags
+./file-encryptor -e -f <input_file> -k <public_key_file>
 ```
 Example:
 ```bash
 ./file-encryptor -e --file picture.jpg --key my_ssh_key.pub
+# or
+./file-encryptor -e -f picture.jpg -k my_ssh_key.pub
 ```
 - The encrypted file will be saved as `picture.jpg.enc`.
 
 #### Encrypt a file using a password:
 ```bash
 ./file-encryptor -e --file <input_file> --password <your_password>
+# or using short flags
+./file-encryptor -e -f <input_file> -p <your_password>
 ```
 Example:
 ```bash
 ./file-encryptor -e --file document.pdf --password myStrongPassword123
+# or
+./file-encryptor -e -f document.pdf -p myStrongPassword123
 ```
 
 ---
@@ -83,21 +91,29 @@ Example:
 
 #### Decrypt a file using an RSA private key:
 ```bash
-./file-encryptor -d --file <encrypted_file> --key my_ssh_key
+./file-encryptor -d --file <encrypted_file> --key <private_key_file>
+# or using short flags
+./file-encryptor -d -f <encrypted_file> -k <private_key_file>
 ```
 Example:
 ```bash
 ./file-encryptor -d --file picture.jpg.enc --key my_ssh_key
+# or
+./file-encryptor -d -f picture.jpg.enc -k my_ssh_key
 ```
 - The decrypted file will retain its original extension (e.g., `picture.jpg`).
 
 #### Decrypt a file using a password:
 ```bash
 ./file-encryptor -d --file <encrypted_file> --password <your_password>
+# or using short flags
+./file-encryptor -d -f <encrypted_file> -p <your_password>
 ```
 Example:
 ```bash
 ./file-encryptor -d --file document.pdf.enc --password myStrongPassword123
+# or
+./file-encryptor -d -f document.pdf.enc -p myStrongPassword123
 ```
 
 ---
@@ -126,4 +142,3 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 This tool is provided as-is, without any warranties. Always ensure you have backups of your important files before encryption.
 
 ---
-

cmd/file-encryptor/main.go

@@ -13,16 +13,23 @@ import (
 
 func main() {
 	logger := logging.NewLogger()
-	logger.LogDebug("Starting file encryptor") //Added debug log
+	logger.LogDebug("Starting file encryptor")
 
 	encrypt := flag.Bool("e", false, "Encrypt the file")
 	decrypt := flag.Bool("d", false, "Decrypt the file")
+
+    // Define both short and long flag names for file and key
 	file := flag.String("file", "", "File to encrypt or decrypt")
-	key := flag.String("key", "", "Path to the key file (public key for encryption, private key for decryption)")
+	flag.StringVar(file, "f", "", "File to encrypt or decrypt (shorthand)") //Bind short flag to the same variable
+	key := flag.String("key", "", "Path to the key file")
+    flag.StringVar(key, "k", "", "Path to the key file (shorthand)") //Bind short flag to the same variable
+
 	password := flag.String("password", "", "Password for encryption/decryption (alternative to key file)")
+    flag.StringVar(password, "p", "", "Password for encryption/decryption (shorthand)") //Bind short flag to the same variable
 	flag.Parse()
-	logger.LogDebug("Parsed command line flags") // Added debug log
+	logger.LogDebug("Parsed command line flags")
 
+    // Use the flag values after parsing.
 	if err := validateFlags(*encrypt, *decrypt, *file, *key, *password); err != nil {
 		logger.LogError(err.Error())
 		flag.Usage()
@@ -38,7 +45,7 @@ func main() {
 		operation = "Decryption"
 		outputFile, err = handleDecryption(*file, *key, *password, logger)
 	}
-    logger.LogDebugf("Operation: %s, Output file: %s", operation, outputFile) // Added debug log
+    logger.LogDebugf("Operation: %s, Output file: %s", operation, outputFile)
 
 	if err != nil {
 		logger.LogError(fmt.Sprintf("%v", err))
@@ -49,7 +56,7 @@ func main() {
 	}
 
 	logger.LogInfo(fmt.Sprintf("File %s completed. Output file: %s", strings.ToLower(operation), outputFile))
-	logger.LogDebug("File encryption/decryption completed") // Added debug log
+	logger.LogDebug("File encryption/decryption completed")
 }
 
 func validateFlags(encrypt, decrypt bool, file, key, password string) error {
@@ -58,15 +65,15 @@ func validateFlags(encrypt, decrypt bool, file, key, password string) error {
 	}
 
 	if file == "" {
-		return fmt.Errorf("please provide the --file argument")
+		return fmt.Errorf("please provide the --file or -f argument")
 	}
 
 	if key == "" && password == "" {
-		return fmt.Errorf("please provide either --key or --password argument")
+		return fmt.Errorf("please provide either --key or -k or --password or -p argument")
 	}
 
 	if key != "" && password != "" {
-		return fmt.Errorf("please provide either --key or --password, not both")
+		return fmt.Errorf("please provide either --key or -k or --password or -p, not both")
 	}
 
 	return nil
@@ -82,7 +89,7 @@ func handleEncryption(file, key, password string, logger *logging.Logger) (strin
 	} else {
 		encryptor, err = crypto.NewPasswordEncryptor(password)
 	}
-    logger.LogDebugf("Initialized encryptor: %T", encryptor) // Added debug log
+    logger.LogDebugf("Initialized encryptor: %T", encryptor)
 
 	if err != nil {
 		return "", fmt.Errorf("error initializing encryptor: %v", err)
@@ -103,7 +110,7 @@ func handleDecryption(file, key, password string, logger *logging.Logger) (strin
 	} else {
 		decryptor, err = crypto.NewPasswordDecryptor(password)
 	}
-    logger.LogDebugf("Initialized decryptor: %T", decryptor) // Added debug log
+    logger.LogDebugf("Initialized decryptor: %T", decryptor)
 
 	if err != nil {
 		return "", fmt.Errorf("error initializing decryptor: %v", err)