aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3ac8d6f64386cb200b2e001d424d69d9f403b0df (plain) (blame)
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
# tldr

Download and summarize webpages using LLMs.

## Installation

```bash
uv sync
```

## Usage

```bash
tldr <URL> -m <provider/model>
```

### Options

| Option | Description |
|--------|-------------|
| `-m, --model` | Model to use (required). Format: `provider/model` |
| `-p, --proxy` | Proxy URL (e.g., `http://proxy:8080`) |
| `-H, --header` | HTTP header (`Name: Value`). Repeatable |
| `-n, --nodriver` | Use headless browser for JS-rendered pages |
| `-d, --debug` | Show browser window when using `--nodriver` |
| `-r, --raw` | Output raw text without summarization |
| `-h, --help` | Show help |

### Models

```bash
tldr https://example.com -m anthropic/sonnet
tldr https://example.com -m openai/gpt-4o
tldr https://example.com -m gemini/flash
tldr https://example.com -m claude/sonnet
tldr https://example.com -m openrouter/...
```

### Examples

```bash
# Basic usage
tldr https://example.com -m anthropic/sonnet

# JS-heavy pages
tldr https://example.com --nodriver -m claude/sonnet

# With proxy
tldr https://example.com --proxy http://localhost:8080 -m gemini/flash

# Custom headers
tldr https://example.com -H "Authorization: Bearer token" -m openai/gpt-4o

# Raw text output
tldr https://example.com --raw

# Debug mode (show browser window)
tldr https://example.com --nodriver --debug -m claude/sonnet
```

## Environment Variables

| Variable | Provider |
|----------|----------|
| `ANTHROPIC_API_KEY` | Anthropic |
| `OPENAI_API_KEY` | OpenAI |
| `GEMINI_API_KEY` | Google Gemini |
| `OPENROUTER_API_KEY` | OpenRouter |

## License

MIT