https://github.com/ckaznable/tenki

tty-clock with weather effect
https://github.com/ckaznable/tenki

cli clock ratatui rust rust-lang tty

Last synced: 2 days ago
JSON representation

tty-clock with weather effect

• Host: GitHub
• URL: https://github.com/ckaznable/tenki
• Owner: ckaznable
• License: mit
• Created: 2024-01-12T09:22:30.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-12T09:15:53.000Z (7 months ago)
• Last Synced: 2024-04-12T11:18:27.205Z (7 months ago)
• Topics: cli, clock, ratatui, rust, rust-lang, tty
• Language: Rust
• Homepage:
• Size: 11 MB
• Stars: 82
• Watchers: 1
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ratatui - tenki - A tty-clock with weather effect. (💻 Apps / 🌌 Other)

README

        
# Tenki(天気)

tty-clock with weather effect written by Rust and powerd by [ratatui](https://github.com/ratatui-org/ratatui) and tenki means weather in japanese

![demo](./doc/demo.gif)

## Installation

[![Packaging status](https://repology.org/badge/vertical-allrepos/tenki.svg)](https://repology.org/project/tenki/versions)

### Install from Cargo

```

cargo install --git https://github.com/ckaznable/tenki.git

```

### Install from Source Code

tenki is written in Rust, so you'll need to grab a [Rust installation](https://www.rust-lang.org/) in order to compile it.

```shell

git clone https://github.com/ckaznable/tenki

cd tenki

make build

make install

```

If you want to uninstall

```shell

make uninsall

```

### Install from the AUR

If you are using Arch Linux, you can install tenki using an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers). For example:

```shell

paru -S tenki

```

## Usage

```

Usage: tenki [OPTIONS]

Options:

      --mode                 [default: rain] [possible values: rain, snow, meteor, disable]

      --timer-mode     [possible values: dvd]

      --timer-color   color of the effect. [red, green, blue] [default: white]

  -f, --fps                   frame per second [default: 60]

  -t, --tps                   tick per second [default: 60]

  -l, --level               effect level, The lower, the stronger [4-1000]

      --wind                 wind mode. [random, disable, only-right, only-left, right, left] [default: random]

      --show-fps                   show fps at right-top in screen

      --blink-colon                blinking colon of timer

  -h, --help                       Print help

  -V, --version                    Print version

```

## Roadmap

- [x] CLI options

- [ ] customizable

## LICENSE

[MIT](./LICENSE)