{"id":21954849,"url":"https://github.com/thefox/timr","last_synced_at":"2025-03-22T18:42:29.073Z","repository":{"id":62559044,"uuid":"58326490","full_name":"TheFox/timr","owner":"TheFox","description":"Time Tracking for Hackers: CLI tool for tracking work hours.","archived":false,"fork":false,"pushed_at":"2020-03-23T19:05:50.000Z","size":488,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-12T23:01:53.618Z","etag":null,"topics":["mit-license","ruby","ruby-gem","ruby-library","time","timetracker","timetracking","tracking"],"latest_commit_sha":null,"homepage":"https://fox21.at","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheFox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-08T18:55:56.000Z","updated_at":"2022-10-22T14:18:28.000Z","dependencies_parsed_at":"2022-11-03T11:15:46.656Z","dependency_job_id":null,"html_url":"https://github.com/TheFox/timr","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheFox%2Ftimr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheFox%2Ftimr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheFox%2Ftimr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheFox%2Ftimr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheFox","download_url":"https://codeload.github.com/TheFox/timr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245006491,"owners_count":20546136,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mit-license","ruby","ruby-gem","ruby-library","time","timetracker","timetracking","tracking"],"created_at":"2024-11-29T07:26:21.185Z","updated_at":"2025-03-22T18:42:29.043Z","avatar_url":"https://github.com/TheFox.png","language":"Ruby","readme":"# Timr\n\nTimr is a time tracking tool for the [Command-line](https://en.wikipedia.org/wiki/Command-line_interface), written in [Ruby](https://www.ruby-lang.org/). You can track your time spent for a specific project. I know, there are (too) many time tracking tools and such blabla you can use. The main focus of this tool is to use it on the Command-line and make automatic reports. I love the Command-line, so I want the terminal to handle as much as possible. I don't want programms with fancy UIs. Text-based is good enough. All data are stored in YAML files. So editing can also be done by using your favorite editor.\n\n## Install\n\nYou can either install Timr via [RubyGems.org](https://rubygems.org/gems/timr) or from [source](https://github.com/TheFox/timr).\n\n## Install via RubyGems.org\n\nThe preferred method of installation is via RubyGems.org:  \n\u003chttps://rubygems.org/gems/timr\u003e\n\n\tgem install timr\n\n## Install from Source\n\n1. Clone `git clone https://github.com/TheFox/timr.git \u0026\u0026 cd timr`.\n2. Run `./bin/install.sh`. This creates the `timr` gem local and installs it.\n\n## Get Started\n\nThe simplest thing you can do after installation is start a new Task:\n\n\t$ timr start\n\nAnd after some time you probably want to stop:\n\n\t$ timr stop\n\nTo show the current status:\n\n\t$ timr status\n\n## Task\n\nA Task can have a name, a description, an estimation and many more. A Task can have multiple Tracks. One Track can have only one Task as parent. So a Task represents a collection of Tracks.\n\n## Track\n\nA Track is atomic. It's the smallest time unit. This is where the time comes from. It's a time span presented by a begin date time and end date time. All date times are stored as UTC and converted temporary to your local timezone.\n\n## Stack\n\nThe Stack holds Tracks. If you know [Git Stashing](https://git-scm.com/book/en/v1/Git-Tools-Stashing) it's very similar. Just for Tracks. The most recent Track is sometimes called the *Top Track*. It's either the current running Track or on `pause` the latest ran Track.\n\nWhen first starting a new Task, a new Track will be created and pushed to the Stack. When running the Stop command this Task will be removed from the Stack.\n\nYou can push another Track to the Stack by running the Push command. It is like the Start command but without removing the previous Track from the Stack. The Push and Pop command is helpful when you need to work temporary on another Task. When running the Pop command the Top Track will be stopped and removed from the Stack. Further, the next Track on the Stack will continue immediately.\n\n## Clients\n\nIt's recommended to put each client in a separate directory.\n\n\t$HOME/.timr/client1\n\t$HOME/.timr/client2\n\t$HOME/.timr/client3\n\nUse `-C` to change the directory in which Timr should operate:\n\n\ttimr -C \"$HOME/.timr/client1\"\n\nDefault:\n\n\t$HOME/.timr/defaultc\n\n## Commands\n\nSee `timr \u003ccommand\u003e --help` to read details about a specific command, or `timr help \u003ccommand\u003e` to open the man page for this command.\n\nThe man pages are also available online: \u003chttps://timr.fox21.at/man/timr.1.html\u003e\n\n### Start Command\n\nThe Start command always removes all Tracks from the Stack. If there is another current running Task this Task will be stopped and removed from the Stack.\n\n\ttimr start [\u003coptions\u003e] [\u003ctask_id\u003e [\u003ctrack_id\u003e]]\n\nSee more informations on the [timr-start(1)](https://timr.fox21.at/man/timr-start.1.html) man page.\n\n### Stop Command\n\nStopps the current running Track and removes it from the Stack.\n\n\ttimr stop [\u003coptions\u003e]\n\nSee more informations on the [timr-stop(1)](https://timr.fox21.at/man/timr-stop.1.html) man page.\n\n### Pause Command\n\nPause the current running Track.\n\n\ttimr pause [\u003coptions\u003e]\n\nSee more informations on the [timr-pause(1)](https://timr.fox21.at/man/timr-pause.1.html) man page.\n\n### Continue Command\n\nContinue the previous paused Track. When a Track will be continued (or *restarted*) it's actual a copy using the same message.\n\n\ttimr continue [\u003coptions\u003e]\n\nSee more informations on the [timr-continue(1)](https://timr.fox21.at/man/timr-continue.1.html) man page.\n\n### Push Command\n\nSometimes you need to work on a Task only temporary. You want to track the time for this as well. For example fixing a bug. When you fixed the bug you want to continue your actual work. Here comes `timr push` and `timr pop` into the game. It modifies the Stack. When you push a new Task the below Task will be paused. On pop the Top Task will be stopped and the next below will continue.\n\n\ttimr push [\u003coptions\u003e] [\u003ctask_id\u003e [\u003ctrack_id\u003e]]\n\nSee more informations on the [timr-push(1)](https://timr.fox21.at/man/timr-push.1.html) man page.\n\n### Pop Command\n\nStop and pop the current running Track from the Stack.\n\n\ttimr pop [\u003coptions\u003e]\n\nSee more informations on the [timr-pop(1)](https://timr.fox21.at/man/timr-pop.1.html) man page.\n\n### Status Command\n\nPrint the current Stack status.\n\n\ttimr status [\u003coptions\u003e]\n\nSee more informations on the [timr-status(1)](https://timr.fox21.at/man/timr-status.1.html) man page.\n\n### Log Command\n\nShow recent Tracks.\n\n\ttimr log [\u003coptions\u003e]\n\nSee more informations on the [timr-log(1)](https://timr.fox21.at/man/timr-log.1.html) man page.\n\n### Task Command\n\nShow, add, edit, or remove a Task.\n\n\ttimr task \u003csubcommand\u003e [\u003coptions\u003e] [\u003ctask_id\u003e]\n\nSee more informations on the [timr-task(1)](https://timr.fox21.at/man/timr-task.1.html) man page.\n\n### Track Command\n\nShow, add, edit, move, or remove a Track.\n\n\ttimr track \u003csubcommand\u003e [\u003coptions\u003e] [\u003ctrack_id\u003e]\n\nSee more informations on the [timr-track(1)](https://timr.fox21.at/man/timr-track.1.html) man page.\n\n### Report Command\n\nExport Tasks and Tracks.\n\n\ttimr report [\u003coptions\u003e]\n\nSee more informations on the [timr-report(1)](https://timr.fox21.at/man/timr-report.1.html) man page.\n\n### Reset Command\n\nRemove current running Track.\n\n\ttimr reset [\u003coptions\u003e]\n\nSee more informations on the [timr-reset(1)](https://timr.fox21.at/man/timr-reset.1.html) man page.\n\n## Workflow Example\n\nHere is an example as shell commands how your workflow could look like while using Timr.\n\nBefore starting to work on a Task:\n\n\ttimr start\n\nDo your work.\n\nAfter finished your Task:\n\n\ttimr stop\n\nBut you like to name your Task at the beginning to know on what you worked:\n\n\ttimr start --name 'Refactor Star Wars'\n\nIn case you need to do several things on your Task provide a more specific message:\n\n\ttimr start --name 'Refactor Star Wars' --message 'This is what I am going to do.'\n\nBut maybe you have not set `--message` on `start`. So you can also set it on `stop`:\n\n\ttimr stop --message 'This is what I have done.'\n\n## Bash Completion\n\nTimr comes with a completion for Bash: `bin/timr_bash_completion.sh` file is included to the Timr gem. To get the full path to `bin/timr_bash_completion.sh` run:\n\n\techo $(timr --install-basepath)/bin/timr_bash_completion.sh\n\nIn the following examples replace `/path/to/bin/timr_bash_completion.sh` with the output of the executed `echo` command.\n\nCreate a link to this file in your `bash_completion.d` directory. Unter Linux the path is `/etc/bash_completion.d`. Under macOS the path is `/usr/local/etc/bash_completion.d`. In this example we will use the path for macOS:\n\n\tln -s /path/to/bin/timr_bash_completion.sh /usr/local/etc/bash_completion.d\n\nAlternatively you can direct source from your `~/.bashrc` file:\n\n```bash\nif [ -f /path/to/bin/timr_bash_completion.sh ]; then\n\tsource /path/to/bin/timr_bash_completion.sh\nfi\n```\n\nDo not forget to remove all links when deinstalling Timr.\n\n## Project Links\n\n- [Homepage](https://timr.fox21.at/)\n- [API Reference Mainpage](https://timr.fox21.at/api/)\n- [Man pages](https://timr.fox21.at/man/timr.1.html)\n- [Code Coverage](https://timr.fox21.at/coverage/)\n- [GitHub Page](https://github.com/TheFox/timr)\n- [RubyGems Page](https://rubygems.org/gems/timr)\n- [Travis CI Repository](https://travis-ci.org/TheFox/timr)\n\n## Contributing\n\nSee [Contributing](.github/CONTRIBUTING.md) page.\n\n## License\n\nCopyright (C) 2016 Christian Mayer \u003chttps://fox21.at\u003e\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthefox%2Ftimr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthefox%2Ftimr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthefox%2Ftimr/lists"}