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: 6 months ago
JSON representation
⏰ A Geeky Clock for Terminal Enthusiasts
- Host: GitHub
- URL: https://github.com/sepandhaghighi/clox
- Owner: sepandhaghighi
- License: mit
- Created: 2024-11-23T15:24:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-23T06:19:11.000Z (about 1 year ago)
- Last Synced: 2025-06-24T03:04:08.860Z (12 months ago)
- Topics: ascii-art, cli, cli-app, clock, clockface, python, terminal, terminal-app, terminal-based, time, timer
- Language: Python
- Homepage:
- Size: 367 KB
- Stars: 45
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
Clox: A Geeky Clock for Terminal Enthusiasts
## 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
## Installation
### Source Code
- Download [Version 1.5](https://github.com/sepandhaghighi/clox/archive/v1.5.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==1.5`
## 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`
### Manual Offset
ℹ️ The local and timezone offset both have default values of `0`
These arguments allow you to manually adjust the time by ±X hours. This is especially useful when daylight saving time (DST) is not correctly applied by the system or timezone database.
```console
clox --offset-local=1 --offset-timezone=-1
```
### 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
```
### Once
Print current time once and exit immediately
```console
clox --once
```
### 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 --first-weekday="SUNDAY"
```
### Date System
ℹ️ Valid choices: [`GREGORIAN`, `JALALI`]
ℹ️ The default date system is `GREGORIAN`
```console
clox --date-system=jalali
```
### Date Format
ℹ️ Valid choices: [`ISO`, `US`, `US-SHORT`, `EU`, `EU-SHORT`, `DOT`, `DASH`, `YMD`, `DMY`, `MDY`, `FULL`]
ℹ️ The default date format is `FULL`
```console
clox --date-system=jalali --date-format=EU
```
* Date Formats List: `clox --date-formats-list`
### Color
⚠️ This mode may not be supported on all systems
ℹ️ Valid choices: [`BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, `WHITE`, `LIGHTBLACK`, `LIGHTRED`, `LIGHTGREEN`, `LIGHTYELLOW`, `LIGHTBLUE`, `LIGHTMAGENTA`, `LIGHTCYAN`, `LIGHTWHITE`]
ℹ️ The default color is `WHITE`
```console
clox --date-system=jalali --color="red"
```
### Background Color
⚠️ This mode may not be supported on all systems
ℹ️ Valid choices: [`BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, `WHITE`, `LIGHTBLACK`, `LIGHTRED`, `LIGHTGREEN`, `LIGHTYELLOW`, `LIGHTBLUE`, `LIGHTMAGENTA`, `LIGHTCYAN`, `LIGHTWHITE`]
ℹ️ The default background color is `BLACK`
```console
clox --date-system=jalali --color="red" --bg-color="blue"
```
### Intensity
⚠️ This mode may not be supported on all systems
ℹ️ Valid choices: [`NORMAL`, `BRIGHT`, `DIM`]
ℹ️ The default intensity is `NORMAL`
```console
clox --color="red" --intensity="bright"
```
## Screen Record
## Try Clox Online!
Clox can be used online in interactive Jupyter Notebooks via the Binder or Colab services! Try it out now! :
[](https://mybinder.org/v2/gh/sepandhaghighi/clox/main)
[](https://colab.research.google.com/github/sepandhaghighi/clox/blob/main)
- Open `notebook.ipynb`
## 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
