r2todo

README

r2todo 📝

---

r2todo is a simple and efficient command-line TODO application that keeps you focused by managing your tasks in a CSV file. It's designed to be quick to operate and free from internet-based distractions, ensuring that you own your data. 🚀

Features ✨

• Manage TODO items with ease. ✅
• Store tasks in a CSV file. 📂
• No internet distractions—keep your data private. 🔒

Installation 🔧

To install r2todo, you can build it from source using Go. Make sure you have Go installed on your machine.

1. Clone the repository:

   git clone https://github.com/IamMuuo/r2todo.git
   

2. Navigate to the project directory:

   cd r2todo
   

3. Build the application:

   go build -o r2todo
   

4. Move the binary to a directory in your PATH:

   mv r2todo /usr/local/bin/
   

   Adjust the path as necessary based on your operating system and environment.

Usage 🛠️

Run r2todo [command] to interact with the application. Here’s a brief overview of available commands:

• complete: Toggles the completion status of a TODO item. ✔️
• completion: Generate the autocompletion script for the specified shell. 🖥️
• create: Creates a new TODO item. ✏️
• delete: Deletes a TODO item from the CSV file. ❌
• help: Displays help about any command. ❓
• list: Lists all currently saved TODO items. 📋

Flags 🚩

• -a, --delete-all: Specifies whether to delete all TODO items. 🗑️
• -d, --description string: The description of the TODO item. 📝
• -h, --help: Displays help information. ❓
• -i, --task-id int: The ID of the TODO item. 🔢

Examples 💡

• List all TODO items:

  r2todo list
  

• Create a new TODO item:

  r2todo create --description "Finish the report"
  

• Complete a TODO item:

  r2todo complete --task-id 1
  

• Delete a TODO item:

  r2todo delete --task-id 1
  

• Delete all TODO items:

  r2todo delete --delete-all
  

Autocompletion ⌨️

To enable shell autocompletion for r2todo, use the completion command to generate the script for your shell. For example:

r2todo completion bash > /etc/bash_completion.d/r2todo

Supported Shells 🌟

• Bash
• Zsh
• Fish

Contributing 🤝

Contributions are welcome! If you have suggestions, bug reports, or would like to contribute code, please follow these steps:

Fork the repository. 🍴
Create a new branch for your feature or fix. 🌿
Make your changes and test them thoroughly. 🛠️
Submit a pull request with a clear description of your changes. 📝

License

• Licensed under the Apache License see License for more info

Questions? 🤔

If you have any questions or need further clarification, feel free to open an issue on GitHub or contact the project maintainers.

---

Enjoy managing your tasks with r2todo! 🎉

Documentation

Overview

Copyright © 2024 Erick Muuo hearteric57@gmail.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.