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

rename CLI to ta

Browse Source
This commit is contained in:
Dustin J. Mitchell
2021-05-01 14:07:00 -04:00
parent 73ad035bed
commit 0f0f2b0e75
13 changed files with 38 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/src/welcome.md
View File

@@ -1,7 +1,7 @@
# TaskChampion
TaskChampion is a personal task-tracking tool.
It works from the command line, with simple commands like `task add "fix the kitchen sink"`.
It works from the command line, with simple commands like `ta 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 with some different design choices and greater reliability.
@@ -10,18 +10,18 @@ If you've heard of [TaskWarrior](https://taskwarrior.org/), this tool is very si
> NOTE: TaskChampion is still in development and not yet feature-complete.
> This section is limited to completed functionality.
Once you've [installed TaskChampion](./installation.md), your interface will be via the `task` command.
Once you've [installed TaskChampion](./installation.md), your interface will be via the `ta` command.
Start by adding a task:
```shell
$ task add learn how to use taskchampion
$ ta add learn how to use taskchampion
added task ba57deaf-f97b-4e9c-b9ab-04bc1ecb22b8
```
You can see all of your pending tasks with `task next`, or just `task` for short:
You can see all of your pending tasks with `ta next`, or just `ta` for short:
```shell
$ task
$ ta
Id Description Active Tags
1 learn how to use taskchampion
```
@@ -29,13 +29,13 @@ $ task
Tell TaskChampion you're working on the task, using the shorthand id:
```shell
$ task start 1
$ ta start 1
```
and when you're done with the task, mark it as complete:
```shell
$ task done 1
$ ta done 1
```
## Synchronizing
@@ -44,7 +44,7 @@ Even if you don't have a server, it's a good idea to sync your task database per
This acts as a backup and also enables some internal house-cleaning.
```shell
$ task sync
$ ta sync
```
Typically sync is run from a crontab, on whatever schedule fits your needs.
@@ -57,7 +57,7 @@ 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.
The next run of `ta sync` will upload your task history to that server.
Configuring another device identically and running `ta sync` will download that task history, and continue to stay in sync with subsequent runs of the command.
See [Usage](./using-task-command.md) for more detailed information on using TaskChampion.