compact-calendar-cli 0.1.0

A compact calendar CLI with TOML-based date details
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

compact-calendar-cli
===============================

[<img alt="github" src="https://img.shields.io/badge/github-wcampbell0x2a/calendar--cli-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/wcampbell0x2a/compact-calendar-cli)
[<img alt="crates.io" src="https://img.shields.io/crates/v/compact-calendar-cli.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/compact-calendar-cli)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-calendar--cli-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/compact-calendar-cli)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/wcampbell0x2a/compact-calendar-cli/main.yml?branch=master&style=for-the-badge" height="20">](https://github.com/wcampbell0x2a/compact-calendar-cli/actions?query=branch%3Amaster)

A compact year-at-a-glance calendar CLI with TOML-based event highlighting.

Inspired by [David Seah's Compact Calendar](https://davidseah.com/node/compact-calendar/).

- **Compact Display** — Display an entire year in a space-efficient format with week numbers.
- **TOML Configuration** — Define events, date ranges, and colors via simple TOML configuration.
- **Smart Formatting** — Automatic weekend dimming, strikethrough for past dates, and customizable color-coding.
- **Work Mode** — Exclude weekends from color highlighting for work-focused calendars.

![Demo](images/readme.png)

## Binary
Either build from published source in crates.io.
*Compiler support: requires rustc 1.82.0+*
```
$ cargo install compact-calendar-cli --locked
```

Or download from [github releases](https://github.com/wcampbell0x2a/compact-calendar-cli/releases).

### Usage
```no_test
A compact calendar CLI with TOML-based date details

Usage: compact-calendar-cli [OPTIONS]

Options:
  -y, --year <YEAR>              Year to display (defaults to current year)
  -c, --config <CONFIG>          Path to TOML configuration file with date details [default: calendar.toml]
  -s, --sunday                   Week starts on Sunday (default is Monday)
      --no-dim-weekends          Don't dim weekend dates (by default weekends are dimmed)
  -w, --work                     Work mode: never apply colors to Saturday/Sunday
      --no-strikethrough-past    Don't strikethrough past dates (by default past dates are crossed out)
  -h, --help                     Print help
  -V, --version                  Print version
```

## Configuration

Create a `calendar.toml` file to define your events and date ranges:

```toml
# Date ranges with colors
[[ranges]]
start = "2025-01-01"
end = "2025-01-15"
color = "blue"
description = "New Year Sprint"

# Yearly recurring ranges (format: MM-DD)
[[ranges]]
start = "12-25"
end = "12-31"
color = "cyan"
description = "Holiday Break"

# Individual dates
[dates."2025-04-01"]
description = "Project Deadline"
color = "red"

# Yearly recurring events (format: MM-DD)
[dates."01-01"]
description = "New Year's Day"
color = "yellow"
```

### Available Colors

`orange`, `yellow`, `green`, `blue`, `purple`, `red`, `cyan`, `gray`, `light_orange`, `light_yellow`, `light_green`, `light_blue`, `light_purple`, `light_red`, `light_cyan`