Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matt-allan/hours
⏱An open source time tracker for the terminal
https://github.com/matt-allan/hours
Last synced: about 1 month ago
JSON representation
⏱An open source time tracker for the terminal
- Host: GitHub
- URL: https://github.com/matt-allan/hours
- Owner: matt-allan
- License: mit
- Archived: true
- Created: 2019-05-01T23:56:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-27T22:00:13.000Z (about 3 years ago)
- Last Synced: 2024-08-04T01:18:14.631Z (5 months ago)
- Language: PHP
- Homepage: https://matt-allan.github.io/hours/
- Size: 290 KB
- Stars: 56
- Watchers: 4
- Forks: 14
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-laravel-zero - Hours
README
# Hours
[](https://travis-ci.org/matt-allan/hours)
A minimal CLI for tracking time. Easily track the time you spend on personal tasks or client projects. Generate beautiful reports.
All your data is yours and yours only - we never send any data to the cloud or a remote server.
[](https://asciinema.org/a/245508)
## Quick Start
## Installation
Hours is written in PHP. You will need a PHP version >= 7.2. You can check this easily with the `php --version` command. If you don't have PHP installed follow the [full installation guide](https://matt-allan.github.io/hours/user-guide/installation/).
Once you have PHP installation you can easily download the executable from Github:
```
wget https://github.com/matt-allan/hours/releases/latest/download/hours -O hours
chmod a+x ./hours
mv ./hours /usr/local/bin/hours
```
## Usage
To begin tracking time use the `start` command. You can specify the name of the project to track time for, as well as any tags or notes you would like to add.
```
$ hours start blog --tag writing --notes 'Updating the about page'
Starting frame for blog (writing) at 12:26 pm
```
This will create a "frame". Once you have finished your task you can stop tracking time with the `stop` command.
```
$ hours stop
Time tracking for blog stopped (started 1 hour ago).
```
You can view all of your frames with the `report` command.
```
$ hours report
May 1, 2019 to May 7, 2019
+---------+---------+-------------------------+-------------+----------+----------+---------+
| Project | Tags | Notes | Date | Start | End | Elapsed |
+---------+---------+-------------------------+-------------+----------+----------+---------+
| blog | writing | Updating the about page | May 7, 2019 | 12:26 pm | 1:26 pm | 1:00 |
+---------+---------+-------------------------+-------------+----------+----------+---------+
Total hours: 1:00
```
That should be enough information to get you started. To learn more check out the [user guide](https://matt-allan.github.io/hours/user-guide).
## Contribute
Are you interested in helping out with development? Check out our [contributor's guide](https://matt-allan.github.io/hours/contributing) to get started.
## License
Hours is released under the MIT License. See the bundled [LICENSE](./LICENSE.md) file for details.