@keshavashiya/task v0.0.2
Task CLI
Task CLI is a command-line tool for managing tasks. You can add, update, delete, mark tasks as in-progress or done, and list tasks with different statuses https://roadmap.sh/projects/task-tracker.
Installation
Clone the repository:
git clone https://github.com/keshavashiya/task_tracker_cli cd task_tracker_cliInstall the dependencies:
npm installMake the CLI executable globally:
npm link
Usage
Adding a New Task
To add a new task, use the
addcommand followed by the task title:task add "Buy groceries" # Output: Task added successfully (ID: 1)Updating a Task
To update an existing task, use the
updatecommand followed by the task ID and the new title:task update 1 "Buy groceries and cook dinner" # Output: Task updated successfully (ID: 1)Deleting a Task
To delete a task, use the
deletecommand followed by the task ID:task delete 1 # Output: Task deleted successfully (ID: 1)Marking a Task as In Progress
To mark a task as in progress, use the
mark-in-progresscommand followed by the task ID:task mark-in-progress 1 # Output: Task marked as in progress (ID: 1)Marking a Task as Done
To mark a task as done, use the
mark-donecommand followed by the task ID:task mark-done 1 # Output: Task marked as done (ID: 1)Listing All Tasks
To list all tasks, use the
listcommand:task list # Output: [ { id: 1, title: 'Buy groceries', status: 'todo' }, ... ]Listing Tasks by Status
To list tasks by a specific status, use the
listcommand followed by the status(done, todo, in-progress):task list done # Output: [ { id: 1, title: 'Buy groceries', status: 'done' }, ... ] task list todo # Output: [ { id: 2, title: 'Clean the house', status: 'todo' }, ... ] task list in-progress # Output: [ { id: 3, title: 'Write report', status: 'in-progress' }, ... ]
Project Structure
task_tracker_cli/
│
├── bin/
│ └── index.js # Entry point for the CLI
│
├── src/
│ ├── commands/
│ │ ├── commands.js # Command implementations
│ │ └── tasks.json # JSON file to store tasks
│ └── logger.js # Logger implementation
│
│
├── package.json # Project metadata and dependencies
│
└── README.md # Project documentationContributing
Contributions are welcome! Please open an issue or submit a pull request.
License
This project is licensed under the MIT License.