npm package: @snipt/cli
Description: Secure content management with end-to-end encryption
Author: snipt.io
Latest version: 0.0.16

@snipt/cli
==========

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@snipt/cli.svg)](https://npmjs.org/package/@snipt/cli)
[![Downloads/week](https://img.shields.io/npm/dw/@snipt/cli.svg)](https://npmjs.org/package/@snipt/cli)
[![License](https://img.shields.io/npm/l/@snipt/cli.svg)](https://github.com/e2e-tech/cli/blob/master/package.json)

<!-- toc -->
* [Project overview](#project-overview)
* [FAQs](#faqs)
* [Roadmap to v1.0](#roadmap-to-v10)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Project overview

Secure content management with end-to-end encryption.

## Important information for users

This is an early-stage project and as such only provides low-level functionality and APIs at present. Please note the APIs might change before reaching v1.0.

## Basic usage

First, create an account. This will also generate a set of ECC encryption keys associated with your account.

```sh
Alice$ snipt create-account --email "alice@example.com" --name "Alice's personal 👩‍💻" --passphrase "numbingrelatableliquefy"
```

A verification email will be sent to the provided email address. Once you've verified your email, you can start using e2e to manage content securely.

```sh
Alice$ snipt create --from-file "credentials.csv" --passphrase "numbingrelatableliquefy"
{"MessageId":"BhY0TShLng","MessageStatus":"Creating"}
```

You can then read your message.

```sh
Alice$ snipt read BhY0TShLng --passphrase "numbingrelatableliquefy"
```

To list all messages for your account, use the following command.

```sh
Alice$ snipt messages
```

You can share messages with other accounts.

```sh
Alice$ snipt share BhY0TShLng --email "bob@example.com" --name "🕵️‍♂️" --passphrase "numbingrelatableliquefy"
{"MessageGrantId":"JjqKaUpwS0"}
```

The nominated account will receive an email notification that read access has been granted to your message.

They will be able to read your message using the `--grant` option.

```sh
Bob$ snipt read BhY0TShLng --grant
```

Users can view all their grants using the following command.

```sh
Bob$ snipt grants
```

# FAQs

## Why are there account limits in place?

Compute and storage cost money, therefore the most sensible thing to do at the moment is to make sure these costs can be covered when usage exceeds certain parameters.

Currently, users are able to create 10 messages per month and share each message with 1 additional user for free.

Additionally, we offer 2 paid tiers for users who wish to upgrade:

### 1. Personal tier

- 30 messages per month
- 3 grants per message
- Ability to delete messages

Cost: ~ 1 ☕️ per month (please contact support@e2e.sh to subscribe)

### 2. Team tier

- 100 messages per month
- 5 grants per message
- Ability to delete messages
- Ability to set auto-expiry on messages

Cost: ~ 3 ☕️ per month (please contact support@e2e.sh to subscribe)

Please note that there are additional restrictions (rate-limiting and daily request quotas) in place for each user and upgrading to a paid tier does not remove or update them.

## Why do I need to provide my email?

Your email address is used for account-related transactional email only.

We currently use email to verify customers' accounts, and to notify customers of account-related activity such as obtaining access rights to a message.

The only 3rd party we share your email address with is Stripe, however this only applies in the case that you decide to upgrade your account to a paid tier.

## Why are my requests sometimes taking longer than expected?

There may be 2 reasons for this:

1. Currently the API is only deployed in eu-west-2 (London) therefore some users will likely experience longer than usual response times; and
2. The platform is mostly serverless therefore some users might occasionally experience cold starts resulting in longer than usual response times (e.g. ~1 second).

# Roadmap to v1.0

Currently, there is an in-progress quick-and-dirty GitHub project to help track progress against a stable v1.0 release.

See https://github.com/e2e-tech/cli/projects/1 for more details.

# Usage
<!-- usage -->
```sh-session
$ npm install -g @snipt/cli
$ snipt COMMAND
running command...
$ snipt (-v|--version|version)
@snipt/cli/0.0.16 darwin-x64 node-v14.15.0
$ snipt --help [COMMAND]
USAGE
  $ snipt COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`snipt create`](#snipt-create)
* [`snipt create-account`](#snipt-create-account)
* [`snipt grants`](#snipt-grants)
* [`snipt help [COMMAND]`](#snipt-help-command)
* [`snipt messages`](#snipt-messages)
* [`snipt read ID`](#snipt-read-id)
* [`snipt share ID`](#snipt-share-id)

## `snipt create`

create end-to-end encrypted message

```
USAGE
  $ snipt create

OPTIONS
  -c, --curve=curve25519|ed25519|p256|p384|p521|brainpoolP256r1|brainpoolP384r1|brainpoolP512r1|secp256k1
      [default: curve25519] ecc curve name used to generate message keypair

  -f, --from-file=from-file
      path to file

  -n, --name=name
      message display name

  -p, --passphrase=passphrase
      passphrase associated with the account key ring

  --profile=profile
      [default: default] account profile to use

EXAMPLES
  $ snipt create --from-file "keys.csv"
  $ snipt create --from-file "keys.csv" --name "A very secret file indeed 🔒"
  $ snipt create --from-file "keys.csv" --curve "p521" --passphrase "numbingrelatableliquefy"
  $ snipt create --from-file "keys.csv" --profile "personal"
```

_See code: [src/commands/create.js](https://github.com/sniptio/cli/blob/v0.0.16/src/commands/create.js)_

## `snipt create-account`

create an account

```
USAGE
  $ snipt create-account

OPTIONS
  -c, --curve=curve25519|ed25519|p256|p384|p521|brainpoolP256r1|brainpoolP384r1|brainpoolP512r1|secp256k1
      [default: curve25519] ecc curve name used to generate account keypair

  -e, --email=email
      (required) email associated with the account

  -n, --name=name
      [default: LON-158160-C02ZR0Z9MD6W] name associated with the account

  -p, --passphrase=passphrase
      passphrase associated with the account key ring

  --profile=profile
      [default: default] namespace to associate this account configuration with

EXAMPLES
  $ snipt create-account --email "alice@example.com"
  $ snipt create-account --email "alice@example.com" --name "Alice personal 👩‍💻" --passphrase "numbingrelatableliquefy"
  $ snipt create-account --email "alice@example.com" --curve "brainpoolP256r1" --profile "personal"
```

_See code: [src/commands/create-account.js](https://github.com/sniptio/cli/blob/v0.0.16/src/commands/create-account.js)_

## `snipt grants`

list message grants for account

```
USAGE
  $ snipt grants

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --profile=profile       (required) [default: default] account profile to use
  --sort=sort             property to sort by (prepend '-' for descending)
```

_See code: [src/commands/grants.js](https://github.com/sniptio/cli/blob/v0.0.16/src/commands/grants.js)_

## `snipt help [COMMAND]`

display help for snipt

```
USAGE
  $ snipt help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_

## `snipt messages`

list messages for account

```
USAGE
  $ snipt messages

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --profile=profile       (required) [default: default] account profile to use
  --sort=sort             property to sort by (prepend '-' for descending)
```

_See code: [src/commands/messages.js](https://github.com/sniptio/cli/blob/v0.0.16/src/commands/messages.js)_

## `snipt read ID`

fetch and decrypt end-to-end encrypted message

```
USAGE
  $ snipt read ID

ARGUMENTS
  ID  unique message id

OPTIONS
  -g, --grant                  resolve message using an account grant
  -p, --passphrase=passphrase  passphrase associated with account keychain, if any
  --profile=profile            [default: default] account profile to use

EXAMPLES
  $ snipt read nNl0i5ZpMV
  $ snipt read qOWlubPK5p --passphrase "numbingrelatableliquefy"
  $ snipt read xfipgqnRka --grant
  $ snipt read IeBaoboTpW --grant --passphrase "numbingrelatableliquefy"
```

_See code: [src/commands/read.js](https://github.com/sniptio/cli/blob/v0.0.16/src/commands/read.js)_

## `snipt share ID`

share an end-to-end encrypted message with another account

```
USAGE
  $ snipt share ID

ARGUMENTS
  ID  unique message id

OPTIONS
  -e, --email=email            account email to share message with
  -n, --name=name              message grant display name
  -p, --passphrase=passphrase  passphrase associated with account keychain, if any
  -u, --url                    create a one time grant url
  --profile=profile            [default: default] account profile to use

EXAMPLES
  $ snipt share nNl0i5ZpMV --email "bob@example.com"
  $ snipt share qOWlubPK5p --email "bob@example.com" --name "🕵️‍♂️" --passphrase "numbingrelatableliquefy"
  $ snipt share nNl0i5ZpMV --url
  $ snipt share nNl0i5ZpMV --url --passphrase "numbingrelatableliquefy"
```

_See code: [src/commands/share.js](https://github.com/sniptio/cli/blob/v0.0.16/src/commands/share.js)_
<!-- commandsstop -->