|
4 | 4 |  |
5 | 5 |  |
6 | 6 |
|
7 | | -**Tiny prompt. Shorter answers. Same brain.** |
| 7 | +Single-system prompt for terse, high-signal AI responses. |
8 | 8 |
|
9 | | -**−82% prose reduction**, 100% compliance across 5 agents × 5 prompts.[^bench] |
| 9 | +**TLDR.md is the only prompt in this repo.** |
10 | 10 |
|
11 | | -[^bench]: See [`data/benchmarks.md`](data/benchmarks.md) for methodology and caveats. |
| 11 | +TLDR.md changes style only: less filler, less fake enthusiasm, less post-hoc guidance. |
12 | 12 |
|
13 | | -TLDR.md makes AI assistants answer directly: less filler, less fake enthusiasm, less "let me know if..." sludge. |
| 13 | +Tools, reasoning, code quality, and safety remain unchanged. |
14 | 14 |
|
15 | | -> It changes communication style only. |
16 | | -> Tools, reasoning, code quality, and safety stay the same. |
| 15 | +> For historical context on earlier merged/legacy variants, see `data/changelog.md` and `data/progression.md`. |
17 | 16 |
|
18 | | -## Pick one |
| 17 | +## Install |
19 | 18 |
|
20 | | -| File | Install arg | Use this if... | |
21 | | -|---|---|---| |
22 | | -| [`TLDR.md`](TLDR.md) | `regular` | You want terse output. | |
23 | | -| [`TLDR.blunt.md`](TLDR.blunt.md) | `blunt` | You want terse output plus less sycophancy / more pushback when warranted. | |
24 | | -| [`TLDR.accurate.md`](TLDR.accurate.md) | `accurate` | You want accurate, complete answers without extreme brevity sacrificing precision. | |
25 | | -| **[`TLDR.merged.md`](TLDR.merged.md)** | `merged` | **Most people, start here.** Accurate + blunt + terse combined. | |
26 | | - |
27 | | -## One-line install |
| 19 | +```bash |
| 20 | +curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | bash -s -- |
| 21 | +``` |
28 | 22 |
|
29 | | -No clone. No editing. The install script writes the chosen prompt to the 7 standard coding-agent locations. |
| 23 | +Optional Hermes install (merge into `~/.hermes/SOUL.md`): |
30 | 24 |
|
31 | 25 | ```bash |
32 | | -# Regular |
33 | | -curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | bash -s -- regular |
34 | | - |
35 | | -# Blunt |
36 | | -curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | bash -s -- blunt |
| 26 | +curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | bash -s -- --with-hermes |
| 27 | +``` |
37 | 28 |
|
38 | | -# Accurate |
39 | | -curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | bash -s -- accurate |
| 29 | +Inspect first: |
40 | 30 |
|
41 | | -# Merged (accurate + blunt + terse) — recommended |
42 | | -curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | bash -s -- merged |
| 31 | +```bash |
| 32 | +curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh |
43 | 33 | ``` |
44 | 34 |
|
45 | | -Inspect first: `curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | less` |
46 | | - |
47 | | -If this makes your agent less annoying, drop a ⭐ — helps others find it. |
| 35 | +Prefer manual copy/paste: |
48 | 36 |
|
49 | | -Optional: include Hermes too. |
| 37 | +- [`data/agent-locations.md`](data/agent-locations.md) (paths) |
| 38 | +- direct install command below |
50 | 39 |
|
51 | 40 | ```bash |
52 | | -curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR/main/install.sh | bash -s -- merged --with-hermes |
| 41 | +mkdir -p ~/.claude ~/.gemini ~/.codex ~/.config/opencode ~/.factory ~/.pi/agent |
| 42 | +cp TLDR.md ~/.claude/CLAUDE.md |
| 43 | +cp TLDR.md ~/.gemini/AGENTS.md |
| 44 | +cp TLDR.md ~/.codex/AGENTS.md |
| 45 | +cp TLDR.md ~/AGENTS.md |
| 46 | +cp TLDR.md ~/.config/opencode/AGENTS.md |
| 47 | +cp TLDR.md ~/.factory/AGENTS.md |
| 48 | +cp TLDR.md ~/.pi/agent/AGENTS.md |
53 | 49 | ``` |
54 | 50 |
|
55 | | -`--with-hermes` preserves an existing `~/.hermes/SOUL.md`, makes a backup, and appends or updates a managed TLDR block. Use `--overwrite-hermes` only if you want prompt-only `SOUL.md`. |
56 | | - |
57 | | -Prefer to inspect the commands instead of piping to bash? Use the manual copy/paste setup in [`data/agent-locations.md`](data/agent-locations.md). |
| 51 | +## Current behavior |
58 | 52 |
|
59 | | -For chat apps or web UIs, paste the file into custom instructions, project instructions, system prompt, or a saved prompt. |
| 53 | +- default: 1 sentence |
| 54 | +- target: 3 words |
| 55 | +- default max: 6 words |
| 56 | +- 1 word if enough |
| 57 | +- longer only if user asks or needed for correctness/safety |
| 58 | +- one-word greeting for plain greetings |
| 59 | +- if multi-sentence response is required, end with: |
| 60 | + - `## TLDR` |
| 61 | + - one short sentence line below |
60 | 62 |
|
61 | | -## Verify |
62 | | - |
63 | | -The install script prints this automatically, but here is the manual check: |
| 63 | +## Verification |
64 | 64 |
|
65 | 65 | ```bash |
66 | 66 | for p in ~/.claude/CLAUDE.md ~/.gemini/AGENTS.md ~/.codex/AGENTS.md \ |
|
72 | 72 | grep -q "^# TLDR" ~/.hermes/SOUL.md 2>/dev/null && echo "✓ ~/.hermes/SOUL.md" || echo "✗ ~/.hermes/SOUL.md" |
73 | 73 | ``` |
74 | 74 |
|
75 | | -## Current defaults |
76 | | - |
77 | | -- regular: |
78 | | - - default: 1 sentence |
79 | | - - target: 3 words |
80 | | - - 1 word when sufficient |
81 | | - - default max: 6 words |
82 | | - - longer only if asked |
83 | | - - greet: 1 word |
84 | | -- accurate / merged: allow context-driven expansion from in-file rules; same brevity safety constraints still apply. |
85 | | - |
86 | | -## Example outputs |
87 | | - |
88 | | -```text |
89 | | -Port busy; free it. |
90 | | -``` |
91 | | - |
92 | | -```text |
93 | | -Yes. Start SQLite. |
94 | | -``` |
| 75 | +Smoke test: |
95 | 76 |
|
96 | | -```text |
97 | | -git reset --soft HEAD~1 |
| 77 | +```bash |
| 78 | +claude -p "What's the git command to undo the last commit but keep changes staged?" |
| 79 | +# expected: git reset --soft HEAD~1 (single line) |
98 | 80 | ``` |
99 | 81 |
|
100 | | -## What it fixes |
| 82 | +## Prompt size |
101 | 83 |
|
102 | | -- question restatement |
103 | | -- fake enthusiasm / validation |
104 | | -- command wrappers when you asked for only the command |
105 | | -- extra caveats and summary paragraphs |
106 | | -- "let me know if you want more" endings |
| 84 | +| File | Bytes | |
| 85 | +|---|:---| |
| 86 | +| [`TLDR.md`](TLDR.md) | 1,572 | |
107 | 87 |
|
108 | | -## Benchmarks |
| 88 | +## Repository map |
109 | 89 |
|
110 | | -- **TLDR.md v0.13.1:** −82.1% total prose reduction, 100% average compliance (5 agents × 5 prompts). |
111 | | -- **TLDR.md v0.14.3:** −80.0% single-turn prose reduction; −75.1% across 8-turn coding conversations; no significant decay. |
112 | | -- **TLDR.blunt.md v0.18.0:** DSPy round-2 + 5-agent cross-model validation; avg pushback 0.848, correct-user agreement 0.912, mean prose 11.0 words, validation phrases 0%. |
113 | | -- **TLDR.accurate.md v0.1.0:** Accuracy-first variant; prioritizes correctness and detail where brevity would harm precision. |
| 90 | +- `TLDR.md` — active system prompt. |
| 91 | +- `install.sh` — installer + optional Hermes merge. |
| 92 | +- `data/agent-locations.md` — where prompt is installed per agent. |
| 93 | +- `CONTRIBUTING.md` — PR workflow. |
114 | 94 |
|
115 | | -Current prompt sizes: |
| 95 | +## Full historical context |
116 | 96 |
|
117 | | -| File | Bytes | |
118 | | -|---|:---| |
119 | | -| [`TLDR.md`](TLDR.md) | 1,362 | |
120 | | -| [`TLDR.blunt.md`](TLDR.blunt.md) | 1,684 | |
121 | | -| [`TLDR.accurate.md`](TLDR.accurate.md) | 1,824 | |
122 | | -| [`TLDR.merged.md`](TLDR.merged.md) | 1,359 | |
123 | | - |
124 | | -> Note: v0.14.3 numbers measured on a prior prompt revision; current prompts are tighter (1-sentence / 3-word default / 6-word max) and have not been re-benched. |
125 | | -
|
126 | | -Full historical details: |
127 | | -- [`data/agent-locations.md`](data/agent-locations.md) |
128 | | -- [`data/benchmarks.md`](data/benchmarks.md) |
129 | | -- [`data/dspy-cross-model-results.md`](data/dspy-cross-model-results.md) |
130 | | -- [`data/changelog.md`](data/changelog.md) |
131 | | -- [`CONTRIBUTING.md`](CONTRIBUTING.md) |
| 97 | +- [data/agent-locations.md](data/agent-locations.md) |
| 98 | +- [data/benchmarks.md](data/benchmarks.md) |
| 99 | +- [data/dspy-cross-model-results.md](data/dspy-cross-model-results.md) |
| 100 | +- [data/changelog.md](data/changelog.md) |
| 101 | +- [CONTRIBUTING.md](CONTRIBUTING.md) |
132 | 102 |
|
133 | 103 | ## License |
134 | 104 |
|
|
0 commit comments