Productivity
track-time-cli is a Node.JS CLI utility for tracking tasks in time sheets, inspired by ruby's timetrap (sadly not maintained).
It supports natural language specification of entry start and end times,
allowing you to check out of entries retroactively, or check in after already
starting a task without leaving any time untracked. The database is a JSON file
stored in your home folder, at ~/.track-time-cli/db.json
.
Below are a few example commands to illustrate the usual workflow for managing and viewing time sheet entries.
tt sheet work
tt in --at '2 hours and 24 minutes ago' crafting something
tt out
tt list --since '4 hours ago'
tt today
tt week
track-time-cli is available as an NPM
package; install it with your package manager of choice. For example, if you
use npm, run npm i -g track-time-cli
.
Once installed, it will be available as the tt command.
track-time-cli provides commands for both managing time sheet entries, and
viewing historical activity in a variety of ways. To see a full list, run
tt --help
.
The examples listed below use the shorthand command aliases (i.e. e
is
the alias for the edit
command). To view all command aliases, consult
tt --help
.
tt ss
-- view a list of all time sheets.
tt s <sheet name>
-- switch to a sheet by name. It will be automatically
created if it does not already exist.
tt i <description>
-- start a new entry with the given description.
tt i --at '<natural language time>'
-- start a new entry at a custom
time.
tt o --at '<natural language time>'
-- check out of the current entry at
a specified time.
tt e <description>
-- edit the active entry's description.
tt e --entry 32 --delete
-- delete an entry by ID (retrieve the ID
with tt list
).
tt e --sheet <sheet name> --name <new sheet name>
-- change the name
of a time sheet
tt r
-- starts (resumes) an entry with the same description as the
previous one.
Several commands are available to consult the database, either per-sheet or for all sheets together.
tt l
-- list sheet entries for the previous 24 hours; provide
--all-sheets
to view entries for all sheets at once.
Passing --since <natural language time>
will set the start date from which to
list entries, while passing --all
will list sheets from the start of time.
This command has many arguments, for a full list see tt l --help
.tt w
-- view a breakdown of activity for the past week.tt t
-- view a list of entries from today.tt y
-- view a list of entries from yesterday.tt b
-- view a breakdown of activity by day, weekday and hour.Nearly all commands allow durations to be displayed in a human-readable format
with the -h
flag (for example, rendering 1:36:18 as
1 hour, 36 minutes), and dates and times to be shown as relative to the
current time with the -r
flag (converting 2/5/2024, 5:49:44 PM to
3 hours ago).
For reference, the full output of tt --help
is reproduced below:
track-time-cli now
Display all active time sheet entries
Commands:
track-time-cli in <description..> Check in to a time sheet [aliases: i]
track-time-cli now Display all active time sheet entries
[default]
track-time-cli out Check out of the active time sheet entry
[aliases: o]
track-time-cli week [sheets..] Display a summary of activity for the
past week [aliases: w]
track-time-cli list [sheets..] List all time sheet entries [aliases: l]
track-time-cli edit [description..] View, edit, or delete a time sheet entry
[aliases: e]
track-time-cli today [sheets..] Display a summary of activity for today
[aliases: t]
track-time-cli sheet [name] Switch to or delete a sheet by name
[aliases: s]
track-time-cli sheets List all sheets [aliases: ss]
track-time-cli resume Start a new entry with the same
description as the previous one
[aliases: r]
track-time-cli yesterday [sheets..] Display a summary of activity for
yesterday [aliases: y]
track-time-cli breakdown [sheets..] Display total durations per day for one
or more sheets [aliases: b]
Options:
--version Show version number [boolean]
-h, --humanize Print the total duration in human-readable format [boolean]
--help Show help [boolean]
Examples:
tt in --at "20 minutes ago" fixing a bug Check in at a custom time
tt out --at "5 minutes ago" Check out at a custom time
tt list --today --all View all entries from today
tt b Show a breakdown of your activity
tt today --all View activity for the current day
See CHANGELOG.md for more information.
Distributed under the MIT license. See LICENSE.md for more information.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)