README.md
[//]: #@corifeus-header
[](https://travis-ci.org/patrikx3/aes-folder)
[](https://uptimerobot.patrikx3.com/)
[](https://www.npmjs.com/package/p3x-aes-folder/)
---
# 👮 AES secure folder encrypt and decrypt v2018.12.28-2
This is an open-source project. Star this repository, if you like it, or even donate! Thank you so much! :)
I run my own server with dynamic IP address, so, it may happen, that the server can not be reachable for about max 15 minutes, due to nature of the dynamic DNS. The server may also be unreachable, when I backup the SSD with Clonzilla (very rarely) or an electrical issue (but this should not happen again). When the server is down, please hang on for 15-30 minutes and the server will be back up.
All my domains (patrikx3.com and corifeus.com) could have errors, since I am developing in my free time. However, it is usually stable.
**Bugs are evident™ - MATRIX️**
### Node Version Requirement
```
>=10.13.0
```
### Built on Node
```
v11.6.0
```
The ```async``` and ```await``` keywords are required.
Install NodeJs:
https://nodejs.org/en/download/package-manager/
# Description
[//]: #@corifeus-header:end
Secure encrypt a folder or decrypt a file into a folder using AES-256-CBC (like codes, business top secrets).
# Install
```bash
sudo npm install -g p3x-aes-folder --unsafe-perm=true --allow-root
```
# Breaking change
If you updated a secure folder `p3x-aes-folder` and you are sure the code is right, please read this [readme](artifacts/readme/breaking-change.md).
The last break change is in NodeJs it self between 10.12.0 -> 11.0.0, so you may read the break change link above.
## Versions
v```Year.Month.Day-Build```
v2020.12.31-3
# Usage
Usually, I keep my ```krip.krip``` file and move to the ```ramdisk```, then I use it like below.
I use this ```ramdisk```:
https://pages.corifeus.com/ramdisk
Of course, there is ```ramdisk``` for ```Windows``` as well. Many...
## Help
```bash
krip help
```
```text
krip v2020.12.31-xx
usage:
krip help - this help info
krip info input? - if omit input, it uses krip.krip
krip read|decrypt input? - if omit input, it uses krip.krip
krip write|encrypt input? - if omit input, it uses current krip directory
```
## Write / Encrypt
```bash
# krip is the folder, you can ommit totally,
# if you are in a folder that has a krip this folder name
krip write /home/patrikx3/ramdisk/krip
# so in the current directory having krip folder, is enough
krip write
```
```text
Generated command:
krip write /home/patrikx3/ramdisk/krip
Or:
krip write
Password? ****************
Password confirm? ****************
file done
3845754 total bytes
```
Then you can save on the drive, safely.
## Read / Decrypt
I usually, move my drive to the ```ramdisk```.
```bash
# krip.krip is the file you use,
# but you can ommit totally,
# if you are in a folder that has a file krip.krip
krip read /home/patrikx3/ramdisk/krip.krip
# so in the current directory having krip.krip file existing, it is enough
krip read
```
```text
Generated command:
krip read /home/patrikx3/ramdisk/krip.krip
Or:
krip read
Password? ****************
krip.krip file v2018.10.20-3
p3x-aes-folder package v2018.10.28-0
Built on Node v11.0.0
read file
decypher done
decrypt done
unzip done
```
## Info
```bash
# krip.krip is the file you use,
# but you can ommit totally,
# if you are in a folder that has a file krip.krip
krip info /home/patrikx3/ramdisk/krip.krip
# so in the current directory having krip.krip file existing, it is enough
krip info
```
```text
Generated command:
patrikx3@workstation:~/ramdisk$ krip info
Generated command:
krip info krip.krip
krip.krip file v2018.10.20-3
p3x-aes-folder package v2018.10.28-0
Built on Node v11.0.0
```
[//]: #@corifeus-footer
---
[**P3X-AES-FOLDER**](https://pages.corifeus.com/aes-folder) Build v2018.12.28-2
[](https://www.facebook.com/corifeus.software) [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [](https://www.patrikx3.com/en/front/contact)
## P3X Sponsors
[IntelliJ - The most intelligent Java IDE](https://www.jetbrains.com)
[](https://www.jetbrains.com/) [](https://www.nosqlbooster.com/)
[The Smartest IDE for MongoDB](https://www.nosqlbooster.com)
[//]: #@corifeus-footer:end