0.1.2 • Published 6 years ago

octosecret v0.1.2

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

octosecret

Simple and secure encryption between github users JavaScript Style Guide

How it works

This tool can encrypt/decrypt files or streams of data. Data will be encrypted using the public key of the github user you specify. Decryption will use your private key (typically located at ~/.ssh/id_rsa). Check octosecret-crypto for implementation details.

API

  Usage:
    $ octosecret [command] [args]

  Commands:
    encrypt [github username] [file]    Encrypt using github user public key
    decrypt [file]                      Decrypt using your private key

  How it works:
    This tool will encrypt/decrypt files or streams. Data will be encrypted
    using the public key of the github user you specify. Decryption will use
    your private key (located at ~/.ssh/id_rsa)

  Examples:
    Start encryption in interactive mode.
    $ octosecret encrypt

    Encrypt '/some/file' using github.com/hugorodrigues public key.
    $ octosecret encrypt hugorodrigues /some/file

    Encrypt data using github.com/hugorodrigues public key.
    $ echo "Hello" | octosecret encrypt hugorodrigues

    Decrypt in interactive mode.
    $ octosecret decrypt

    Decrypt '/some/file.octosecret' using your private key.
    $ octosecret decrypt /some/file.octosecret

Check octosecret-crypto if you need to use this programmatically.