Skip to content

cenotes/cenotes-cli

Repository files navigation

CENotes CLI

https://travis-ci.org/cenotes/cenotes-cli.svg?branch=master

C(ryptographical) E(xpendable) Notes

Command Line Interface

What is this?

This is a cli project to support encryption/decryption of expendable notes

What this isn't

UI/Frontend/Backend. This is a cli project. Frontend and backend solutions are different projects. The reason for this is to allow flexibility in frontend / backend choice and to avoid huge bundle projects.

  • A backend project that uses these libraries can be found here
  • A frontend project that communicates with the backend can be found here

Features

  • Symmetric encryption of notes using the pynacl project
  • Local encryption & decryption of a note
  • Support to store a note to a cenotes server instance
  • Support to fetch a note from a cenotes server instance
  • Support for custom cenotes server url

How does this work?

See design

How to run

You will need python >= 3.3

  1. Cloning the repo
  • Clone the repo
    • git clone https://github.com/cenotes/cenotes-cli.git
  • Install the requirements with pipenv
    • pip install pipenv
    • pipenv install
  • Set your PYTHONPATH to include the project
    • For linux: export PYTHONPATH=<path-to-the-cloned-repo>:$PYTHONPATH
  • See available options
    • python cenotes_cli/cli.py --help
  1. Installing the python package
  • Ideally inside a virtualenv
    • pip install cenotes-cli
  • See available options
    • cenotes-cli --help