@urboifox/todox v1.0.1

Todox - Command-Line Todo Application

Todox is a simple command-line Todo application that allows you to manage your tasks right from your terminal. You can add, list, remove, and update your Todos effortlessly. This application stores your tasks in a JSON file, making it easy to keep track of your to-do list.

Installation

To use Todox, follow these simple steps:

1. Install Node.js: Todox is built using Node.js, so you need to have it installed on your system. If you don't have Node.js installed, you can download and install it from nodejs.org.

2. Install the package: Install the package in your project using NPM.

  npm i -g @urboifox/todox

Now you can use Todox by running todox from your terminal.

Usage

Todox provides several commands to help you manage your tasks. Here's how you can use them:

Print Todos File Path

You can print the path to your Todos file using the path command:

todox path

Add a Todo

Add a new task to your list using the add (or a) command. Replace with your task description.

todox add "Todo"

List All Todos

List all your Todos with the list (or ls) command:

todox list

Remove a Todo

Remove a task by specifying its index using the remove (or rm) command:

todox remove 2

Update a Todo

Update an existing Todo by specifying its index and the new value using the update (or up) command:

todox update 1 "Fix localStorage error"

Contributing

If you encounter any issues or have ideas for improvements, 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.

Author

urboifox

Thank you for using Todox! Happy task management in the command line. 📋🚀