Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/merschformann/gotz
CLI timezone info
https://github.com/merschformann/gotz
cli timezone timezone-conversion tui tz
Last synced: about 1 month ago
JSON representation
CLI timezone info
- Host: GitHub
- URL: https://github.com/merschformann/gotz
- Owner: merschformann
- License: mit
- Created: 2022-01-28T10:35:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-10T01:01:59.000Z (over 1 year ago)
- Last Synced: 2024-08-03T17:11:57.860Z (5 months ago)
- Topics: cli, timezone, timezone-conversion, tui, tz
- Language: Go
- Homepage:
- Size: 877 KB
- Stars: 86
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesomeness - gotz - a simple CLI timezone info tool. (Productivity / Kubernetes)
README
# gotz 
go**tz** - a simple CLI timezone info tool.
## Installation
### Directly via [Go](https://go.dev/doc/install)
```bash
go install github.com/merschformann/gotz@latest
```
### Binary
Simply download the binary of the [latest release](https://github.com/merschformann/gotz/releases/latest/) (look for `gotz_OS_ARCH`), rename it to `gotz` and put it in a folder in your `$PATH`.
## Usage
Show current time:
```bash
gotz
```
Show arbitrary time:
```bash
gotz 21
```
Show arbitrary time using different timezone (index based):
```bash
gotz 15@2
```
Time can be one of the following formats:
```txt
15
15:04
15:04:05
3:04pm
3:04:05pm
3pm
1504
150405
2006-01-02T15:04:05
```
Use live mode to continuously update the time (exit via _q_, _esc_ or _ctrl+c_). Activate once via:
```bash
gotz --live true
```
(above also uses option `--inline false`; for styling see customization below)
## Basic configuration
Set the timezones to be used by default:
```bash
gotz --timezones "Office:America/New_York,Home:Europe/Berlin"
```
(lookup timezones in the [timezones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) wiki page - _TZ identifier_ column)
Set 12-hour format:
```bash
gotz --hours12 true
```
## Customization
The configuration is stored in `$XDG_CONFIG_HOME/gotz/config.json` (usually `~/.config/gotz/config.json` on most systems). It can be configured directly or via the arguments of the `gotz` command (see `gotz --help`). The configuration attributes are described in the following example:
```jsonc
{
// Tracks the version of the configuration file (automatically written on creation)
"config_version": "1.0",
// Configures the timezones to be shown
"timezones": [
// Timezones have a name (Name) and timezone code (TZ)
{ "Name": "Office", "TZ": "America/New_York" },
{ "Name": "Home", "TZ": "Europe/Berlin" },
],
// Configures the style of the plot
"style": {
// Select symbols to use for the time blocks
// (one of 'mono', 'rectangles', 'blocks', 'sun-moon' or 'custom')
"symbols": "mono",
// Define custom symbols (used if 'symbols' is 'custom')
// Each symbol is used from its start time (hour in day as int) until the next symbol
"custom_symbols": [
{ "Start": 6, "Symbol": "▓" },
{ "Start": 8, "Symbol": "█" },
{ "Start": 18, "Symbol": "▓" },
{ "Start": 22, "Symbol": "░" }
],
// Indicates whether to use coloring at all
"colorize": true,
// Configures how the day is segmented
"day_segments": {
// Hour of the morning to start (0-23)
"morning": 6,
// Hour of the day (business hours / main time) to start (0-23)
"day": 8,
// Hour of the evening to start (0-23)
"evening": 18,
// Hour of the night to start (0-23)
"night": 22
},
// Defines the colors for the segments
// Static mode colors can be one of:
// - >simple< color names like `red`, `green`, `cyan`, etc.
// - terminal color codes like `\u001b[34m`, `\u001b[32m`, etc.
// - hex codes like #DC143C, #00ff00, etc. (if true color is supported)
// Dynamic mode colors
// - tcell color names like crimson, green, etc.
// - hex codes like #DC143C, #00ff00, etc.
"coloring": {
// Color of the morning segment for static mode
"StaticColorMorning": "#EC3620",
// Color of the morning segment for static mode
"StaticColorDay": "#F9C748",
// Color of the morning segment for static mode
"StaticColorEvening": "#EC3620",
// Color of the morning segment for static mode
"StaticColorNight": "#030D4D",
// Foreground color overriding default for static mode (optional)
"StaticColorForeground": "",
// Color of the morning segment for dynamic mode
"DynamicColorMorning": "#419AA8",
// Color of the day segment for dynamic mode
"DynamicColorDay": "#FFFFFF",
// Color of the evening segment for dynamic mode
"DynamicColorEvening": "#419AA8",
// Color of the night segment for dynamic mode
"DynamicColorNight": "#09293F",
// Foreground color overriding default for dynamic mode (optional)
"DynamicColorForeground": "",
// Background color overriding default for dynamic mode (optional)
"DynamicColorBackground": ""
}
},
// Indicates whether to plot tics for the local time
"tics": false,
// Indicates whether to stretch across the full terminal width (causes inhomogeneous segment lengths)
"stretch": true,
// Inline indicates whether location and time info will be plotted on one line with the bars.
"inline": true,
// Indicates whether to colorize the blocks
"hours12": false,
// Indicates whether to use 12-hour format
"live": false
}
```
## Why?
Working in an international team is a lot of fun, but comes with the challenge of having to deal with timezones. Since I am not good at computing them quickly in my head, I decided to write a simple CLI tool to help me out. I hope it can be useful for other people as well.
Thanks for the inspiration @[sebas](https://github.com/sebastian-quintero)!