https://github.com/sur-ser/symmorph-cli

CLI tool for encrypting and decrypting files using the SymmetricMorph cipher.
https://github.com/sur-ser/symmorph-cli

cipher cli command-line crypto-library cryptography data-protection encryption file-encryption node-cli nodejs password-encryption security stream-encryption symmetric-encryption symmetricmorph typescript

Last synced: 2 months ago
JSON representation

CLI tool for encrypting and decrypting files using the SymmetricMorph cipher.

• Host: GitHub
• URL: https://github.com/sur-ser/symmorph-cli
• Owner: sur-ser
• License: mit
• Created: 2025-04-28T09:47:11.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2025-04-28T18:06:28.000Z (2 months ago)
• Last Synced: 2025-04-28T19:23:35.751Z (2 months ago)
• Topics: cipher, cli, command-line, crypto-library, cryptography, data-protection, encryption, file-encryption, node-cli, nodejs, password-encryption, security, stream-encryption, symmetric-encryption, symmetricmorph, typescript
• Language: JavaScript
• Homepage: https://github.com/sur-ser/symmorph-cli
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
# Symmorph CLI

SymmetricMorph CLI is a powerful command-line tool for encrypting and decrypting files using the unique **[SymmetricMorph](https://github.com/sur-ser/symmetricmorph)** algorithm.

## ✨ Features

- 🔒 **Symmetric stream encryption** for robust security

- ⚡ **Fast and secure** processing

- 📦 **Cross-platform** support: Windows, Linux, macOS

- 🪶 **Lightweight** with no external dependencies except `symmetricmorph`

- 🖥 **User-friendly** CLI interface

## 📥 Installation

### Global Installation

Install Symmorph CLI globally using npm or Yarn:

```bash

npm install -g symmorph-cli

```

or

```bash

yarn global add symmorph-cli

```

Or use without installing globally:

```bash

npx symmorph-cli  [options]

```

## 🚀 Usage

### Encrypt a File

Encrypt a file with a password:

```bash

symmorph encrypt --input ./file.txt --output ./file.enc --password "StrongPassword123"

```

or using shortcuts:

```bash

symmorph encrypt -i ./file.txt -o ./file.enc -p "StrongPassword123"

```

### Decrypt a File

Decrypt a file with the same password:

```bash

symmorph decrypt --input ./file.enc --output ./file.txt --password "StrongPassword123"

```

or using shortcuts:

```bash

symmorph decrypt -i ./file.enc -o ./file.txt -p "StrongPassword123"

```

## 📚 Options

| Option       | Shortcut | Description                          | Required |

|--------------|----------|--------------------------------------|----------|

| `--input`    | `-i`     | Path to input file                   | Yes      |

| `--output`   | `-o`     | Path to output file                  | Yes      |

| `--password` | `-p`     | Password for encryption/decryption   | Yes      |

## 🌎 Supported Platforms

- **Windows**: cmd, PowerShell, Git Bash

- **macOS**: Terminal

- **Linux**: bash, zsh, and more

## 📄 License

MIT License © 2025