Louison/gotask-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
Louison SARLIN MAGNUS
2026-04-01 18:05:43 +02:00
parent a21cb8470b
commit 534fba2235
1 changed files with 39 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@@ -8,24 +8,24 @@ Tiny project aiming at creating a CLI task tracker in Golang
1. Keep track of tasks
## Roadmap
1. Add
2. List all
3. Progress
4. Regress
5. List by
1. Add
2. List all
3. Progress
4. Regress
5. List by
## Features
### Add tasks
```console
[user@host]$ gotask add "Publish code"
New task added to do @ id=4
New task "Publish code" added to do @ id=4
```
### List all tasks
```console
[user@host]$ gotask list
+---------------------------------------------------------------------+
|id| Description | Status | CreatedAt | UpdatedAt |
|id| Description | Status | Created | Updated |
|--|--------------|-------------|------------------|------------------|
| 1| Update doc | todo | 01-03-2026 09:23 | | # Never updated
| 2| Write code | doing | 04-03-2026 10:13 | 05-03-2026 17:45 | # Set in progress at UpdateAt
@@ -44,7 +44,7 @@ New task added to do @ id=4
```console
[user@host]$ gotask list doing
+---------------------------------------------------------------------+
|id| Description | Status | CreatedAt | UpdatedAt |
|id| Description | Status | Created | Updated |
|--|--------------|-------------|------------------|------------------|
| 2| Write code | doing | 04-03-2026 10:13 | 05-03-2026 17:45 |
| 4| Publish code | doing | 01-04-2026 09:13 | 01-04-2026 10:30 |
@@ -52,31 +52,42 @@ New task added to do @ id=4
```
### Mark regress
```copnsole
```console
[user@host]$ gotask regress 4
[doing] task "Publish code" regress to [todo]
```
### List task by id
```console
[user@host]$ gotask list 4
+---------------------------------------------------------------------+
|id| Description | Status | Created | Updated |
|--|--------------|-------------|------------------|------------------|
| 4| Publish code | doing | 01-04-2026 09:13 | 01-04-2026 10:30 |
+---------------------------------------------------------------------+
```
## Storing data
For convenience reasons, the data will be stored in a JSON file with the following structure.
```json
{
"tasks": [
{
"id": 1,
"Description": "Update doc",
"Status": "todo",
"CreatedAt": 1772353380,
"UpdatedAt": -1
},
{
"id": 2,
"Description": "Write code",
"Status": "doing",
"CreatedAt": 1772615580,
"UpdatedAt": 1772729100
}
]
}
```
[
{
"id": 1,
"Description": "Update doc",
"Status": 0,
"Created": 1772353380,
"UpdatedAt": -1
},
{
"id": 2,
"Description": "Write code",
"Status": 1,
"Created": 1772615580,
"UpdatedAt": 1772729100
}
]
```
Note : todo=0 / doing=1 / done=2