Documentation

timer

Manage the workspace timer from the command line.

Manage the workspace timer from the command line.

hw timer lets you start a running timer, check its status, and stop it. The timer tracks time live in your active workspace. There are exactly three subcommands: start, status, and stop.

Subcommands

hw timer start

Start a timer.

bash
hw timer start <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

Flags:

text
-d, --description string   description of the timer
-f, --force                force start timer

Use --force to start a new timer even when one is already running.

hw timer status

Get the status of the current timer.

bash
hw timer status <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

hw timer stop

Stop the running timer.

bash
hw timer stop <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

Inherited flags

text
--help   Show help for command

Examples

bash
<span class="token comment"># Start a timer</span>
hw timer start

<span class="token comment"># Start a timer with a description</span>
hw timer start <span class="token parameter variable">-d</span> <span class="token string">"Working on the homepage"</span>

<span class="token comment"># Force-start a new timer even if one is already running</span>
hw timer start <span class="token parameter variable">--force</span> <span class="token parameter variable">-d</span> <span class="token string">"Urgent bug fix"</span>

<span class="token comment"># Check whether a timer is currently running</span>
hw timer status

<span class="token comment"># Stop the running timer</span>
hw timer stop