ts_todo_cli

1.0.5 • Public • Published

todo-cli

todo-cli is a command-line tool for managing your todo lists directly from your terminal. With todo-cli, you can easily create, view, modify, and delete tasks in your todo lists without leaving the command line environment.

Installation

To install todo-cli, simply run:

npm install -g ts_todo_cli

This will install todo-cli globally on your system, allowing you to access it from anywhere in your terminal.

Usage

Creating a Todo List

To create a new todo list in the current directory, use the following command:

todo-cli --create

You can also create a new todo list and add it to .gitignore by using the -ig option:

todo-cli --create -ig

Viewing Todo Lists

To view the current todo list in the current directory, use:

todo-cli --show

To show only the completed tasks in the todo list, use:

todo-cli --show -d

To show the hidden completed tasks in the todo list, use:

todo-cli --show -hidden

Adding Tasks

To add a new task to the current todo list, use:

todo-cli --add "Your task description"

Deleting Tasks

To delete a task from the current todo list based on its index, use:

todo-cli --delete <Index>

To delete a task from the completed todo list based on its index, use:

todo-cli --delete -d <Index>

Marking Tasks as Done

To mark a task as done in the current todo list based on its index, use:

todo-cli --done <Index>

Hiding Tasks

To hide a task from the completed todo list based on its index, use:

todo-cli --hide <Index>

Ignoring Todo Lists

To add the todo list to .gitignore, use:

todo-cli --ignore

To remove the todo list from .gitignore, use:

todo-cli --ignore -n

Resetting Todo Lists

To delete the current todo list in the current directory, use:

todo-cli --reset

Examples

Here are some examples to get you started:

todo-cli --create                                  # Creates a new todo list in the current directory.
todo-cli --show                                    # Shows the current todo list in the current directory.
todo-cli --add "Grocery shopping"                  # Adds "Grocery shopping" to the current todo list in the current directory.
todo-cli --delete 1                                # Deletes the task with index 1 from the current todo list in the current directory.
todo-cli --done 2                                  # Marks the task with index 2 as done in the current todo list in the current directory.
todo-cli -r                                        # Deletes the current todo list in the current directory.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on GitHub.

License

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

Readme

Keywords

Package Sidebar

Install

npm i ts_todo_cli

Weekly Downloads

0

Version

1.0.5

License

MIT

Unpacked Size

83.7 kB

Total Files

46

Last publish

Collaborators

  • os_ald2000