Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rubinders/crypt-aes

Cli tool to encrypt files and folders using AES
https://github.com/rubinders/crypt-aes

aes cli decrypt decryption encrypt encryption

Last synced: 14 days ago
JSON representation

Cli tool to encrypt files and folders using AES

Awesome Lists containing this project

README

        

![GitHub](https://img.shields.io/github/license/rubinder25/nodecrypt?style=flat-square) ![GitHub package.json version](https://img.shields.io/github/package-json/v/rubinder25/nodecrypt?style=flat-square) [![Actions Status](https://github.com/rubinder25/crypt-aes/workflows/build/badge.svg)](https://github.com/rubinder25/crypt-aes/workflows/build/badge.svg)

# Crypt-AES

Cli tool to encrypt files and folders using AES

## Install

```
npm i crypt-aes -g
```

## Usage

```
crypt-aes encrypt|decrypt [options]
```

or

```
c-aes enc|dec [options]
```

for example:

```
crypt-aes encrypt --source file.txt --password mypass
```

or

```
c-aes enc -s file.txt -p mypass
```

| Option | Description |
| :------------------------------ | :----------------------------------------------------------------------------------------------- |
| --source, -s : | source file or directory |
| --password, -p : | password to be used |
| --keep, -k : | keep the original file after the operation
(optional, default is delete the original file) |
| --output, -o : | output directory for the processed files
(optional, default is same directory) |

For help:

```
c-aes -h
```

## Usage as a module

crypt-aes can also be used as local npm dependency

```javascript
import {encrypt, decrypt} from 'crypt-aes';

encrypt({srcPath: './', pswrd: 'mypass', keepSrc: false, destPath: null});
```