CLTools provides various tools and command to use in the terminal.

Overview

#CLTOOLS

About

CLTools provides various tools and command to use in the terminal. As of date, CLTools is only able to generate temporary email addresses and receive emails. There are plans to integrate more tools and options in the future.

CLTools allows for the user to easily generate new emails on the fly to increase privacy, combat spam, and browse the internet in a safer manner. Documentation on the commands can be found below. Additionally, there are screenshots and gifs provided to visually understand how CLTools works.

Continuing Development

CLTools is an ongoing project with the intent of being forked and modified. If you wish to contribute or continue development, you are encouraged to fork the repository and continue development as you see fit. All dependencies are listed below and are included in the virtual environment.

Please read the CLTools Design document as that contains information about everything in the project to get you up to speed. If you run into an error, feel free to create an issue or resolve it on your own.

Dependencies and Tools

CLTools was made with the help of the following libraries and modules:

  1. Python 3.9 - CLTools was developed in Python 3.9 so any version of Python before 3.9 may be unsupported.
  2. onesecmail by yyyyyyan -- CLTools uses the onesecmail library wrapper developed by yyyyyyan.
  3. pickle -- CLTools uses the pickle library to serialize data for persistence.
  4. hashlib -- CLTools uses the Hashlib library to SHA1 encode various data
  5. lzma -- CLTools uses the LZMA library to pack all stored files on the hard drive with the exceptions of attachments that are downloaded.

Installation and Usage

CLTools is compiled with PyInstaller so python is not needed to run clmail. Simply installing the binary in a directory known in your computer's PATH variable, will allow you to run clmail from any directory at any time. If not, you can store the binary where you see fit, cd to that directory and run the command:

./clmail [command here]

If you have the binary saved in a directory pointed to in your computer's PATH variable, you can run the program by simply opening your terminal and typing:

clmail [command here]

Commands

create

clmail create

create generates a new temporary email address. If this is the first or only existing email address generated, then the address returned by create will automatically become the current email address to which you can interact with. To change the current mailbox or email address, you can use the set-curr command (Scroll down for more information.)

ls

clmail ls [-all | -active | -cached]

In the spirit of open source, commands are based off of the linux filesystem. LS will output all email addresses/mailboxes of the specified type. There are three type specifications:

  1. -all : Returns all email addresses/mailboxes that have been created and not deleted
  2. -active: Returns all active email addresses/mailboxes that have been created and never deleted. Active mailboxes will have their messages fetched from the server.
  3. -cached: Returns all cached or inactive email addresses/mailboxes that have never been deleted. Cached email addresses will never have their messages be fetched by the server due to the high probability that such email addresses no longer exist. Consequently, any emails received once said email addresses are cached will not be accessible from CLTools.

Cached email addresses are kept should the user need to refer back to a message that would otherwise be no longer retrievable. Active and cached email addresses or mailboxes can be deleted with the rm command. (See below for details.)

set-curr

clmail set-curr [ID OF MAILBOX]

Because certain commands only operate with respect to the current mailbox (ls-messages, cat, pull, curr), it is useful to be able to switch between the current mailbox. The ID of the mailbox passed it is the ID shown by the ls command. Just like Git, you do not need to enter in the whole ID but just the first few characters that are enough to distinguish the ID. If there are two ID with the first same set of characters that you enter, one of the two will be selected according to Python's internal iterator implementation. set-curr enables the user to switch between all mailboxes, cached or active.

ls-messages

clmail ls-messages

ls-messages will list out all received emails in the current mailbox. The user will be given information regarding the message id, subject, date, and sender. From this command, the user may select a specific message from its message id.

cat

clmail cat [MESSAGE-ID] (-v OPTIONAL)

cat will output the contents of a message within the current mailbox. Unlike set-curr, the ID of the message must be completely specified -- shortcuts will not work. Cat will search for the message by its ID in the current mailbox and output the contents if found. Additionally, the user may set the verbose flag by appending '-v' to the command after the message id to output the html-text alongside all text embedded within the email. Cat works for all messages, cached or active, as long as they are in the mailbox and are visible from the ls-messages command.

pull

clmail pull [MESSAGE-ID]

pull will download all attachments within the specified message. Like cat, the full message id must be specified. This command should rarely be used since all attachments of messages are downloaded automatically. All attachments can be found at the source directory of this program in the Downloads folder. The Downloads directory is organized as follows:

Downloads/
    EmailID+EmailAddress/
        Attachment1
        Attachment2

rm

clmail rm [MAILBOX-ID]

rm is a destructive command. rm will remove all mailbox data specified by the mailbox id if the mailbox exists. Like set-curr, the ID can be truncated so that only a few characters are needed to determine a unique mailbox. rm will remove all downloaded attachments, all messages, and clear up all data related to the mailbox specified. rm will delete all mailboxes, cached or active. Use with caution.

curr

clmail curr

curr will simply output the current mailbox. The user will be given the mailbox id and address.

You might also like...
bsp_tool provides a Command Line Interface for analysing .bsp files

bsp_tool Python library for analysing .bsp files bsp_tool provides a Command Line Interface for analysing .bsp files Current development is focused on

img-proof (IPA) provides a command line utility to test images in the Public Cloud

overview img-proof (IPA) provides a command line utility to test images in the Public Cloud (AWS, Azure, GCE, etc.). With img-proof you can now test c

A useful and easy to use Terminal Timer made with Python.
A useful and easy to use Terminal Timer made with Python.

Terminal SpeedCubeTimer Installation Β‘No requirements! Just Download and play Usage Starts timer.py and you will see this. python timer.py Scramble

πŸ‘» Ghoul is an easy to use information service, allowing you to get/add information on someone or something directly from your terminal.
πŸ‘» Ghoul is an easy to use information service, allowing you to get/add information on someone or something directly from your terminal.

πŸ‘» Ghoul is an easy to use information service, allowing you to get/add information on someone or something directly from your terminal. It c

Easy-to-use terminal program that can compile your code.

Description Easy-to-use terminal program that can compile your code. Installition 1. Cloning repository $ git clone https://github.com/DarkJoij/Compil

A terminal tool for git. When we use git, do you feel very uncomfortable with too long commands
A terminal tool for git. When we use git, do you feel very uncomfortable with too long commands

PIGIT A terminal tool for git. When we use git, do you feel very uncomfortable with too long commands. For example: git status --short, this project c

 Use case: quick JSON processing/restructuring with jq without terminal
Use case: quick JSON processing/restructuring with jq without terminal

alfred-jq Alfred workflow to conveniently process JQ on clipboard based on a jq query Also available at: packal/jq Use case: quick JSON processing/res

Todo - You could use terminal to set your todo
Todo - You could use terminal to set your todo

Python Tutorial You can learn how to build a terminal application(CLI applicatio

A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Stream your favorite shows straight from the command line.

A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Installation pip install -r requirements.txt It use

Releases(clmail)
Owner
Ashwin Chugh
Self-inspired high school programmer interested in AI/Machine Learning, desktop and mobile app development, and game design.
Ashwin Chugh
img-proof (IPA) provides a command line utility to test images in the Public Cloud

overview img-proof (IPA) provides a command line utility to test images in the Public Cloud (AWS, Azure, GCE, etc.). With img-proof you can now test c

13 Jan 07, 2022
A simple cli utility for importing or exporting dashboard json definitions using the Grafana HTTP API.

P4CMD 🌴 A Python Perforce package that doesn't bring in any other packages to work. Relies on p4cli installed on the system. p4cmd The p4cmd module h

Beam Connectivity 31 Jan 06, 2023
This is a CLI utility that allows you to view RedFlagDeals.com on the command line.

RFD Description Motivation Installation Usage View Hot Deals View and Sort Hot Deals Search Advanced View Posts Shell Completion bash zsh Description

Dave G 8 Nov 29, 2022
CLI utility to search and download torrents from major torrent sites

CLI Torrent Downloader About CLI Torrent Downloader provides convenient and quick way to search torrent magnet links (and to run associated torrent cl

x0r0x 86 Dec 19, 2022
dotfilery, configuration, environment settings, automation, etc.

β”Œβ”¬β”β”Œβ”€β”β”Œβ”€β”β”Œβ”€β”β”¬ β”¬β”Œβ”¬β”β”¬ β”¬β”¬β”Œβ”€β” β”‚β”‚β”‚β”œβ”€ β”‚ β”¬β”œβ”€β”€β”‚ β”‚ β”‚ β”œβ”€β”€β”‚β”‚ :: bits & bobs, dots & things. β”΄ β”΄β””β”€β”˜β””β”€β”˜β”΄ β”΄β”΄β”€β”˜β”΄ β”΄ β”΄ β”΄β”΄β””β”€β”˜ @megalithic πŸš€ Instal

Seth Messer 89 Dec 25, 2022
Python CLI vm manager for remote access of docker images via noVNC

vmman is a tool to quickly boot and view docker-based VMs running on a linux server through noVNC without ssh tunneling on another network.

UCSD Engineers for Exploration 1 Nov 29, 2021
A simple web-based SSH client.

Kommander A simple web-based SSH client. It supports: entering SSH login details (including private key and custom ports) and connecting user authenti

KingWaffleIII 2 Jan 01, 2022
This is a repository for collecting global custom management extensions for the Django Framework.

Django Extensions Django Extensions is a collection of custom extensions for the Django Framework. Getting Started The easiest way to figure out what

Django Extensions 6k Jan 03, 2023
A selfbot made with DPY, doesn't have much commands but there's some useful commands to use.

Phantom Selfbot A selfbot made in DPY, made by Zenith. How to use Add your token in token = 'YOUR-MOMS-TOKEN-HERE' Change the prefix in prefix = If

[Ͼ⁴] ơephyr 2 Dec 02, 2021
Convert ACSM files to DRM-free EPUB files with one command on Linux

Knock Convert ACSM files to DRM-free EPUB files using one command. This software does not utilize Adobe Digital Editions nor Wine. It is completely fr

Benton Edmondson 622 Dec 09, 2022
Logic-Sim - A clone of 'Digital Logic Sim' from Sebastian Lague

Logic Simulator This is a clone of 'Digital Logic Sim' from Sebastian Lague. But

Ethan 1 Feb 01, 2022
A simple command line tool for changing the icons of folders or files on MacOS.

Mac OS File Icon Changer Description A small and simple script to quickly change large amounts or a few files and folders icons to easily customize th

Eroxl 3 Jan 02, 2023
Wordle-solver - A tool that helps people who struggle with vocabulary to enjoy the famous game of WORDLE

Wordle-Solver Wordle-Solver helps people who struggle with vocabulary to enjoy t

Jason Chao 104 Dec 31, 2022
A simple python application for running a CI pipeline locally

A simple python application for running a CI pipeline locally This app currently supports GitLab CI scripts

Tom Stowe 0 Jan 11, 2022
A tool to automatically convert old string literal formatting to f-strings

flynt - string formatting converter flynt is a command line tool to automatically convert a project's Python code from old "%-formatted" and .format(.

Elijah K 551 Jan 06, 2023
Command line tool for monitoring changes of File entities scoped in a Synapse File View

Synapse Monitoring Provides tools for monitoring and keeping track of File entity changes in Synapse with the use of File Views. Learn more about File

Sage Bionetworks 3 May 28, 2022
A python Ethereum utilities command-line tool.

peth-cli A python Ethereum utilities command-line tool. After wasting the all day trying to install seth and failed, I took another day to write this.

Moon 55 Nov 15, 2022
A simple CLI to convert snapshots into EAVT log, and EAVT log into SCD.

EAVT helper CLI Simple CLI to convert snapshots into eavt log, and eavt log into slowly changing dimensions Usage Installation Snapshot to EAVT log EA

2 Apr 07, 2022
Apple Silicon 'top' CLI

asitop pip install asitop What A nvtop/htop style/inspired command line tool for Apple Silicon (aka M1) Macs. Note that it requires sudo to run due to

Timothy Liu 1.2k Dec 31, 2022
Rdwcli - Car list cli app with python

Rdwcli - Car list cli app with python

Arie Twigt 1 Feb 02, 2022