@radioac7iv/task-manager-cli v0.1.0

Task Manager CLI

A Command-Line Interface (CLI) tool for tracking and managing tasks. This CLI allows users to add, update, delete, list, and mark tasks with ease.

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

1. Clone the repository:

git clone https://github.com/0xRadioAc7iv/task-tracker-cli.git

2. Navigate to the project directory:

cd task-tracker-cli

3. Install dependencies:

npm install

Usage

The CLI tool is invoked using the task command. Below are the available commands and their usage:

Add Task

Add a new task with a description and optional status.

task add <description> [status]

• description: The description of the task.
• status: Optional. The status of the task (e.g., "in-progress").

Example:

task add "Finish the report" "in-progress"

Update Task

Update the description of an existing task.

task update <id> <description>

• id: The ID of the task to update.
• description: The new description for the task.

Example:

task update 1 "Finish the report by Friday"

Delete Task

Delete a task by its ID.

task delete <id>

• id: The ID of the task to delete.

Example:

task delete 1

List Tasks

List all tasks or filter by status.

task list [status]

• status: Optional. Filter tasks by status ("todo", "in-progress", "done").

Example:

task list "todo"

Mark Task

Mark a task's status as either "in-progress" or "done".

task mark <id> <status>

• id: The ID of the task to mark.
• status: The new status for the task ("in-progress" or "done").

Example:

task mark 1 "done"

Contributing

1. Fork the repository
2. Create a new branch:

git checkout -b feature/YourFeature

3. Commit your changes:

git commit -m 'Add new feature'

4. Push to the branch:

git push origin feature/YourFeature

5. Create a new Pull Request

License

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

Project URL (roadmap.sh)

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