README.md

Enclosed CLI

This package contains the CLI for Enclosed, an open-source project that aims to provide a simple and secure way to share e2e encrypted notes.

Getting Started

To install the CLI, run the following command:

Create a note

# Basic usage
enclosed create "Hello, World!"

# Using stdin
cat file.txt | enclosed create

# With full options
enclosed create --deleteAfterReading --password "password" --ttl 3600 "Hello, World!"

Configure the enclosed instance to use

# By default, the CLI uses the public instance at enclosed.cc
enclosed config set instance-url https://enclosed.cc

Usage

enclosed <command> [options]

Create a note

# Basic usage
enclosed create "Hello, World!"

# Using stdin
cat file.txt | enclosed create

# With full options
enclosed create --deleteAfterReading --password "password" --ttl 3600 "Hello, World!"

View a note

# The password will be prompted if the note is password-protected
enclosed view <note-url>

# Or you can provide the password directly
enclosed view --password "password" <note-url>

Configure the enclosed instance to use

# By default, the CLI uses the public instance at enclosed.cc
enclosed config set instance-url https://enclosed.cc

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more information.

Credits and Acknowledgements

This project is crafted with ❤️ by Corentin Thomasset.