bitmask-cli 0.1.0

A CLI tool for manipulating individual bits using commands like SET, CLEAR, TOGGLE, CHECK.
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

# 🧮 Bitmask CLI


A fast and simple **command-line utility** for performing bitwise operations (`SET`, `CLEAR`, `TOGGLE`, `CHECK`) on individual bits of a byte (0–255).
Perfect for learning, debugging, or manipulating binary values.

![GitHub](https://img.shields.io/github/license/theolodocoder/bitmask-cli)
![Crates.io](https://img.shields.io/crates/v/bitmask-cli)
![Rust Version](https://img.shields.io/badge/rust-1.70+-blue.svg)

---

## 🚀 Features


- ✅ Set, clear, toggle, and check individual bits
- 🔢 Accepts decimal or binary numbers (`u8`)
- 📦 Easily installable via `cargo install`
- 📜 Help command and built-in usage guide
- 🧪 Fully tested with unit tests

---

## 📦 Installation


### From [crates.io](https://crates.io/crates/bitmask-cli)


```bash
cargo install bitmask-cli
```

### Or from GitHub


```bash
cargo install --git https://github.com/theolodocoder/bitmask-cli
```

---

## ⚙️ Usage


```bash
bitmask-cli --command <COMMAND> --number <NUMBER> --bit-index <INDEX>
```

### Options:


| Flag                | Description                                     |
| ------------------- | ----------------------------------------------- |
| `-c`, `--command`   | Operation: `set`, `clear`, `toggle`, or `check` |
| `-n`, `--number`    | A decimal (0–255) byte value                    |
| `-b`, `--bit-index` | Bit index to manipulate (0–7)                   |

---

## 📘 Examples


```bash
bitmask-cli --command set --number 8 --bit-index 3
# Output:

# Original: 00001000 (8)

# Command: Set bit (3)

# Result: 00001000 (8)


bitmask-cli -c toggle -n 8 -b 3
# Result: 00000000 (0)


bitmask-cli -c check -n 8 -b 3
# Bit is set: true

```

---

## 💡 What Are Bitmasks?


Bitmasking is the technique of using bitwise operations to read or manipulate specific bits in a byte. For example:

- `SET`: Turns a bit to `1`
- `CLEAR`: Turns a bit to `0`
- `TOGGLE`: Flips a bit from `1` to `0` or `0` to `1`
- `CHECK`: Checks whether a bit is `1`

---

## 🧪 Running Tests


To run tests:

```bash
cargo test
```

---

## 🤝 Contributing


Pull requests, bug reports, and ideas are welcome!
If you're new to open source, this is a great project to get started with Rust.

---

## 📄 License


This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.

---

## ✨ Author


Made with ❤️ by [Your Name](https://github.com/theolodocoder)