🧮 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.

🚀 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

cargo install bitmask-cli

Or from GitHub

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

⚙️ Usage

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

Options:

📘 Examples

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:

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 for details.

✨ Author

Made with ❤️ by Your Name