Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devyatsu/mucli
mucli (Multi Use Command Line Interface) is a tool for file encryption/decryption, secure passwords storing and more...
https://github.com/devyatsu/mucli
Last synced: about 14 hours ago
JSON representation
mucli (Multi Use Command Line Interface) is a tool for file encryption/decryption, secure passwords storing and more...
- Host: GitHub
- URL: https://github.com/devyatsu/mucli
- Owner: DevYatsu
- License: mit
- Created: 2023-07-18T01:42:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-29T10:56:45.000Z (over 1 year ago)
- Last Synced: 2023-07-29T11:42:38.976Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 58.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mucli (Multi Use Command Line Interface)
mucli is a versatile command-line tool offering various functionalities, including file encryption/decryption, secure password storage, and more. It provides a user-friendly interface to perform different tasks efficiently.
## Installation
To use mucli, follow these steps:
- [Download the latest](../../releases) release for your operating system.
- Follow instructions in the release section
## Usage
mucli supports several commands and options to cater to your needs. Commands can sometimes need admin access to be executed. Here are the available commands:
### Set Password
Command to set a security password to access sensitive data.
`mucli password --flag`
```bash
# Set a password for the first time
mucli password -i [optional new_password]
# Change the existing password
mucli password --change [optional current_password]
# Reset the password by answering a set of questions (future release)
mucli password --reset
# Add and remove questions you will have to answer to reset your password
mucli password --modifyQ [optional current_password]
```
### Encrypt
Command to encrypt a specified file and place the output file in the specified directory.
```bash
# Encrypt the file and place the output in the specified directory
mucli encrypt /path/to/source_file /path/to/output_dir
# Encrypt the file and place the output in the current directory
mucli encrypt -c /path/to/source_file
# Update the encryption key of the file
mucli encrypt -u /path/to/source_file
# Update encryption key version
mucli encrypt -u
# Replace the file by its encrypted version
mucli encrypt -s /path/to/source_file
# Encrypt the file 5 times
mucli encrypt -t 5 /path/to/source_file
```
### Decrypt
Command to decrypt a specified file and place the output file in the specified directory.
```bash
# Decrypt the file and place the output in the specified directory
mucli decrypt /path/to/encrypted_file /path/to/output_dir
# Decrypt the file and place the output in the current directory
mucli decrypt -c /path/to/encrypted_file
# Replace the file by its decrypted version
mucli decrypt -s /path/to/encrypted_file
# Decrypt the target file until it's totally decrypted,
# useful when crypted several times
mucli decrypt -e /path/to/encrypted_file
```
### Rename
Command to rename a file.
```bash
mucli rename [FILEPATH] [NAME]
```
### Copy
Command to copy a file's content into another existing or non-existing file or into a directory.
```bash
mucli copy [FILEPATH] [TARGET]
```
### Move
Command to move a file into a directory.
```bash
mucli move [FILEPATH] [DIR]
```
### Zip
Command to compress the specified file/folder and place the output zip file in the specified directory.
```bash
# Compress the file/folder and place the output in the same directory as the source
mucli zip [PATH]
# Compress the file/folder and place the output in the specified directory
mucli zip [PATH] [OUTPUTDIR]
# Compress the file/folder and place the output in the current directory
mucli zip -c [PATH]
# Compress with a specified compression level (0 to 9)
mucli zip -l [LEVEL] [PATH]
```
### Unzip
Command to extract the specified zip file and place the output file/folder in the specified directory.
```bash
# Compress the file/folder and place the output in the same directory as the source
mucli zip [PATH]
# Compress the file/folder and place the output in the specified directory
mucli zip [PATH] [OUTPUTDIR]
# Compress the file/folder and place the output in the current directory
mucli zip -c [PATH]
```
### Shell
Command to execute a shell script.
```bash
mucli shell [FILEPATH]
```
### Qrcode
Command to generate a qr-code for a given string/url.
```bash
mucli qrcode [STRING]
mucli qrcode "https://github.com/DevYatsu/mucli/"
```
### Antivirus
Command to check for malwares in a given file, using the virustotal API.
```bash
mucli antivirus [FILEPATH]
```
The `antivirus` command returns:
- Malicious threats detected: Number of engine reports indicating that the file is malicious.
- Suspicious threats detected: Number of engine reports indicating that the file is suspicious.
### Timer
Command to use a simple timer.
```bash
mucli timer
```
### Update (still in development)
Command to check if a new update of mucli is available (coming soon).
```bash
mucli update
```
## Ideas of commands to implement in the future
- "dictionary": Develop a command-line dictionary tool to look up word definitions, synonyms, and antonyms.
- "translator": Implement a command to translate text between different languages using popular translation APIs.
- "random": Create a command to generate random numbers, passwords, or strings.
- "calculator": Implement a command-line calculator capable of performing basic arithmetic and advanced mathematical operations.
- "weather": Implement a command to display weather forecasts and current conditions for a specified location.
## Feedback and Contributions
We welcome your feedback and contributions to improve mucli. If you encounter any issues or have suggestions for new features, please feel free to open an [issue](../../issues) on our GitHub repository.
Happy command-line multitasking with mucli!