Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jez/calz

:calendar: A natural language alternative to Unix 'cal'
https://github.com/jez/calz

cli

Last synced: 13 days ago
JSON representation

:calendar: A natural language alternative to Unix 'cal'

Awesome Lists containing this project

README

        

# calz

> A feature-rich command line cal alternative

I'm a huge fan of the Unix `cal` program, but it has a limited set of features
when it comes to colors and displaying date *ranges*. `calz` is an alternative
to `cal` with a whole host of features and layouting options.

calz screenshot

## Install

### Using Homebrew

```
brew install jez/formulae/calz
```

### On Linux

Check the [Releases](https://github.com/jez/calz/releases) page for pre-built
64 bit binaries for Linux (note you'll also need libgmp installed).

### From Source

To build this project from source, use Haskell's [Stack].

[Stack]: https://docs.haskellstack.org/en/stable/

```
git clone https://github.com/jez/calz.git

stack build && stack install
```

If you've packaged this software for your operating system, let me know and I
can link to it from these instructions.

## Usage

```
Display a calendar for a month or a range of months.

Usage:
calz [options] [...]

Options:
-l, --layout= Can be 'grid' or 'flow' [default: flow]
-n, --columns= If layout is 'grid': how many columns to use
[default: 3]
-C, --no-color Disable all color
-H, --no-labels Don't show month labels
-P, --no-pad Complete the first and last weeks of every month with
the first and last days of surrounding months
-h, --help Show this help message

Phrase:
calz []
calz
calz (last|this|next) (month|year)
calz last (months|years)
calz (months|years) ago
calz next (months|years)
calz (months|years) from (now|today)
calz from ... to ...

Examples:
dec 2017
next month
3 months ago
from 2 months from now to next year
```

The goal is to accept as many commonly used phrases for talking about dates as
possible. If you find yourself using a phrase that's not accepted, please open
an issue.

## Potential Future Features

- Highlight arbitrary ISO-8601 dates provided on stdin
- Display line separators between months in flow layout
- Customize colors with flags

## License

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://jez.io/MIT-LICENSE.txt)