https://github.com/dedo-finger2/taskcli-roadmapsh
A simple task CLI program from Roadmap.sh
https://github.com/dedo-finger2/taskcli-roadmapsh
console-application csharp dotnet-core roadmap-sh
Last synced: 2 months ago
JSON representation
A simple task CLI program from Roadmap.sh
- Host: GitHub
- URL: https://github.com/dedo-finger2/taskcli-roadmapsh
- Owner: Dedo-Finger2
- License: mit
- Created: 2025-03-27T00:00:26.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2025-03-27T00:10:02.000Z (2 months ago)
- Last Synced: 2025-03-27T01:23:58.042Z (2 months ago)
- Topics: console-application, csharp, dotnet-core, roadmap-sh
- Language: C#
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ✅ TaskCLI - Tracking tasks in your terminal
---
*TaskCLI is a lightweight command-line task tracker built in **C#** without any third-party libraries. It helps you manage your tasks efficiently by allowing you to add, update, delete, and track their progress. All tasks are stored in a **JSON** file in the current directory for easy persistence.*
*This project is a backend programming challenge from roadmap.sh website. Here's the link to it: https://roadmap.sh/projects/task-tracker*
---
## 🚀 Features
- **Add tasks** with descriptions;
- **Update and delete** tasks;
- **Mark tasks** as `todo`, `in-progress`, or `done`;
- **List all tasks** or filter by status;
- **JSON-based storage** (automatically created if it doesn't exist);
- **Simple and fast** command-line interface.
---
## 📥 Installation
### 1️⃣ Clone this repository
```sh
git clone https://github.com/yourusername/taskcli.git
```
### 2️⃣ Build the project
```sh
dotnet build -c Release
```
### 3️⃣ Run the binary
`On Linux/macOS:`
```sh
./bin/Release/net9.0/taskcli
```
`On Windows:`
```powershell
bin\Release\net9.0\taskcli.exe
```
### 4️⃣ (Optional) Install globally
`On Linux/macOS:`
```sh
sudo mv bin/Release/net9.0/taskcli /usr/local/bin/taskcli
```
`On Windows:`
```
Add the bin/Release/net9.0/ directory to your system PATH.
```
## 📌 Usage
`Add a New Task`
```sh
taskcli add "Buy groceries"
```
`Update a Task`
```sh
taskcli update 1 "Buy groceries and cook dinner"
```
`Delete a Task`
```sh
taskcli delete 1
```
`Mark a Task as In Progress`
```sh
taskcli mark-in-progress 1
```
`Mark a Task as Done`
```sh
taskcli mark-done 1
```
`List All Tasks`
```sh
taskcli list
```
`List Tasks by Status`
```sh
taskcli list done
taskcli list todo
taskcli list in-progress
```
## 📂 Task Structure (Stored in database.json)
Each task is stored with the following properties:
```json
{
"tasks": [
{
"id": 1,
"description": "Buy groceries",
"status": "Todo",
"createdAt": "2025-03-28T14:00:00Z",
"updatedAt": "2025-03-28T14:00:00Z"
}
]
}
```
## ⚠️ Error Handling
If a task ID does not exist, an appropriate error message is shown. There is also a **log file** named `taskcli-error-log.log` that is created in the root folder (same as the cli binary).
## 📜 License
This project is licensed under the MIT License.
**Enjoy using TaskCLI to manage your tasks efficiently! 💻🎯**