todo-cli-ui
v1.0.0
Published
Here’s a sample `README.md` file for your CLI todo list application:
Downloads
4
Readme
Here’s a sample README.md
file for your CLI todo list application:
# Todo CLI
A simple command-line interface (CLI) for managing todos using Node.js. This CLI allows you to add, delete, update, mark todos as done, and list all todos. Data is stored in a `todos.json` file.
## Features
- **Add a new todo**: Add a new task to your todo list.
- **Delete a todo**: Remove a todo by its ID.
- **Update a todo**: Modify the task description of an existing todo.
- **Mark a todo as done**: Mark a todo as completed.
- **List all todos**: Display all todos in a table format.
- **Prevent duplicate entries**: Ensure no duplicate tasks are added.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/bearerOP/todo-cli.git
Navigate to the project directory:
cd todo-cli
Install the dependencies:
npm install
Link the CLI globally:
npm link
Usage
Add a new todo
todo add "Your task description"
Example:
todo add "Buy groceries"
Delete a todo by ID
todo delete <id>
Example:
todo delete 1
Mark a todo as done by ID
todo done <id>
Example:
todo done 1
Update a todo's task description by ID
todo update <id> <newTask>
Example:
todo update 1 "Buy groceries and milk"
List all todos
todo list
File Storage
Todos are stored in a JSON file named todos.json
. Each todo entry includes:
id
: Unique identifier for the todotask
: Description of the taskdone
: Boolean indicating if the task is completed
Development
To make changes to the CLI or add new features:
Make sure to update the
index.js
file with your changes.Test your changes locally.
Publish new versions using:
npm version <new-version> npm publish
License
This project is licensed under the ISC License - see the LICENSE file for details.
Contributing
Feel free to submit issues and pull requests. Contributions are welcome!
Contact
For any questions or support, please reach out to [email protected].
### Key Points
- **Installation and Usage**: Instructions for setting up and using the CLI.
- **Features**: Overview of what the CLI can do.
- **File Storage**: Details on how todos are stored.
- **Development**: Guidance for contributing and publishing changes.