Skip to content

Latest commit

 

History

History
92 lines (75 loc) · 3.07 KB

README.md

File metadata and controls

92 lines (75 loc) · 3.07 KB
Raw

TaskCLI 📋

Effortlessly manage your tasks right from the command line!
Created by Amosnimos

Overview

banner

TaskCLI is a simple, lightweight Python-based tool to manage tasks in your terminal. Add, remove, view, and edit tasks with ease, keeping everything organized and available directly from the command line.

Features

  • Add New Tasks: Quickly add tasks with descriptions.
  • View All Tasks: Displays all tasks, organized by date.
  • Edit Task Descriptions: Easily update the details of any task.
  • Remove Tasks: Remove tasks by index or delete all tasks in one go.

Installation

Clone the repository and navigate into the directory: 

git clone https://github.com/Amosnimos/TaskCLI.git
cd TaskCLI

Make sure you have Python 3 installed, then you're ready to go!

Usage

Here’s how you can use TaskCLI:

python task.py add "Your new task"       # Add a new task
python task.py remove <index>            # Remove a task by index
python task.py remove all                # Remove all tasks
python task.py edit <index>              # Edit a task description
python task.py                           # View all tasks
python task.py -h or --help              # Show help

Examples

  • Adding a Task: 
    python task.py add "Finish report"
  • Viewing Tasks: 
    python task.py
  • Editing a Task: 
    python task.py edit 2
    Displays the current description and prompts for an update.
  • Removing a Task: 
    python task.py remove 1
    Removes the task at index 1. Use remove all to clear the list.

Why TaskCLI?

TaskCLI is a minimalist’s dream for terminal task management. It’s designed for those who want a fast, distraction-free way to handle their to-do lists right in the terminal.

Future Improvements

  • Priority-based colors: Easily spot important tasks.
  • Date-based filters: Focus on tasks due soon.
  • Export Options: Export tasks to plain text or CSV.

License

TaskCLI is licensed under the GNU Affero General Public License v3.0. You are free to use, modify, and share this tool as per the terms of this license.

Requirements

TaskCLI requires Python 3.x and works on any system with Python installed.

Contributing

Pull requests and suggestions are welcome! Feel free to improve TaskCLI, add features, or report issues on GitHub.

Happy tasking! 🎉