Command-line integration for Timeular to track activities and check the status of the currently tracked activity.
It can be used as an interactive CLI by asking the user questions or directly by setting the required input via the corresponding flags.
The current version does not require a Timeular Pro account. It uses only API features that are available in the free version.
While refactoring is ongoing and new features are being added, the application is not published to any registry yet.
Therefore, you need to check out the repository before you can actually install it:
$ git clone https://github.com/andreassiegel/timeular-cli.git
$ cd timeular-cli
$ npm install -gTimeular CLI is using the public Timeular API that requires authentication via your personal API key.
You can get your API credentials from the Timeular account page.
To be able to use Timeular CLI, you have to export the API credentials as
environment variables, e.g., in your .profile or .bashrc or .zshrc file:
export TIMEULAR_API_KEY="XXXXXXXXXX"
export TIMEULAR_API_SECRET="YYYYYYYYYY"$ timeular --help
Usage: timeular <command> [options]
Commands:
timeular start [activityName] Start tracking for a specific activity, stops current tracking
before starting a new one
timeular stop Stops tracking current activity
timeular continue Continues tracking of a previous activity
timeular status Shows the current activity tracking status
timeular list Lists all activities that are available for tracking
Options:
-h, --help output usage information [boolean]
-v, --version output the version number [boolean]
Activities can be tracked in multiple ways:
If you do not provide any options to the start command,
you will be prompted to select the activity to track:
$ timeular start
0 Administration
1 ARC
2 DEV
3 Education
✔ Number of activity to track: · 0
✔ Note: · Prepare release
Stopped tracking: DEV - Working on Timeular CLI (1h 28m 11s)
Started tracking: Administration - Prepare release
The list includes all activities you configured in Timeular.
You can directly specify the activity in order to start tracking without selecting from the list:
$ timeular start <activity>Nevertheless, you will be prompted for a note.
In addition, you can also add a note when you can directly specify the activity and start tracking immediately:
$ timeular start <activity> -m <note>The note may contain tags (#tag) and mentions (@mention).
If you want to continue an activity you tracked recently, use the continue command.
It retrieves the time entries you tracked during the three previous days and the current day so far, and then lets you select one from the last 10.
The options you can choose from are unique by the associated note and ordered by the time you stopped tracking. Tracked activities that did not have a note, are excluded from the selection.
Including the previous three days allows you to continue where you left before the weekend, for instance.
$ timeular continue
0 Working on Timeular CLI (DEV)
1 Prepare release (Administration)
2 Eating pizza (Break)
✔ Number of activity to continue: · 0
Started tracking: DEV - Working on Timeular CLIUse the status command to check your current tracking status:
$ timeular status
Currently tracking: DEV - Working on Timeular CLI (1h 16m 2s)
The output includes the note of the current tracking, if available. The current duration is displayed as well.
To finish an activity, use the stop command:
$ timeular stop
Stopped tracking: DEV (4h 24m 51s)
You can use the list command to print all activities that are available for tracking.
The output is indexed and sorted alphabetically.
If the tracker is running, the currently tracked is highlighted.
$ timeular list
0 Administration
1 ARC
2 DEV
3 Education