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
Simple CLI interface for linear task manager

Linear CLI (Unmaintained) Simple CLI interface for linear task manager Usage Install: pip install linearcli Setup: Generate a pe

Mike Lyons 1 Jan 07, 2022
🌍 Harness the power of whatsmydns from the command-line.

chkdns Harness the power of whatsmydns from the command-line. Installing with pip pip install chkdns Run chkdns --host github.com Alternatively you ca

Craig Gumbley 3 Oct 29, 2022
Shazam is a Command Line Application that checks the integrity of the file by comparing it with a given hash.

SHAZAM - Check the file's integrity Shazam is a Command Line Application that checks the integrity of the file by comparing it with a given hash. Crea

Anaxímeno Brito 1 Aug 21, 2022
A minimalist Vim plugin manager.

A minimalist Vim plugin manager. Pros. Easy to set up: Single file. No boilerplate code required. Easy to use: Concise, intuitive syntax Super-fast pa

Junegunn Choi 30.2k Jan 08, 2023
🗃️ Fileio-cli wrapper for fileioapi.py with fire.py, inspiration DOS

🗃️ File.io File.io simply upload a file, share the link, and after it is downloaded, the file is completely deleted. An API wrapper for the file.io w

nkot56297 2 May 12, 2022
🎈 `st` is a CLI to quickly kick-off your new Streamlit project

🎈 st - a friendly Streamlit CLI st is a CLI that helps you kick-off a new Streamlit project so you can start crafting the app as soon as possible! Ho

Arnaud 18 Dec 19, 2022
A Python-based Wordle solver and CLI player

Wordle A Python-based Wordle solver and CLI player This was created using Python 3.9.7. SPOILER ALERT: the data directory contains spoilers for upcomi

Will Fitzgerald 1 Jul 24, 2022
Multifunctional library for creating progress bars.

👋 Content Installation Using github Using pypi Quickstart Flags Useful links Documentation Pypi Changelog TODO Contributing FAQ Bar structure ⚙️ Inst

DenyS 27 Jan 01, 2023
Palm CLI - the tool-belt for data teams

Palm CLI: The extensible CLI at your fingertips Palm is a universal CLI developed to improve the life and work of data professionals. Palm CLI documen

Palmetto 41 Dec 12, 2022
The most comprehensive, exhaustive, parameterized command-line wordle solver.

Wordle Solver The most comprehensive, exhaustive, parameterized command-line wordle solver. Wordle is a real

Debarghya Das 27 Nov 21, 2022
Tools hacking termux in the name ant-attack

Hello friends, I am ama.player0000. Web developer, software, Android command line (termux). (1)=Well, ant-attack tool is a tool to attack sites and disable them. (2)=You can use those CCTV servers, s

༺AMA.PLAYER༻ 1 Dec 17, 2021
PyDropper - pick colors everywhere

PyDropper - pick colors everywhere Downloads Settings PyDropper is an eyedropper

Herman Brunberg 2 Jan 04, 2022
Management commands to help backup and restore your project database and media files

Django Database Backup This Django application provides management commands to help backup and restore your project database and media files with vari

687 Jan 04, 2023
A command line application, written in Python, for interacting with Spotify.

spotify-py-cli A command line application, written in Python, for interacting with Spotify. The primary purpose behind developing this app was to gain

Drew Loukusa 0 Oct 07, 2021
A fantasy life simulator and role-playing game hybrid distributed as CLI, written in Python 3.

Life is Fantasy Epic (LIFE) A fantasy life simulator and role-playing game hybrid distributed as CLI, written in Python 3. This repository will be pro

Pawitchaya Chaloeijanya 2 Oct 24, 2021
A simple file transfer tools, similar to rz / sz but compatible with tmux (control mode), which works with iTerm2 and has a nice progress bar

trzsz A simple file transfer tools, similar to rz/sz but compatible with tmux (control mode), which works with iTerm2 and has a nice progress bar. Why

561 Jan 05, 2023
Limit your docker image size with a simple CLI command. Perfect to be used inside your CI process.

docker-image-size-limit Limit your docker image size with a simple CLI command. Perfect to be used inside your CI process. Read the announcing post. I

wemake.services 102 Dec 14, 2022
A Neat Application To Manage Your To-Do Lists.

WTD - What To Do? A Neat Application To Manage Your To-Do Lists. One folder can only have one to-do file. Running wth without any subcommands executes

Adam Vajda 1 Oct 24, 2021
Terminal-based keyboard testing

kbdtest kbdtest is a simple Python program that tests keyboard input using an interactive, terminal-based, visual keyboard display. It was originally

Ruunyox 12 Jul 19, 2022
Convert markdown to HTML using the GitHub API and some additional tweaks with Python.

Convert markdown to HTML using the GitHub API and some additional tweaks with Python. Comes with full formula support and image compression.

phseiff 70 Dec 23, 2022