mucli 0.1.0

A multi-purposes client line interface: mucli!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# 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.
- Unzip the downloaded file to a preferred location on your machine.
- Navigate to the unzipped folder in your terminal or command prompt.

## Usage

mucli supports several commands and options to cater to your needs. Here are the available commands:

### Set Password

Command to set a security password to access sensitive information.

`mucli password --flag`

#### Flags (one required)

- `-i, --init`: Set a password for the first time.
- `-c, --change`: Change the existing password.
- `-r, --reset` (future release): Reset the password.

#### Password command example usage

```bash
# Set a password for the first time
mucli password -i [optional new_password]

# Change the existing password
mucli password --change [optional current_password]
```

### Encrypt

Command to encrypt a specified file and place the output file in the specified directory.

`mucli encrypt [options] [file_path] [output_dir]`

#### Flags (not required)

- `-u, --ukey`: Update encryption key or update the encryption key of a file to the latest version.
- `-c, --cdir`: Place the output file in the current directory.
- `-s, --sfile`: Select the target file as the output file.

#### Encrypt command example usage

```bash
# Encrypt the file and place the output in the current directory
mucli encrypt -c /path/to/source_file

# Update encryption key of the file
mucli encrypt -u /path/to/source_file

# Update encryption key version
mucli encrypt -u

# Replace file by its encrypted version
mucli encrypt -s /path/to/source_file
```

### Decrypt

Command to decrypt a specified file and place the output file in the specified directory.

`mucli decrypt [options] [file_path] [output_dir]`

#### Flags (not required)

- `-c, --cdir`: Place the output file in the current directory.
- `-s, --sfile`: Select the target file as the output file.

#### Decrypt command example usage

```bash
# Encrypt the file and place the output in the current directory
mucli decrypt -c /path/to/source_file

# Replace file by its encrypted version
mucli decrypt -s /path/to/source_file
```

## 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!