voodooEntity / go-tachicrypt

A experimental cli tool to encrypt & decrypt files/directories.
Apache License 2.0
13 stars 3 forks source link
cli decryption encryption golang


TachiCrypt
TachiCrypt

An experimental cli tool to encrypt & decrypt files/directories.

Key FeaturesHow To UseScreenshotsHow To BuildRoadmapChangelogLicense

Important right now this is an experimental project and the safety and stability isn't guaranteed!

Key Features

How to use

Encrypt

The following command is an example on how to encrypt. The password for the masterlock will be prompted interactively.

tachicrypt -hide -data /path/to/your/file/or/directory -output /path/to/where/ecnrypted/data/and/masterlock/should/be/stored -parts INT

Decrypt

The following command is an example on how to decrypt. The password for the masterlock will be prompted interactively.

tachicrypt -unhide -data /path/to/your/encrypted/files/and/masterlock -output /path/to/where/the/decrypted/data/should/be/stored

Help

You can always use

tachicrypt --help

to print information about the params and example commands for encrypting and decrypting.

Screenshots

Encryption

TachiCrypt Encryption cli output example

Decryption

TachiCrypt Decryption cli output example

How to build

To clone and run this application, you'll need Git and go installed on your computer. From your command line:

# Move to your GOPATH directory 
$ cd $GOPATH

# Create necessary directories
$ mkdir -p github.com/voodooEntity

# Move into the newly created directory
$ cd github.com/voodooEntity

# Clone this repository
$ git clone https://github.com/voodooEntity/go-tachicrypt.git

# Move to the client directory
$ cd go-tachicrypt/cmd/client

# Build the application
$ go build -o tachicrypt

# Copy the resulting binary into your gopath binary directory
$ cp tachicrypt $GOPATH/bin

After this steps you can use the command 'tachicrypt' on the cli wherever you are

Roadmap

At this point i want to repeat that this is an experimental project. I got no exact timeline or plans on when i will enhance this software. I probably gonne decide this based on if there is anyone interested and actually will be using it. So if you want me to further improve it - leave a star to let me know .)

Changelog

Notice: While in alpha, minor version updates may be breaking. While i will try to reduce the amount of breaking changes, it still may happen. When breaking changes are to be expected it will be informed about in the breaking versions changelog.

Check the Changelog

Latest Release Alpha 0.3.0

License

Apache License Version 2.0


laughingman.dev  ·  GitHub @voodooEntity