Todoer

The todoer CLI command project is user-friendly command-line interface tool designed to manage your todo tasks efficiently. With todoer, you can easily create, read, update, and delete tasks directly from your terminal, streamlining your productivity workflow.

Installation

To install Todoer, run the following command:

npm install -g todoer

Usage: todoer [options] [command]

• Usage defines how the user should run the CLI tool.
  • Todoer: This is the name of the CLI tool.
  • [options]: These are optional flags or options the user can provide (like --version, --help, etc.).
  • [command]: These are the commands that perform specific actions (like add, edit, rm ,del,list).

2. Description of the Tool

• This section gives an overview of the tool's purpose. In this case:

  The todoer CLI command project is a user-friendly command-line interface tool designed to manage your todo tasks efficiently. With todoer, you can easily create, read, update, and delete tasks directly from your terminal, streamlining your productivity workflow.

  The description summarizes the functionality and objective of the CLI tool (i.e., managing tasks efficiently).

3. Options

• Options are flags that modify the behavior of the command or provide additional information. These are generally preceded by - or --.

  • -V, --version: This is an option that, when used, outputs the version number of the CLI tool. Both -V and --version are aliases for this option, so the user can type either one to get the same result.

  Example:

   todoer --version

4. Commands

• Commands are specific actions that the user can perform with the CLI tool. Commands often take arguments or options to modify the action.

  Here are the commands listed for the Todoer CLI tool:

  • add: Adds a new todo task.

    Example:

    todoer add

  • ch <id> <task>: This is a shorthand way to edit a todo using the ID of the task and the new task description.

    Example:

    todoer ch 1 "Complete assignment"

  • edit: Edits an existing todo. This may take further arguments like ID and new task description, task priority, tast status, task deadline.

    Example:

    todoer edit

  • rm <id>: Removes (deletes) a todo by its ID.

    Example:

    todoer rm 1

  • del: Deletes all todos. This is a bulk delete command.

    Example:

    todoer del

  • ls: Lists all todos.

    Example:

    todoer ls

  • list: Lists todos using some sort of filter. This command might support various filtering options like Completed | InProgress | onHold

    Example:

    todoer list

  • get <id>: Display todo details by Todo ID.

    Example:

    todoer get 1

  • h: This likely shows the available commands. It's a shorthand for help.

    Example:

    todoer h

Explanation of How to Use the Tool

1. Add a task:

   todoer add

2. Edit a task:

   todoer ch 1 "Go to the gym"

3. Shorthand way to Edit a task by ID:

   todoer ch 1 "Go to the gym"

4. Remove a task by ID:

   todoer rm 1

5. Delete all tasks:

   todoer del

6. List all tasks:

   todoer ls

7. List tasks with Filter (Completed/Inprogress/onHold):

    todoer list

8. Display Todo Details by ID:

    todoer get 1

9. Display help:

   todoer --help

Summary

To explore Todopro CLI tool:

• Install Todopro: Install the CLI globally using npm with npm install -g todoer.
• Run Commands: the actual actions you perform with the tool, like todoer add, todoer edit, todoer ch <id> <task>, todoer rm <id>, todoer get <id>, todoer ls, todoer list, todoer del .
• help and h commands display detailed usage instructions for specific commands.
• The Options are flags like --version or -V that give you extra information or modify the behavior.

Author

Sanjay Bhandari

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on the GitHub repository.