Report Bug
Changelog
Download

Fencryption

A simple cli program to encrypt a directory or a file, made with nodejs and typescript.

• Fencryption
  • Usage
  • Features
  • Development
    • How to build/compile
  • License

Usage

Usage: fencryption [options] [command]

A simple cli program to encrypt a file/directory

Options:
  -V, --version                     output the version number
  --verbose                         enable verbose mode
  --debug                           enable debug mode
  -h, --help                        display help for command

Commands:
  encrypt|e [options] <path> <key>  encrypt a file/directory
  decrypt|d [options] <path> <key>  decrypt an encrypted file/directory
  help [command]                    display help for command

You can also get help about commands using fencryption help [command] or fencryption [command] --help

Features

• Encrypt and decrypt a file or a directory with the key of your choice (when encrypting a directory, file/directory names are also encrypted)

Development

How to build/compile

• Use npm run build in the project directory to build.
• Use npm run build:binaries to create an executable.

License

MIT (see LICENSE)