Metadata-Version: 2.1
Name: f-encrypt
Version: 1.1
Summary: UNKNOWN
Home-page: https://github.com/kylep/f-encrypt
Author: Kyle Pericak
Author-email: kyle@pericak.com
License: UNKNOWN
Download-URL: https://github.com/kylep/f-encrypt/archive/1.01.tar.gz
Description: # f-encrypt
        
        A simple tool to encrypt and decrypt files from the command-line.
        
        Currently only AES-256 in CBC mode is supported.
        
        
        ## General Usage
        
        ### Setting the Key
        
        The key can also be defined using the environment variable `F_ENCRYPT_KEY`
        
        ```bash
        # Option 1: enter your key with an option
        f-encrypt <file> --key <key>
        
        # Option 2: Prompt for password
        f-encrypt <file>
        Enter Key: <key>
        
        # Decrypting uses the same --key and env-var setup
        f-decrypt <file>
        ```
        
        
        ### Setting the output file
        
        ```bash
        f-encrypt <path> -o <new path>
        f-encrypt <path> --output <new path>
        f-decrypt <path> -o <new path>
        ```
        
        ### Configuration
        
        The following environment variables are supported to further configure the tool.
        The shown values are their defaults.
        
        ```bash
        export F_ENCRYPT_KEY=example          # Set the encryption key so --key is not needed
        export F_ENCRYPT_SILENT=true          # Enable Silent mode - do not confirm or print anything
        export F_ENCRYPT_VERBOSITY=1          # Set the level of verbosity for output text (1 to 5)
        export F_ENCRYPT_OUTPUT_SUFFIX=".ct"  # When -o is not used, output to <path><suffix>
        export F_ENCRYPT_RM=false             # Override --keep/--rm when set to "true", to rm source file
        ```
        
        
        ---
        
        
        ## Installation
        
        ### From source
        
        ```bash
        virtualenv --python=python3 env/
        source env/bin/activate
        pip install .
        ```
        
Platform: UNKNOWN
Classifier: Topic :: Security :: Cryptography
Description-Content-Type: text/markdown
