Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some tips on effective watson usage #438

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,5 +138,55 @@ To list all available commands, either [explore the commands documentation](user
```bash
$ watson help
```
`
If I want to restart something further back, you can also type the first few characters of the SHA and it will tab autocomplete (you might have to set this up manually on zsh by copying a file).

### Getting groovy

There are many ways to use watson
and it is important to find what works for you.
Below are some tips
that we hope can make your time with watson even more efficient.

Although watson supports tab completion,
it can help to setup shell aliases to your most commonly used commands,
for example:

```shell
alias ws='watson start'
alias wp='watson stop'
alias wr='watson restart'
alias wl='watson log'
alias we='watson edit'
```

Your workflow could be that when you start working for the day,
you type `wl` to see if you want to restart a task
you were working on the previous day with `wr`
or start a new one with `ws proj +tag`.

You might find yourself repeatedly switching between just a few tasks;
in these scenario the `wr` alias is key.
If you type it without any arguments restarts the latest entry
(great when you continue on the same task after a break)
and if you type `wr -2`, `wr -3`,
it restarts older entries.
If you mess up you can type `we` to edit the last frame,
or `watson cancel` to abort the currently active one.

Sometimes you might forget to start or stop a task,
but don't worry,
watson got you covered.
The `--at` option lets you put in the time your started, restarted, or stopped a task,
so that you can easily log past tasks,
e.g. `wr -2 --at 10:30`, or `wp --at 12:00`.
If you want to start a task right when the previous one ended,
you can use `ws proj +tag -G`.

There are [many useful configuration options](user-guide/configuration.md),
including showing the currently active frame in the log output,
setting up default tags for projects,
printing the log to stdout instead of using a pager
and controlling how it is formatted.

We hope you will enjoy Watson!
2 changes: 1 addition & 1 deletion docs/user-guide/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ in the future.
Example:


$ watson start --at 13:37
$ watson start appollo11 --at 13:37
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ watson start appollo11 --at 13:37
$ watson start apollo11 --at 13:37

Starting project apollo11 at 13:37

If the `--no-gap` flag is given, the start time of the new project is set
Expand Down
2 changes: 1 addition & 1 deletion watson/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ def start(ctx, watson, confirm_new_project, confirm_new_tag, args, at_,
Example:

\b
$ watson start --at 13:37
$ watson start appollo11 --at 13:37
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ watson start appollo11 --at 13:37
$ watson start apollo11 --at 13:37

Starting project apollo11 at 13:37

If the `--no-gap` flag is given, the start time of the new project is set
Expand Down