timetrap
Track time spent on projects and tasks
TLDR
Create a new timesheet
Check in an entry started 5 minutes ago
Display the current timesheet
Edit the last entry's end time
SYNOPSIS
timetrap [options]
PARAMETERS
in [name]
Start a timer with the specified name. If no name is given, the default 'default' timer is used.
out [name]
Stop the currently running timer with the specified name. If no name is given, the default 'default' timer is stopped.
now
Displays the current status of timers. This shows which timers are running and for how long.
list [options]
Lists all the timed intervals. Options include filtering by date or project.
edit
Opens the data file in your configured text editor to allow direct editing.
report [options]
Generates a report of your time entries, with options to filter and format the output.
sheet
Generates a spreadsheet compatible report. Options for filtering and formatting apply.
version
Displays the current version of Timetrap.
help
Displays help information about Timetrap.
pause [name]
Pause the currently running timer. New in version 1.3.0
resume [name]
Resume a paused timer. New in version 1.3.0
DESCRIPTION
Timetrap is a command-line tool that helps you track the time spent on various tasks within your shell. It's designed to be unobtrusive, lightweight, and easily integrated into your workflow. Timetrap allows you to start and stop timers for specific projects or activities, providing a clear overview of your time allocation. It can be used to generate reports, export data, and analyze productivity. Timetrap uses a simple plain-text database to store its information. The tool can be extended via plugins to allow for interaction with other tools like project management tools.
Unlike other time-tracking solutions, Timetrap focuses on shell command execution, making it ideal for developers, system administrators, and anyone who spends a significant amount of time working in the terminal. Timetrap provides a streamlined and efficient way to understand how you spend your time on the command line, helping you optimize your workflow and improve productivity.
CONFIGURATION
Timetrap is highly configurable through a configuration file, typically located at `~/.timetrap.rc`. This file allows you to customize the editor used for `timetrap edit`, the default timer name, report formats, and various other aspects of the tool's behavior.
DATA STORAGE
Timetrap stores its data in a plain text file, usually located at `~/.timetrap/database`. The format of this file is simple and human-readable, making it easy to inspect and even manually edit the time entries if needed.
EXTENSIBILITY
Timetrap supports plugins, which can extend its functionality by adding new commands, report formats, or integration with other tools. Plugins are typically written in Ruby.