Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/oz/tz

🌐 A time zone helper
https://github.com/oz/tz

timezone tzdata zone-helper

Last synced: about 2 months ago
JSON representation

🌐 A time zone helper

Host: GitHub
URL: https://github.com/oz/tz
Owner: oz
License: gpl-3.0
Created: 2021-01-30T19:27:26.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-01-10T00:37:16.000Z (5 months ago)
Last Synced: 2024-03-27T22:03:07.475Z (3 months ago)
Topics: timezone, tzdata, zone-helper
Language: Go
Homepage:
Size: 421 KB
Stars: 787
Watchers: 8
Forks: 29
Open Issues: 8
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: COPYING

Lists

cli-apps - tz - tz helps you schedule things across time zones. It's an interactive TUI program that displays time across the time zones of your choosing. (<a name="organizers"></a>Organizers and calendars)
awesome-stars - oz/tz - 🌐 A time zone helper (Go)
awesome-repositories - oz/tz - 🌐 A time zone helper (Go)
awesome-stars - oz/tz - 🌐 A time zone helper (Go)
my-stars - oz/tz - 🌐 A time zone helper (Go)
awesome - tz - 🌐 A time zone helper (Go)
awesome-stars - oz/tz - `★804` 🌐 A time zone helper (Go)
awesome-cli-apps - tz - tz helps you schedule things across time zones. It's an interactive TUI program that displays time across the time zones of your choosing. (<a name="organizers"></a>Organizers and calendars)

README

# 🌐 A time zone helper

tz helps you schedule things across time zones. It's an interactive TUI
program that displays time across the time zones of your choosing.

# Usage

Run `tz` with no arguments to show the local time, as well as the UTC
time zone. It gets more useful when you pass some time zones to the
program, to list those below the local time zone.

For now, you need to select the time zones from the [tz_data][tzdata]
list. Yes, there are plans to make this friendlier for humans too.
You're welcome to file an issue about it. I enjoy reading those.

If you would rather not type the list everytime, you could set an alias
for your shell, or use the `TZ_LIST` environment variable with a
semi-colon separated list of [tz data][tzdata] zone names (see
*Configuration* below). Command-line arguments trump the environment
variable.

Check out `tz -h` for other flags.

The program will adjust to light and dark terminals themes.

[tzdata]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

# Installing

I provide linux/amd64 builds for "official" releases, and you can build
from source for your favorite architecture. Kind souls have also
packaged the program for other OSes.

## Packages

### Brew

Brew has a tz package: `brew install tz`

### Archlinux

If you're an Archlinux user, packages are also available:

- [tz][tz-arch] follows releases and,
- [tz-git][tz-arch-git] builds the `main` git branch.

[tz-arch]: https://aur.archlinux.org/packages/tz
[tz-arch-git]: https://aur.archlinux.org/packages/tz-git

### Go
```
go install github.com/oz/tz@latest
```

# Configuration

The tz program uses standard time zones as described
[here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
You should specify what time zones to display by setting the `TZ_LIST`
environment variable. The local time is always displayed first. To
display your local time, the time in California, and the time Paris, you
have to set `TZ_LIST` to `US/Pacific;Europe/Paris`

## Zone Alias

The `TZ_LIST` env. variable recognizes items from the standard tz
database names, but you can alias these, using a special value: use the
standard name followed by `,` and your alias. For example:

```
TZ_LIST="Europe/Paris,EMEA office;US/Central,US office"
```

# Building

You need a recent-ish release of go with modules support:

```
git clone https://github.com/oz/tz
cd tz
go build
```

# Testing

```
go test -cover
```

# Contributing

Please do file bugs, and feature requests. I am accepting patches too,
those are the best, but please, open an issue first to discuss your
changes. 😄

# License

The GPL3 license.