CLI Todo App is a slim, basic, and easy-to-use command-line tool designed to help you manage your tasks efficiently right from your terminal. Built with Rust, this lightweight application is ideal for developers who prefer working in terminal-based environments, especially those using tools like tmux
and nvim
.
- Slim and Lightweight: No unnecessary bells and whistles—just a simple, focused tool to manage your to-do lists.
- Rust-Powered: Fast and reliable performance, with minimal system overhead.
- Ideal for Terminal Enthusiasts: Seamlessly integrates with
tmux
,nvim
, or any other terminal-based workflow.
If you spend most of your time in a terminal, switching between multiple applications can be a hassle. With CLI Todo App, you can manage your tasks without leaving your development environment, keeping you in the flow and boosting your productivity.
Using the app is very easy. You only have to remember 4 operations.
Use ' ' to add a new todo. e.g write rust app
Use '*' to mark toggle todo status. e.g *rust
Use '-' to delete a todo. e.g -rust
Use '!' to quit the app.
The todos will be persisted in a file when closing.
Ensure you have Rust installed. If not, you can easily install it using the following command:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
To install the app directly using Cargo, run the following command:
cargo install --git https://github.com/alihanekiz/todo_app
If you prefer to build the app from source, follow these steps:
- Clone the repository:
git clone https://github.com/alihanekiz/todo_app.git
- Navigate to the project directory:
cd todo_app
- Build the project using Cargo:
cargo build --release
- Move the compiled binary to a directory in your PATH:
mv target/release/todo_app /usr/local/bin/
I welcome contributions to CLI Todo App! If you'd like to contribute, please follow these steps:
-
Fork the Repository: Click the "Fork" button at the top right corner of this repository page to create a copy of this repository under your GitHub account.
-
Clone Your Fork: Clone your forked repository to your local machine.
-
Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b feature-name
-
Make Your Changes: Implement your changes in the codebase.
-
Commit Your Changes: Commit your changes with a meaningful commit message.
git add . git commit -m "Add feature-name or Fix issue with XYZ"
-
Push to Your Fork: Push your changes to your forked repository.
git push origin feature-name
-
Create a Pull Request: Go to the original repository on GitHub and create a pull request (PR) from your forked repository’s branch to the
main
branch of the original repository.