gergely/taskwarrior-2.x
1
0
Fork 0
Code Issues Actions Packages Projects Releases 1 Wiki Activity

Update documentation for reports, new CLI

Browse Source 
This is basically a redraft of the documentation to be more complete and
better cover some of the features added since it was written.
This commit is contained in:
Dustin J. Mitchell
2021-01-01 21:17:42 +00:00
parent b29f75a075
commit 8b4f345387
10 changed files with 189 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/src/welcome.md
View File

@@ -3,7 +3,7 @@
TaskChampion is a personal task-tracking tool.
It works from the command line, with simple commands like `task add "fix the kitchen sink"`.
It can synchronize tasks on multiple devices, and does so in an "offline" mode so you can update your tasks even when you can't reach the server.
If you've heard of [TaskWarrior](https://taskwarrior.org/), this tool is very similar, but actively maintained and with a more reliable synchronization system.
If you've heard of [TaskWarrior](https://taskwarrior.org/), this tool is very similar, but with some different design choices and greater reliability.
## Getting Started
@@ -14,16 +14,16 @@ Once you've [installed TaskChampion](./installation.md), your interface will be
Start by adding a task:
```shell
$ task add "learn how to use taskchampion"
$ task add learn how to use taskchampion
added task ba57deaf-f97b-4e9c-b9ab-04bc1ecb22b8
```
You can see all of your pending tasks with `task pending`, or just `task` for short:
You can see all of your pending tasks with `task next`, or just `task` for short:
```shell
$ task
id act description
1 learn how to use taskchampion
Id Description Active Tags
1 learn how to use taskchampion
```
Tell TaskChampion you're working on the task, using the shorthand id:
@@ -49,13 +49,15 @@ $ task sync
Typically sync is run from a crontab, on whatever schedule fits your needs.
To synchronize multiple replicas of your tasks, you will need a sync server and a client ID on that server.
To synchronize multiple replicas of your tasks, you will need a sync server and a client key for that server.
Configure these in `~/.config/taskchampion.yml`, for example:
```yaml
server_client_id: "f8d4d09d-f6c7-4dd2-ab50-634ed20a3ff2"
server_client_key: "f8d4d09d-f6c7-4dd2-ab50-634ed20a3ff2"
server_origin: "https://taskchampion.example.com"
```
The next run of `task sync` will upload your task history to that server.
Configuring another device identically and running `task sync` will download that task history, and continue to stay in sync with subsequent runs of the command.
See [Usage](./usage.md) for more detailed information on using TaskChampion.