zman

Sponsor me

![demo](docs/demo.gif)

zman is a CLI year (time) progress that small, fast, and just one single binary.

Features

Usage Examples

bash zman Show a year progress bar zman month ... a month progress bar zman week ... a week progress bar zman year --json ... a year progress bar with JSON format

Command-line options

``` bash USAGE: zman [FLAGS] [OPTIONS] [time]

ARGS:

FLAGS: -h, --help Prints help information -J, --json Display progress in JSON formatted string -V, --version Prints version information

OPTIONS: -f, --full-bar Set full bar icon [default: ▓] -r, --rest-bar Set rest bar icon [default: ░] -d, --width Adjust width of the bar (default: 20) ```

Usage with other tools

You can use Zman with i3status-rs to show salah time in your status bar.

i3status-zman

i3status-rs configuration Example:

bash [[block]] block = "custom" cycle = ["zman year -J", "zman month -J"] on_click = "<command>" interval = 300 json = true

See more examples to learn other variations.

If you like zman to support your favourite status-bar, please hit me in the mailing-list with the valid input of your status-bar. In i3status.rs the valid input it would be {"icon": "ICON", "state": "STATE", "text": "YOURTEXT"}.

Installation

From binaries

The release page includes pre-compiled binaries for GNU/Linux, macOS and Windows.

From source

Using Rust's package manager cargo:

bash cargo install zman

Development

``` bash git clone https://git.sr.ht/~azzamsa/zman cd zman

Run unit tests and integration tests

cargo test

Install

cargo install --path . ```

Contributing

For reporting issues, visit the tracker here: https://todo.sr.ht/~azzamsa/Zman

Please send patches to ~azzamsa/public-inbox@lists.sr.ht

Unsure how to contribute?

Origin of the name

Zman is a 'time' in Arabic/Turksih.

Inspired By

Please check out this previous work that helped inspire the creation of zman.

License

Copyright (c) 2020 Azzamsa

Bilal is distributed under the terms of GPL V3 License.