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

https://github.com/sepandhaghighi/clox

⏰ A Geeky Clock for Terminal Enthusiasts
https://github.com/sepandhaghighi/clox

ascii-art cli cli-app clock clockface python terminal terminal-app terminal-based time timer

Last synced: about 2 months ago
JSON representation

⏰ A Geeky Clock for Terminal Enthusiasts

Awesome Lists containing this project

README

        



Clox: A Geeky Clock for Terminal Enthusiasts




PyPI version
built with Python3
GitHub repo size


## Overview


Clox is a terminal-based clock application designed for terminal enthusiasts who appreciate simplicity, elegance, and productivity within their command-line environment. Whether you're coding, monitoring tasks, or simply enjoying the terminal aesthetic, Clox brings a stylish and customizable time display to your workspace.


PyPI Counter



Github Stars


Branch
main
dev


CI



Code Quality
CodeFactor

codebeat badge

## Installation

### Source Code
- Download [Version 0.9](https://github.com/sepandhaghighi/clox/archive/v0.9.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
- `pip install .`

### PyPI

- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
- `pip install clox==0.9`

## Usage

ℹ️ You can use `clox` or `python -m clox` to run this program

### Version

```console
clox --version
```

### Info

```console
clox --info
```

### Basic

ℹ️ Press `Ctrl + C` to exit

```console
clox
```

### Face

```console
clox --face=3
```
* Use `--face=-1` for random mode
* [Faces List](https://github.com/sepandhaghighi/clox/blob/main/FACES.md): `clox --faces-list`

### Timezone

```console
clox --timezone="Etc/GMT+7"
```
* [Timezones List](https://github.com/sepandhaghighi/clox/blob/main/TIMEZONES.md): `clox --timezones-list`

### Country

The `--country` argument allows you to specify a country using its **ISO 3166** code format

ℹ️ When the `--country` argument is provided, the `--timezone` argument will be ignored

ℹ️ If the specified country has multiple timezones, the first timezone will be selected automatically

```console
clox --country="DE"
```
* [Countries List](https://github.com/sepandhaghighi/clox/blob/main/COUNTRIES.md): `clox --countries-list`

### Vertical/Horizontal Shift

ℹ️ The vertical and horizontal shift both have default values of `0`

```console
clox --v-shift=20 --h-shift=30
```

### No Blink

Disable blinking mode

```console
clox --no-blink
```

### Hide Date

In this mode, the date will not be shown

```console
clox --hide-date
```

### Hide Timezone

In this mode, the timezone will not be shown

```console
clox --hide-timezone
```

### AM/PM Mode

In this mode, the clock will be displayed in 12-hour format

```console
clox --am-pm
```

### Vertical Mode

```console
clox --vertical
```

### Calendar Mode

In this mode, the calendar will be displayed

ℹ️ Valid choices: [`month`, `year`]

```console
clox --calendar=month
```

### Date System

ℹ️ Valid choices: [`gregorian`, `jalali`]

ℹ️ The default date system is `gregorian`

```console
clox --date-system=jalali
```

## Screen Record

## Issues & Bug Reports

Just fill an issue and describe it. We'll check it ASAP!

- Please complete the issue template

## Show Your Support

Star This Repo

Give a ⭐️ if this project helped you!

Donate to Our Project

Bitcoin


1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy

Ethereum


0xcD4Db18B6664A9662123D4307B074aE968535388

Litecoin


Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ

Doge


DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh

Tron


TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7

Ripple


rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq

Binance Coin


bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef

Tether


0xcD4Db18B6664A9662123D4307B074aE968535388

Dash


Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s

Stellar


GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL

Zilliqa


zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5

Coffeete