Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nirmit27/todo-cli
This is a lightweight CLI ToDo application created using Go.
https://github.com/nirmit27/todo-cli
go go-cli go-development golang todo todo-cli todo-list
Last synced: 16 days ago
JSON representation
This is a lightweight CLI ToDo application created using Go.
- Host: GitHub
- URL: https://github.com/nirmit27/todo-cli
- Owner: nirmit27
- License: mit
- Created: 2025-01-25T08:04:46.000Z (19 days ago)
- Default Branch: main
- Last Pushed: 2025-01-27T11:29:59.000Z (17 days ago)
- Last Synced: 2025-01-27T12:32:40.978Z (17 days ago)
- Topics: go, go-cli, go-development, golang, todo, todo-cli, todo-list
- Language: Go
- Homepage: https://roadmap.sh/projects/task-tracker/solutions?u=64d6ca80aa497d7fa528b16a
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Todo CLI 📝
This is a lightweight, terminal-based task management application built with **[Go](https://go.dev/#)**. It allows you to **add**, **update**, **delete**, and **list** tasks using simple commands. The tasks are written into and read from a **JSON** file for persistence.
> #### This is a sample solution for the [task-tracker](https://roadmap.sh/projects/task-tracker) project from **[roadmap.sh](https://roadmap.sh/)** projects.
## Features
- Add tasks with descriptions. 📝
- Update tasks by their ID. ✍️
- Delete tasks by their ID. 🗑️
- Mark tasks as in-progress or done. ☑️
- List tasks, optionally filtered by **status** (todo, in-progress, done). 📃
- Tasks are stored in a `tasks.json` file in the current directory. 📁
## Installation
### 1. Clone the Repository
```bash
git clone https://github.com/nirmit27/todo-cli.git
cd todo-cli
```
### 2. Build the Executable
Run the following command to build the executable:
```bash
go build -o todo-cli
```
This will create an executable file named `todo-cli` in the current directory.
## Usage
The task-cli application supports the following commands:
### 1. Add a Task
Add a new task with a **description**.
```bash
./todo-cli add ""
```
#### Output:
```bash
Task added successfully! ID : n
```
### 2. Update a Task
Update the **description** of an existing task by its **ID**.
```bash
./todo-cli update ""
```
#### Output:
```bash
Task [n] updated successfully!
```
### 3. Delete a Task
Delete a task by its **ID**.
```bash
./todo-cli delete
```
#### Output:
```bash
Task [n] deleted successfully!
```
### 4. Mark a Task as _todo_, _in-progress_ or _done_
Update the status of a task by its **ID**.
```bash
./todo-cli mark
```
#### Output:
```bash
Task [n] MARKED as .
```
### 5. List All Tasks
List **all** the tasks stored in the JSON file.
```bash
./todo-cli list
```
### 6. List Tasks by Status
List tasks filtered by their status (`todo`, `in-progress`, or `done`).
```bash
./todo-cli list
```
## Dependencies
This application is built using only Go's **standard library**. No external libraries are required.
## License
This project is licensed under the **MIT License**. See the [LICENSE](./LICENSE) file for more details.