Skip to content

Latest commit

 

History

History
105 lines (64 loc) · 1.73 KB

README.md

File metadata and controls

105 lines (64 loc) · 1.73 KB

🚀 Todo-CLI 🚀

This is a Command line Interface program that helps to manage our daily tasks ☺

🔥 How to Install 🔥

1. Make sure node and git are installed in your device

Install from https://nodejs.org/en/

2. Open your command line and clone this project using the below command

git clone https://github.com/Deepakmukka1/Todo-CLI.git

3. Go to the file Todo-CLI using below command

cd Todo-CLI

4. Install

npm install -g

5. Done! You are ready to use it

console.log('Thank you for installing')

⚡️ How to Use ⚡️

1. Help

Use the todo help command to see the usage

$ todo help
Usage :-
$ todo add "todo item"  # Add a new todo
$ todo ls               # See remaining todos
$ todo del NUMBER       # Delete a todo
$ todo done NUMBER      # Complete a todo
$ todo help             # See usage
$ todo report           # See the Statistics

2. List all pending todos

Use the ls command to see all the todos that are not yet complete.

$ todo ls

3. Add a new todo

Use the add command followed by the item to add an item to the todo.

$ todo add "the thing i need to do"

4. Delete a todo item

Use the del command to remove a todo item by its number.

$ todo del 3

5. Mark a todo item as completed

Use the done command to mark a todo item as completed by its number.

$ todo done 1

6. Generate a report

Use the report command to see the list of pending and completed todos.

$ todo report