README.md

TASK-CLI

A Python-based command-line task management system that helps you organize and track tasks

Table of Contents

• Overview
• Features
• Project Structure
• Getting Started
  • Prerequisites
  • Installation
  • Usage
• Contributing
• License

---

Overview

Task-CLI is a command-line interface tool for managing tasks efficiently. Tasks are stored in a JSON file and can be easily managed through various commands. The application provides a simple yet powerful way to track your tasks' status and progress.

---

Features

• Task Creation & Management: Create, update, and delete tasks
• Status Tracking: Mark tasks as todo, in-progress, or done
• Persistent Storage: All tasks are stored in a JSON file
• Filtering: List tasks by status
• Command-line Interface: Easy to use CLI with intuitive commands

---

Project Structure

task-manager/
├── main.py
├── tasks.json
├── README.md
└── LICENSE

Project Index

TASK-CLI/

__root__

main.py	Core application logic for task management
tasks.json	JSON storage for task data

---

Getting Started

Prerequisites

• Python 3.x installed
• No additional dependencies required - uses Python standard library

Installation

1. Clone the repository:

❯ git clone https://github.com/p-nelly/task-cli.git

2. Navigate to the project directory:

❯ cd task-cli

Usage

The task manager supports the following commands:

Add a new task:

❯ python main.py add "Task description"

Update a task:

❯ python main.py update <task_id> "New description"

Delete a task:

❯ python main.py delete <task_id>

Mark task status:

❯ python main.py mark-in-progress <task_id>
❯ python main.py mark-done <task_id>

List tasks:

❯ python main.py list              # List all tasks
❯ python main.py list todo        # List only todo tasks
❯ python main.py list in-progress # List only in-progress tasks
❯ python main.py list done        # List only completed tasks

---

Contributing

• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests.
• Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine.
3. Create a New Branch: Always work on a new branch.
4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.
6. Push to GitHub: Push the changes to your forked repository.
7. Submit a Pull Request: Create a PR against the original project repository.

---

License

This project is licensed under the MIT License. For more details, refer to the LICENSE file.

---

Roadmap.sh project

This project was created for roadmap.sh

https://roadmap.sh/projects/task-tracker

---