Rust CLI Utilities

Welcome to the Rust CLI Utilities project! This repository contains a collection of command-line utilities written in Rust, inspired by GNU CLI tools such as echo, ls, and more. It also includes custom utilities developed specifically for this project.

Features

• Rust-based CLI Tools: Utilities similar to standard GNU commands, implemented in Rust for performance and reliability.
• Custom Utilities: Unique tools created to solve specific problems or improve workflows.

Existing Utilities

• r-todolist(dev-v0.1) :r-todolist is a command-line tool for managing tasks and to-do lists, powered by SQLite for serverless database persistence.
• r-echo(dev): echo in rust .
• r-vim(dev): vim minimal clone in rust .
• r-credentials-manager(dev): r-credentials-manager is a command-line tool for managing credentials(usernames and their password) , powered by SQLite for serverless database persistence , credentials are encrypted in the database , you need a master key that unlocks them ,further explanation in future ...

Getting Started

To get started with the Rust CLI Utilities, follow these steps:

Prerequisites

• Rust (including cargo)

Building the Project

1. Clone the Repository:

   git clone https://github.com/your-username/rust-cli-utilities.git
   cd rust-cli-utilities
   // choose your r-utility
   cd r-utility

2. Build the Project:

   cargo build --release

   This will compile the CLI tools and place the binaries in the target/release directory.

Adding the Executable to PATH

To make the CLI tools accessible from anywhere, add the path to the target/release directory to your PATH environment variable.

Temporary Addition (Current Terminal Session Only)

export PATH=$PATH:/path/to/rust-cli-utilities/r-utility/target/release

Replace /path/to/rust-cli-utilities/r-utility with the path to your project directory.

Permanent Addition (All Terminal Sessions)

1. Identify Your Shell Configuration File:

   • Bash: ~/.bashrc or ~/.bash_profile
   • Zsh: ~/.zshrc
   • Fish: ~/.config/fish/config.fish

2. Edit the Configuration File:

   Open the appropriate file with a text editor. For example, for Bash:

   nano ~/.bashrc

   For Zsh:

   nano ~/.zshrc

3. Add the Path to PATH:

   Append the following line to the end of the file:

   export PATH=$PATH:/path/to/rust-cli-utilities/r-utility/target/release

4. Apply the Changes:

   After saving the file, apply the changes by sourcing the file. For example, for Bash:

   source ~/.bashrc

   For Zsh:

   source ~/.zshrc

Usage

After building the project and adding the binaries to your PATH, you can use the CLI tools from any terminal session.

For a list of available commands and their usage, refer to the specific documentation for each tool.

Contributing

Contributions are welcome! Please fork the repository and submit pull requests for any changes or improvements.

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the feature branch.
5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions or feedback, feel free to open an issue on the GitHub repository or contact the project maintainer.

Happy coding!