miracle091/Picocrypt
miracle091
/
Picocrypt
mirror of https://github.com/HACKERALERT/Picocrypt.git
1
0
Fork 0
Code Releases Activity

Update CLI README

This commit is contained in:
Evan Su 2023-04-12 22:44:45 -04:00 committed by GitHub
parent 5a5cc0ae6e
commit c221405f25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cli/README.md
View File

@ -1,5 +1,4 @@
# CLI
Before you dive in, keep in mind that the CLI is limited in functionality and not meant to replace the GUI in any remote way. It only works with volumes that don't use any keyfiles or advanced features, and you will still need the GUI to do anything more than basic file encryption. You should only use the CLI when you are not able to run the GUI or need an automatable interface for encrypting and decrypting files.
# Installation
@ -10,7 +9,8 @@ go install github.com/HACKERALERT/Picocrypt/cli/picocrypt@latest
You should now be able to run `picocrypt` in your terminal. If not, run `export PATH=$PATH:$(go env GOPATH)/bin` and try again.
# Usage
The CLI is designed to do one thing and one thing only: encrypt and decrypt a single file. Thus, it should be very simple to use:
```
picocrypt -p password <file>
```
The CLI is designed to do one thing and one thing only: encrypt and decrypt a single file. Its goal isn't to be full-blown encryption tool, but to provide the basics of file encryption so that you can do the rest. This allows you to write custom scripts to encrypt your weekly backups, secure client files on a server, etc.
It's basic by design, allowing you to use it as a secure building block for automating encryption, writing shell scripts, and so on.