# kripher

[![Travis Build Status](https://travis-ci.org/marionauta/kripher.rs.svg)][1]
[![crates.io Release](https://img.shields.io/crates/v/kripher.svg)][2]

File encoder based on an own algorithm that allows you to protect your files
with a numeric key.

This is a learning project, there are other options you should use if you want
to protect files or any other data. Use `kripher` just for fun. This is a
reimplementation of [kripher][3] in Rust.

## Using

    kripher --version
    kripher [--output OUTFILE] (--encode | --decode) KEY [FILE]

Encode or decode a _FILE_ with a numeric _KEY_. If no _FILE_ is given, the
standard input will be used as a source.

    kripher --encode 1984 george.txt

Encode file _george.txt_ with the key _1984_ and write to stdout.

    cat hal.txt | kripher -d 2001 > stanley.txt

or

    kripher -o stanley.txt -d 2001 hal.txt

Decode file _hal.txt_ with the key _2001_ and write to the file _stanley.txt_

## Installing

### Cargo install

    cargo install kripher

This is the easiest way, but you need Rust and Cargo to build it.

### Releases

Go to the [latest release][4], download it, extract it and move:

1. the binary `kripher` to `/usr/local/bin`.
2. the man page `kripher.1.gz` to `/usr/local/share/man/man1`.

```
tar -xf kripher.tar.xs && cd kripher
mv kripher /usr/local/bin
mv man/kripher.1.gz /usr/local/share/man/man1
```

- **Note:** Not all operating systems are available.
- **Note 2:** The commands above are for a _Unix_ like system.

## Contributing

Anyone is welcome to contribute.
All contributions will be licensed under the MIT license.

[1]: https://travis-ci.org/marionauta/kripher.rs
[2]: https://crates.io/crates/kripher/
[3]: https://github.com/marionauta/kripher
[4]: https://github.com/marionauta/kripher.rs/releases/latest