mirror of https://github.com/IoTcat/todo-ddl.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
137 lines
2.2 KiB
137 lines
2.2 KiB
# todo-ddl |
|
Manage your ToDo items with Logs and DDLs on nodejs. |
|
|
|
## Quick Start |
|
|
|
### Installation |
|
|
|
```sh |
|
$ npm i -g todo-ddl |
|
``` |
|
|
|
### Find Help |
|
|
|
```sh |
|
$ td -h |
|
``` |
|
|
|
## Architecture |
|
|
|
### overview |
|
|
|
```js |
|
|todo-ddl |
|
| |
|
|---config |
|
| |---email |
|
| |---remote url |
|
| |
|
|---td |
|
| |---todo |
|
| |---task |
|
| |---history |
|
| |
|
|---ddl |
|
| |
|
|---log |
|
| |
|
|
|
``` |
|
|
|
### td structure |
|
|
|
```js |
|
|
|
td new td add td done |
|
------> --------> ---------> |
|
todo task history |
|
<------ <-------- <--------- |
|
td rm td return td recover |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## Commands |
|
|
|
### config set |
|
+ `td config [-e email] [-r remote]`: Set |
|
|
|
|
|
### td set |
|
|
|
+ `td new <name> [class]`: Create new todo item.. |
|
+ `td add <id>`: Add todo item to task.. |
|
+ `td done <id>`: Finish task.. |
|
+ `td recover`: Recover task from history.. |
|
+ `td return <id>`: Return task to todo item.. |
|
+ `td rm <id>`: Remove task.. |
|
|
|
+ `td ls`: List tasks.. |
|
+ `td lt`: List todo items.. |
|
+ `td history`: List history |
|
|
|
### log set |
|
|
|
+ `td select <id>`: Select task for loging.. |
|
+ `td log <comment>`: Record logs.. |
|
+ `td ll`: List logs.. |
|
+ `td rml <id>`: Remove log.. |
|
|
|
### ddl (deadline) set |
|
|
|
+ `td newd <name> <date>`: Create new ddl.. |
|
+ `td link <ddlID> <tdID>`: Link todo with ddl.. |
|
+ `td ld`: List ddls.. |
|
+ `td rmd <id>`: Remove ddl.. |
|
|
|
### systemctl |
|
|
|
+ `td init`: Reset all.. |
|
+ `td push`: Push local to remote.. |
|
+ `td pull`: Pull from remote.. |
|
+ `td sync`: Sync with remote.. |
|
|
|
|
|
## Data structure |
|
|
|
```js |
|
config:{ |
|
email: "", |
|
remote: "https://api.yimian.xyz/todo-ddl/" |
|
} |
|
|
|
|
|
data:{ |
|
td:{[{ |
|
id: 'a2s3s2ds', |
|
name: '', |
|
class: 'default', |
|
createTime: (new Date()).valueOf(), |
|
todoTime: (new Date()).valueOf(), |
|
endTime: (new Date()).valueOf(), |
|
lastOperateTime: (new Date()).valueOf(), |
|
idDel: false, |
|
logs: [{ |
|
id: 'fdkr8ei9odleiw93', |
|
content: '', |
|
createTime: (new Date()).valueOf()， |
|
lastOperateTime: (new Date()).valueOf(), |
|
isDel: false |
|
}] |
|
}]}, |
|
|
|
ddl: {[{ |
|
id: 'di8eio', |
|
name: '', |
|
class: 'default', |
|
link: [<tdID>], |
|
createTime: (new Date()).valueOf(), |
|
expireTime: (new Date()).valueOf(), |
|
lastOperateTime: (new Date()).valueOf(), |
|
isDel: false |
|
}]} |
|
} |
|
|
|
```
|
|
|