Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrusme/zeit
Zeit, erfassen. A command line tool for tracking time spent on activities.
https://github.com/mrusme/zeit
activity-tracker activity-tracking command-line command-line-interface command-line-tool commandline commandline-interface commandline-tool productivity terminal-based time time-tracker time-tracking toggl tracking tui tyme zeit
Last synced: 2 months ago
JSON representation
Zeit, erfassen. A command line tool for tracking time spent on activities.
- Host: GitHub
- URL: https://github.com/mrusme/zeit
- Owner: mrusme
- License: gpl-3.0
- Created: 2020-10-10T18:33:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T18:11:42.000Z (3 months ago)
- Last Synced: 2024-03-30T19:25:42.622Z (3 months ago)
- Topics: activity-tracker, activity-tracking, command-line, command-line-interface, command-line-tool, commandline, commandline-interface, commandline-tool, productivity, terminal-based, time, time-tracker, time-tracking, toggl, tracking, tui, tyme, zeit
- Language: Go
- Homepage: https://マリウス.com/zeit-erfassen-a-cli-activity-time-tracker/
- Size: 1020 KB
- Stars: 187
- Watchers: 5
- Forks: 15
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-stars - zeit
- awesome-tuis - zeit
- awesome-stars - zeit
- awesome-starred - mrusme/zeit - Zeit, erfassen. A command line tool for tracking time spent on activities. (others)
- cli-apps - zeit - A command line tool for tracking time spent on activities. (<a name="time-tracker"></a>Time trackers)
- awesome-cli-apps - zeit - A command line tool for tracking time spent on activities. (<a name="time-tracker"></a>Time trackers)
README
Zeit
----
Zeit, erfassen. A command line tool for tracking time spent on tasks & projects.
[Get some more info on why I build this
here](https://マリウス.com/zeit-erfassen-a-cli-activity-time-tracker/).
[Download the latest version for macOS, Linux, FreeBSD, NetBSD, OpenBSD & Plan9
here](https://github.com/mrusme/zeit/releases/latest).
## Build
```sh
make
```
**Info**: This will build using the version 0.0.0. You can prefix the `make`
command with `VERSION=x.y.z` and set `x`, `y` and `z` accordingly if you want
the version in `zeit --help` to be a different one.
## Usage
Please make sure to `export ZEIT_DB=~/.config/zeit.db` (or whatever location
you would like to have the zeit database at).
*zeit*'s data structure contains of the following key entities: `project`,
`task` and `entry`. An `entry` consists of a `project` and a `task`. These
don't have to pre-exist and can be created on-the-fly inside a new `entry` using
e.g. `zeit track --project "New Project" --task "New Task"`. In order to
configure them, the `zeit project` and the `zeit task` commands can be utilised.
### Projects
A project can be configured using `zeit project`:
```sh
zeit project --help
```
#### Examples:
Set the project color to a hex color code, allowing `zeit stats` to display
information in that color (if your terminal supports colours):
```sh
zeit project --color '#d3d3d3' "cool project"
```
### Task
A task can be configured using `zeit task`:
```sh
zeit task --help
```
#### Examples:
Setting up a Git repository to have commit messages automatically imported
into the activity notes when an activity is finished:
```sh
zeit task --git ~/my/git/repository "development"
```
**Info:** You will have to have the `git` binary available in your `PATH` for
this to work. *zeit* automatically limits the commit log to the exact time of
the activity's beginning- and finish-time. Commit messages before or after these
times won't be imported.
### Track activity
```sh
zeit track --help
```
#### Examples:
Begin tracking a new activity and reset the start time to 15 minutes ago:
```sh
zeit track --project project --task task --begin -0:15
```
### Show current activity
```sh
zeit tracking
```
### Finish tracking activity
```sh
zeit finish --help
```
#### Examples:
Finish tracking the currently tracked activity without adding any further info:
```sh
zeit finish
```
Finish tracking the currently tracked activity and change its task:
```sh
zeit finish --task other-task
```
Finish tracking the currently tracked activity and adjust its start time to
4 PM:
```sh
zeit finish --begin 16:00
```
### List tracked activity
```sh
zeit list --help
```
#### Examples:
List all tracked activities:
```sh
zeit list
```
List all tracked activities since a specific date/time:
```sh
zeit list --since "2020-10-14T00:00:01+01:00"
```
List all tracked activities and add the total hours:
```sh
zeit list --total
```
List only projects and tasks (relational):
```sh
zeit list --only-projects-and-tasks
```
List only projects and tasks (relational) that were tracked since a specific
date/time:
```sh
zeit list --only-projects-and-tasks --since "2020-10-14T00:00:01+01:00"
```
### Display/update activity
```sh
zeit entry --help
```
#### Examples:
Display a tracked activity:
```sh
zeit entry 14037730-5c2d-44ff-b70e-81f1dcd4eb5f
```
Update a tracked activity:
```sh
zeit entry --finish "2020-09-02T18:16:00+01:00" 14037730-5c2d-44ff-b70e-81f1dcd4eb5f
```
### Erase tracked activity
```sh
zeit erase --help
```
#### Examples:
Erase a tracked activity by its internal ID:
```sh
zeit erase 14037730-5c2d-44ff-b70e-81f1dcd4eb5f
```
### Statistics
```sh
zeit stats
```
### Import tracked activities
```sh
zeit import --help
```
The following formats are supported as of right now:
#### `tyme`: Tyme 3 JSON
It is possible to import JSON exports from [Tyme 3](https://www.tyme-app.com).
It is important that the JSON is exported with the following options set/unset:
- `Start`/`End` can be set as required
- `Format` has to be `JSON`
- `Export only unbilled entries` can be set as required
- `Mark exported entries as billed` can be set as required
- `Include non-billable tasks` can be set as required
- `Filter Projects & Tasks` can be set as required
- `Combine times by day & task` **must** be unchecked
During import, *zeit* will create SHA1 sums for every Tyme 3 entry, which
allows it to identify every imported activity. This way *zeit* won't import the
exact same entry twice. Keep this in mind if you change entries in Tyme and
then import them again into *zeit*.
#### Examples:
Import a Tyme 3 JSON export:
```sh
zeit import --format tyme ./tyme.export.json
```
### Export tracked activities
```sh
zeit export --help
```
The following formats are supported as of right now:
#### `zeit`: *zeit* JSON
The *zeit* internal JSON format. Basically a dump of the database including
only tracked activities.
#### `tyme`: Tyme 3 JSON
It is possible to export JSON compatible to the Tyme 3 JSON format. Fields that
are not available in *zeit* will be filled with dummy values, e.g.
`Billing: "UNBILLED"`.
#### Examples:
Export a Tyme 3 JSON:
```sh
zeit export --format tyme --project "my project" --since "2020-04-01T15:04:05+07:00" --until "2020-04-04T15:04:05+07:00"
```
## Integrations
Here are a few integrations and extensions built by myself as well as other
people that make use of `zeit`:
- [`zeit-waybar-bemenu.sh`](https://github.com/mrusme/zeit/blob/main/extras/zeit-waybar-bemenu.sh),
a script for integrating `zeit` into
[waybar](https://github.com/Alexays/Waybar), using
[bemenu](https://github.com/Cloudef/bemenu)
- [`zeit-waybar-wofi.sh`](https://github.com/mrusme/zeit/blob/main/extras/zeit-waybar-wofi.sh),
a script for integrating `zeit` into
[waybar](https://github.com/Alexays/Waybar), using
[wofi](https://hg.sr.ht/~scoopta/wofi)
- [`zeit.1m.sh`](https://github.com/mrusme/zeit/blob/main/extras/zeit.1m.sh),
an [`xbar`](https://github.com/matryer/xbar) plugin for `zeit`
- [`zeit-status.sh`](https://github.com/khughitt/dotfiles/blob/master/polybar/scripts/zeit-status.sh),
a [Polybar](https://github.com/polybar/polybar) integration for `zeit` by
[@khughitt](https://github.com/khughitt)
(see [#1](https://github.com/mrusme/zeit/issues/1))
- your link here, feel free to PR! :-)