|
@@ -1,6 +1,6 @@
|
|
|
# Tau
|
|
# Tau
|
|
|
|
|
|
|
|
-Tasks management app using peer-to-peer network and raft consensus.
|
|
|
|
|
|
|
+Encrypted tasks management app using peer-to-peer network and raft consensus.
|
|
|
multiple users can collaborate by working on the same tasks, and all users will have synced task list.
|
|
multiple users can collaborate by working on the same tasks, and all users will have synced task list.
|
|
|
|
|
|
|
|
|
|
|
|
@@ -10,7 +10,7 @@ multiple users can collaborate by working on the same tasks, and all users will
|
|
|
% git clone https://github.com/darkrenaissance/darkfi
|
|
% git clone https://github.com/darkrenaissance/darkfi
|
|
|
% cd darkfi
|
|
% cd darkfi
|
|
|
% make BINS="taud tau"
|
|
% make BINS="taud tau"
|
|
|
-% make install "BINS=taud tau" PREFIX=/home/XX/.local
|
|
|
|
|
|
|
+% make install "BINS=taud tau" PREFIX=/home/${USER}/.local
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
## Usage (Local Deployment)
|
|
## Usage (Local Deployment)
|
|
@@ -64,33 +64,81 @@ connect to in the p2p network.
|
|
|
## Seed nodes to connect to
|
|
## Seed nodes to connect to
|
|
|
seeds=["127.0.0.1:11001"]
|
|
seeds=["127.0.0.1:11001"]
|
|
|
|
|
|
|
|
|
|
+
|
|
|
|
|
+Also note that for the first time ever running seed node you must run it with
|
|
|
|
|
+`--key-gen`:
|
|
|
|
|
+```shell
|
|
|
|
|
+% taud --key-gen
|
|
|
|
|
+```
|
|
|
|
|
+This will generate a new secret key in `/home/${USER}/.config/tau/secret_key` that
|
|
|
|
|
+you can share with nodes you want them to get and decrypt your tasks, otherwise if you
|
|
|
|
|
+have already generated or got a copy from a peer place it in the same directory
|
|
|
|
|
+`/home/${USER}/.config/tau/secret_key`.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
## Usage (CLI)
|
|
## Usage (CLI)
|
|
|
|
|
|
|
|
```shell
|
|
```shell
|
|
|
% tau --help
|
|
% tau --help
|
|
|
```
|
|
```
|
|
|
-
|
|
|
|
|
tau 0.3.0
|
|
tau 0.3.0
|
|
|
Tau cli
|
|
Tau cli
|
|
|
|
|
|
|
|
USAGE:
|
|
USAGE:
|
|
|
- tau [OPTIONS] [SUBCOMMAND]
|
|
|
|
|
|
|
+ tau [FLAGS] [OPTIONS] [ARGS] [SUBCOMMAND]
|
|
|
|
|
+
|
|
|
|
|
+ FLAGS:
|
|
|
|
|
+ -h, --help Prints help information
|
|
|
|
|
+ -V, --version Prints version information
|
|
|
|
|
+ -v Increase verbosity
|
|
|
|
|
|
|
|
OPTIONS:
|
|
OPTIONS:
|
|
|
- -h, --help Print help information
|
|
|
|
|
- --listen <LISTEN> Rpc address [default: 127.0.0.1:8875]
|
|
|
|
|
- -v Increase verbosity
|
|
|
|
|
- -V, --version Print version information
|
|
|
|
|
|
|
+ -c, --config <config> Sets a custom config file
|
|
|
|
|
+ --rpc <rpc-listen> JSON-RPC listen URL [default: 127.0.0.1:11055]
|
|
|
|
|
+
|
|
|
|
|
+ ARGS:
|
|
|
|
|
+ <id> Get task by ID
|
|
|
|
|
+ <filters>... Search criteria (zero or more)
|
|
|
|
|
|
|
|
SUBCOMMANDS:
|
|
SUBCOMMANDS:
|
|
|
- add Add a new task
|
|
|
|
|
- get Get task by ID
|
|
|
|
|
- get-comment Get task's comments
|
|
|
|
|
- get-state Get task state
|
|
|
|
|
- help Print this message or the help of the given subcommand(s)
|
|
|
|
|
- list List open tasks
|
|
|
|
|
- set-comment Set comment for a task
|
|
|
|
|
- set-state Set task state
|
|
|
|
|
- update Update/Edit an existing task by ID
|
|
|
|
|
|
|
+ add Add a new task
|
|
|
|
|
+ comment Set or Get comment for a task
|
|
|
|
|
+ help Prints this message or the help of the given subcommand(s)
|
|
|
|
|
+ list List all tasks
|
|
|
|
|
+ state Set or Get task state
|
|
|
|
|
+ update Update/Edit an existing task by ID
|
|
|
|
|
+
|
|
|
|
|
+```shell
|
|
|
|
|
+% tau help [SUBCOMMAND]
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+### Example
|
|
|
|
|
+
|
|
|
|
|
+```shell
|
|
|
|
|
+$ # add new task
|
|
|
|
|
+$ tau add "new title"
|
|
|
|
|
+$ tau add "new title" project:blockchain desc:"new description" rank:3 assign:dark
|
|
|
|
|
+$
|
|
|
|
|
+$ # lists tasks
|
|
|
|
|
+$ tau
|
|
|
|
|
+$ tau open # open tasks
|
|
|
|
|
+$ tau pause # paused tasks
|
|
|
|
|
+$ tau 0522 # created at May 2022
|
|
|
|
|
+$ tau project:blockchain assign:dark
|
|
|
|
|
+$ tau rank:gt:n # lists all tasks that have rank greater than n
|
|
|
|
|
+$ tau rank:ls:n # lists all tasks that have rank lesser than n
|
|
|
|
|
+$
|
|
|
|
|
+$ # update task
|
|
|
|
|
+$ tau update 3 project:network rank:20
|
|
|
|
|
+$
|
|
|
|
|
+$ # state
|
|
|
|
|
+$ tau state 3 # get state
|
|
|
|
|
+$ tau state 3 pause # set the state to pause
|
|
|
|
|
+$
|
|
|
|
|
+$ # comments
|
|
|
|
|
+$ tau comments 1 # list comments
|
|
|
|
|
+$ tau comments 3 "new comment" # add new comment
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
|
|
|
|
|
|