github/darkfi
1
1
Fork 0
mirror of https://github.com/darkrenaissance/darkfi.git synced 2026-01-09 14:48:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

doc: update tau section in the book

Browse Source
This commit is contained in:
Dastan-glitch
2022-09-05 02:43:58 +03:00
parent d9451f7eef
commit a28a32526c
1 changed files with 106 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

148
doc/src/misc/tau.md
View File

@@ -70,10 +70,11 @@ Also note that for the first time ever running seed node you must run it with
```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`.
This will generate a new secret key and print it to the terminal that
you can share with nodes you want them to get and decrypt your tasks,
otherwise if you have already generated or got a key from a peer, place
it in `secret` field under the corresponding `workspace` in the config
file.
## Usage (CLI)
@@ -82,53 +83,116 @@ have already generated or got a copy from a peer place it in the same directory
% tau --help
```
tau 0.3.0
Command-line client for taud
USAGE:
tau [OPTIONS] <SUBCOMMAND>
tau [OPTIONS] [FILTERS]... [SUBCOMMAND]
ARGS:
<FILTERS>... Search filters (zero or more)
OPTIONS:
-e, --endpoint <ENDPOINT> taud JSON-RPC endpoint [default: tcp://127.0.0.1:11055]
-h, --help Print help information
-v Increase verbosity (-vvv supported)
-V, --version Print version information
-e, --endpoint <ENDPOINT> taud JSON-RPC endpoint [default: tcp://127.0.0.1:23330]
-h, --help Print help information
-v Increase verbosity (-vvv supported)
-V, --version Print version information
SUBCOMMANDS:
add Add a new task
comment Set or Get comment for a task
help Print this message or the help of the given subcommand(s)
info Get task info by ID
state Set or Get task state
update Update/Edit an existing task by ID
add Add a new task.
comment Set or Get comment for task(s)
export Export tasks to a specified directory
help Print this message or the help of the given subcommand(s)
import Import tasks from a specified directory
info Get all data about selected task(s)
list List tasks
log Log drawdown
modify Modify/Edit an existing task
open Open task(s)
pause Pause task(s)
start Start task(s)
stop Stop task(s)
switch Switch workspace
```shell
% tau help [SUBCOMMAND]
% tau [SUBCOMMAND] --help
```
### Example
### Quick start
#### Let's add some tasks
```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 comment 1 # list comments
% tau comment 3 "new comment" # add new comment
% tau add Review tau usage desc:description # will add a new task named
% # "Review tau usage" with
% # "description" in its desc filed
% tau add Second task assign:dave # will add a new task and assign it
% # to "dave".
% # Note: not having "desc:" key
% # will pop up your OS editor
% # configured in \$EDITOR env var,
% # this is recommended for
% # formatting reasons and
% # will be used through this demo.
% tau add Third task project:tau rank:1.1
% tau add Fourth task assign:dave project:tau due:1509 rank:2.5
% tau add Five
```
#### Now let's list tasks, and while we're at it let's use some filters
```shell
% tau # all non-stop tasks
% tau list # all non-stop tasks
% tau 1-3 # tasks 1 to 3
% tau 1,2 state:open # tasks 1 and 2 and if they are open
% tau rank:gt:2 # all tasks that have rank greater than 2
% tau due.not:today # all tasks that thier due date is not today
% tau due.after:0909 # all tasks that thier due date is after September 9th
% tau assign:dave # tasks that assign field is "dave"
```
#### Filtering tasks and run commands on them
Note: mod commands are: start, open, pause, stop and modify.
Note: All filters from the previous section could work with mod commands.
```shell
% tau 5 stop # will stop task 5
% tau 1,3 start # start 1 and 3
% tau 2 pause # pause 2
% tau 2,4 modify due:2009 # edit due to September in tasks 2 and 4
% tau 1-4 modify project:tau # edit project to tau in tasks 1,2,3 and 4
% tau state:pause open # open paused tasks
% tau 3 info # show information about task 3 (does not modify)
```
#### Comments
```shell
% tau 1 comment "content foo bar" # will add a comment to task 1
% tau 3 comment # will show comments on task 3
```
#### Log drawdown
```shell
% tau log 0922 # will list assignees of stopped tasks
% tau log 0922 [<Assignee>] # will draw a heatmap of stopped tasks for [Assignee]
```
#### Export and Import
```shell
% tau export ~/example_dir # will save tasks json files to the path
% tau import ~/example_dir # will reload saved json files from the path
```
#### Switch workspace
```shell
% tau switch darkfi # darkfi workspace needs to be configured in config file
```