Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eppie-io/eppie-cli
Command line client for Eppie — an encrypted p2p email
https://github.com/eppie-io/eppie-cli
cli cryptography csharp decentralization email emailclient encryption end-to-end-encryption gmail imap-client outlook p2p pgp protonmail security
Last synced: 3 months ago
JSON representation
Command line client for Eppie — an encrypted p2p email
- Host: GitHub
- URL: https://github.com/eppie-io/eppie-cli
- Owner: Eppie-io
- License: apache-2.0
- Created: 2023-04-05T19:04:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:25:13.000Z (3 months ago)
- Last Synced: 2024-10-29T11:42:04.742Z (3 months ago)
- Topics: cli, cryptography, csharp, decentralization, email, emailclient, encryption, end-to-end-encryption, gmail, imap-client, outlook, p2p, pgp, protonmail, security
- Language: C#
- Homepage: https://eppie.io
- Size: 2.38 MB
- Stars: 33
- Watchers: 2
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Command line client for Eppie — an encrypted p2p email
[![LicenseBadge][license-badge]](https://raw.githubusercontent.com/Eppie-io/Eppie-CLI/main/LICENSE)
![WindowsBadge][windows-badge]
![LinuxBadge][linux-badge]
![macOSBadge][mac-badge]
[![FrameworkBadge][framework-badge]](https://dotnet.microsoft.com/en-us/download/dotnet)
[![Build and Test][build-workflow-badge]](https://github.com/Eppie-io/Eppie-CLI/actions/workflows/build-and-test.yml?query=branch%3Amain+event%3Apush)
[![CodeQL][codeql-workflow-badge]](https://github.com/Eppie-io/Eppie-CLI/actions/workflows/codeql.yml?query=branch%3Amain+event%3Aschedule)
[![CrowdinBadge][crowdin-badge]](https://eppie.crowdin.com/eppie)
[![Release][release-badge]](https://github.com/Eppie-io/Eppie-CLI/releases/latest)
## Intro
Eppie-CLI is a work-in-progress command line client for the upcoming encrypted p2p email [Eppie](https://eppie.io). Currently, it is primarily used for testing during Eppie [Core module](https://github.com/Eppie-io/TuviCore) development. It has limited functionality at the moment, but in the future Eppie-CLI will become an official fully featured CLI for Eppie.
You might find Eppie-CLI interesting if
- You would like to contribute to Eppie development (yay! 👍)
- You want a CLI for your SMTP email. Eppie can be used as a conventional email client with Gmail, Microsoft Outlook etc. It can also work with Proton Mail.
- You want to be the first to try our p2p email, as soon as it's ready
In any case you are very welcome to fork, build and explore this module to your heart's content (see instructions below).
## Features
The decentralized protoccol is still in development and its features are not yet available in Eppie-CLI. Meanwhile Eppie works as a conventional CLI email client with additional security features:
- Creating a local account using a Seed Phrase according to [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) standard
- [PGP](https://www.openpgp.org/) encryption support (WIP)
- Connecting any number of third-party email accounts (e.g. Gmail. Microsoft Outlook etc.)
- Connecting Proton Mail account
- Creating a local backup
- Viewing mailboxes
- Viewing a single message
- Writing & sending messages
- Decentralized messaging (on the test network)
## Build project
### Prerequisites
- [.NET 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
### Clone
First of all, clone the project repository to your machine:
```console
git clone --recursive https://github.com/Eppie-io/Eppie-CLI.git eppie-cli
```
### Build
To build the **Eppie.CLI** project, run the following command in the project root directory:
```console
dotnet build ./src/Eppie.CLI/
```
## Downloads
You may want to skip the building and download the latest release for your system:
### Windows binaries
- [Eppie.CLI-win-x64.zip](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-win-x64.zip)
- [Eppie.CLI-win-x86.zip](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-win-x86.zip)
- [Eppie.CLI-win-arm64.zip](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-win-arm64.zip)
### Linux binaries
- [Eppie.CLI-linux-x64.tar.gz](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-linux-x64.tar.gz)
- [Eppie.CLI-linux-arm64.tar.gz](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-linux-arm64.tar.gz)
- [Eppie.CLI-linux-arm.tar.gz](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-linux-arm.tar.gz)
### MacOS binaries
- [Eppie.CLI-osx-x64.tar.gz](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-osx-x64.tar.gz)
- [Eppie.CLI-osx-arm64.tar.gz](https://github.com/Eppie-io/Eppie-CLI/releases/latest/download/Eppie.CLI-osx-arm64.tar.gz)
## Launch
### If built from the source
To launch **Eppie Console** application, run the following command:
```console
dotnet run --project ./src/Eppie.CLI/Eppie.CLI/Eppie.CLI.csproj
```
If you compile your own binaries, you will need to authorize the application in **Google Developer Console** and **Microsoft Azure Portal** in order to be able to connect **Gmail** and **Microsoft Outlook** mailboxes. Basically, Google and Microsoft want to know a little bit about the app before they allow it to access their users' data. [Here](docs/Register%20the%20application.md) is a little tutorial. When you get the **Client ID** and **Client Secret** (only Gmail) pass them as arguments with launch command, like this:
```console
dotnet run --project ./src/Eppie.CLI/Eppie.CLI/Eppie.CLI.csproj -- --Authorization:Gmail:ClientId="" --Authorization:Gmail:ClientSecret="" --Authorization:Outlook:ClientId=""
```
If you download the binaries you can skip this step. We went through Google's and Microsoft's security audits and certification procedures, so it is now a bit more convenient.
### If downloaded the binaries
Go to the project folder:
#### Linux and MacOS
Add execute pemission:
```console
chmod +x ./eppie-console
```
Launch:
```console
./eppie-console
```
#### Windows
```console
.\eppie-console.exe
```
## Available commands
- **`-?|-h|--help`**
Prints out a list of available commands.
- **`init`**
Initializes the application and creates Eppie account.
- **`reset`**
Resets the application and erases all its data.
- **`open`**
Opens an existing Eppie account.
- **`add-account`**
Adds an email account.
- **`list-accounts`**
Displays a list of accounts.
- **`list-contacts`**
Displays contacts from all accounts.
- **`show-all-messages`**
Shows all messages from all accounts.
- **`show-folder-messages`**
Shows messages from a specific account folder.
- **`show-contact-messages`**
Shows messages for a specific contact.
- **`show-message`**
Shows details of a specific message.
- **`sync-folder`**
Sync messages in specific account folder.
- **`send`**
Sends a message.
- **`restore`**
Restores your Eppie account.
- **`import`**
Imports a key bundle from a file.
- **`exit`**
Closes the application.
## Usage
Here is an example session.
Go to the project folder and run **eppie-console** as described above. Create your local account with `init` command. Create a password and write down your **seed-phrase**. Remember, you will _never_ be able to restore it if you lose it. Also, _never_ share the seed-phrase with anybody.
To clarify, the password protects your local database. The seed-phrase will be your way to access the decentralized account whenever you want to connect a new device to existing account. That is when the decentralized network is launched. Currently decentralized messaging is available on a small testnet, and you cannot connect multiple devices to the same account.
Go ahead and add an email acount with `add-account -t email`. Choose a service and authorize Eppie to access your account in browser. Then fill in IMAP/SMTP settings.
List your connected mailboxes with `list-accounts`. Show all messages with `show-all-messages`.
Next time you log in to Eppie, run `open` command and enter your password.
Send a message with `send -s -r -t `.
## Planned features
As the main project matures more features will be added to this CLI, including but not limited to
- Creating a decentralized Eppie account
- Encrypted p2p messaging
- Connecting multiple devices to single account
- Encrypted decentralized backup
- Connecting existing decentralized identities, e.g. [ENS](https://ens.domains/)
## How to contribute
First of all this is a pretty ambitiois project and we are greateful beyond measure for every bit of help from our community.
If you decide to contribute, please create an issue first, or find an existing one, unless it's a very minor fix, like a typo.
[Here](https://eppie.crowdin.com/eppie) you can help Eppie with localization.
## Background
Eppie is a next generation email and decentralized identity provider. It features open protocol, serverless architecture, cryptocurrency-grade privacy with full account ownership, ease of use, and SMTP-to-web3 messaging capability.
Eppie is developped to store the data using [IPFS](https://github.com/ipfs/ipfs) infrastructure, and the transport layer will work through [SBBS](https://github.com/BeamMW/beam/wiki/Secure-bulletin-board-system-%28SBBS%29). But the architecture allows to easily plug in multiple storage and transport technologies. Eppie's e2e encryption is based on [Elliptic-curve](https://en.wikipedia.org/wiki/Elliptic-curve_cryptography) cryptography. GUI application is being written in C# with [Uno](https://github.com/unoplatform/uno), and CLI is pure C#. Eppie targets Windows, macOS, Linux, iOS, and Android platforms.
[windows-badge]: https://img.shields.io/badge/Windows-blue?logo=windows
[linux-badge]: https://img.shields.io/badge/Linux-gold?logo=linux&logoColor=black
[mac-badge]: https://img.shields.io/badge/macOS-black?logo=apple
[license-badge]: https://img.shields.io/github/license/Eppie-io/Eppie-CLI.svg
[framework-badge]: https://img.shields.io/badge/dynamic/xml?label=framework&query=//TargetFramework[1]&url=https://raw.githubusercontent.com/Eppie-io/Eppie-CLI/main/src/Eppie.CLI/Eppie.CLI/Eppie.CLI.csproj
[release-badge]: https://img.shields.io/github/v/release/Eppie-io/Eppie-CLI
[crowdin-badge]: https://badges.crowdin.net/e/8fee200a40ee70ffd3fa6b7d8d23deee/localized.svg
[build-workflow-badge]:https://img.shields.io/github/actions/workflow/status/eppie-io/eppie-cli/build-and-test.yml?logo=github&branch=main&event=push
[codeql-workflow-badge]: https://img.shields.io/github/actions/workflow/status/eppie-io/eppie-cli/codeql.yml?logo=github&label=CodeQL&branch=main&event=schedule