Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

cipherjs

sheharyarn48MIT0.1.1

Javascript implementation of simple ciphers

cli, crypto, cryptography, cipher, caesar, substitution, vigenere, affine, encrypt, decrypt

readme

Build Status Coverage Status Downloads Version

Javascript implementation of simple Ciphers


Installation

Install the package using yarn:

$ yarn add cipherjs

or npm:

$ npm install --save cipherjs

Usage

Start by require-ing the module:

const CipherJS = require('cipherjs');

It returns an Object of available ciphers, each with their own encrypt and decrypt methods:

const Vigenere = CipherJS.Vigenere;

Vigenere.encrypt('MY SECRET MESSAGE', 'MY SECRET KEY')
// YW KIEIIM WIQEYYI

Command-line App

cipherjs comes with a CLI app that lets you encrypt or decrypt data interactively. To use it, install the package globally:

$ npm install -g cipherjs

and just execute cipherjs in your terminal:

$ cipherjs

Contributing

  • Fork, Enhance, Send PR
  • Lock issues with any bugs or feature requests
  • Implement something from Roadmap
  • Spread the word

License

This package is available as open source under the terms of the MIT License.