focusmini 2.0.1

Simple Pomodoro timer with audio cues
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

# focusmini

Focusmini is a compact Pomodoro CLI that alternates between work and break intervals while triggering an audio cue on each transition.

> [!NOTE]
> Only works on Linux since it calls `pw-play` or `paplay` to play the Freedesktop alarm sound.

- ~100 LOC production code
- small < 500 KiB release binary
- no external dependencies (std-only)
- zero unsafe code, 100% `mod.rs` test [coverage](https://szilvasipeter.github.io/focusmini/coverage/index.html)

## Install

Install the prebuilt binary with `cargo-binstall` command:

```
cargo binstall focusmini
```

Or build from the source:

```
cargo install focusmini
```

## Usage

Run the `focusmini` with the deafult values or change them with options:

```
Usage: focusmini [OPTIONS]

Options:
  -w, --work <work_minutes>     Work interval length in minutes [default: 60]
  -b, --break <break_minutes>   Break interval length in minutes [default: 10]
```

## Commands

The table summary of the make commands:

| Make Target | Description |
|-------------|-------------|
| `make build` | Build the release binary and strip it. |
| `make run` | Build and execute the release binary. |
| `make lint` | Run Clippy in release mode against all targets with `clippy::all`. |
| `make test` | Run tests with the `fast-tick` feature in release mode. |
| `make cov` | Run test coverage with `cargo tarpaulin` command. |
| `make sec` | Run `cargo audit`, `cargo deny check`, `cargo geiger` and `cargo +nightly udeps --release`. |