speedreader 0.1.1

A command-line speed reading tool
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

# SpeedReader

A CLI tool for speed reading text with AI comprehension evaluation.

## Installation

### Using Cargo

```bash
cargo install speedreader
```

### Manual Installation

1. Clone the repository:

```bash
git clone https://github.com/fcasibu/speedreader.git
cd speedreader
```

2. Build the project:

```bash
cargo build --release
```

3. The binary will be available at `target/release/speedreader`

## Usage

### Basic Reading

Read a file at the default speed (258 WPM):

```bash
speedreader --file path/to/text.txt
```

Read at a specific WPM:

```bash
speedreader --file path/to/text.txt --wpm 300
```

Read from stdin:

```bash
cat path/to/text.txt | speedreader
# or through a clipboard (example is what I use)
xclip -selection clipboard -o | speereader
```

### Configuration

SpeedReader supports a configuration file for customizing various settings. To generate a default configuration file:

```bash
speedreader --init-config
```

This creates a configuration file at `~/.config/speedreader/config.toml` (Linux/macOS) or `%APPDATA%\speedreader\config.toml` (Windows).

The configuration file allows you to customize:

- Default words per minute (WPM)
- WPM adjustment step size
- Keybindings for pause, quit, and WPM adjustment
- AI model for summary evaluation

Example configuration:

```toml
# Words per minute
wpm = 258
# Step to adjust WPM when using + and - keys
wpm_step = 5
# AI model to use for summary evaluation
model = "deepseek/deepseek-r1:free"

# Keybindings configuration
[keys]
# Key to quit
quit = "q"
# Key to pause/resume
pause = " "
# Key to increase WPM
increase_wpm = "+"
# Key to decrease WPM
decrease_wpm = "-"
```

### Controls During Reading

Default keybindings (can be customized in the config file):

- **Space**: Pause/resume reading
- **Q**: Quit reading
- **+**: Increase WPM
- **-**: Decrease WPM

### AI Analysis

After finishing reading, you'll be prompted to enter a summary of what you read. The summary will be analyzed by an AI model and you'll receive feedback on your comprehension.

For this feature to work, you must have an OpenRouter API key set as an environment variable:

```bash
export OPEN_ROUTER_API_KEY=your_api_key_here
```

## Command-line Options

```
Options:
  -f, --file <FILE>  Path of the text file to speed read
      --wpm <WPM>    Words per minute
      --init-config  Generate a default config file
  -h, --help         Print help
```

## Requirements

- The AI summary evaluation feature requires an [OpenRouter API key](https://openrouter.ai/) set as the `OPEN_ROUTER_API_KEY` environment variable.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.