You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The best contributions are small and specific:
10
10
11
11
- bug reports where TLDR.md made an agent worse
12
12
- examples of agents/apps where the prompt works or fails
13
-
- tighter wording for [`TLDR.md`](TLDR.md) or [`TLDR.blunt.md`](TLDR.blunt.md)
13
+
- tighter wording for [`TLDR.md`](TLDR.md), [`TLDR.blunt.md`](TLDR.blunt.md), [`TLDR.accurate.md`](TLDR.accurate.md), or [`TLDR.merged.md`](TLDR.merged.md)
14
14
- docs fixes, install notes, or agent-specific path updates
15
15
- benchmark results from your own setup
16
16
@@ -56,7 +56,7 @@ Please include:
56
56
- agent/app name
57
57
- version if known
58
58
- where instructions should be installed
59
-
- whether it uses [`TLDR.md`](TLDR.md) or [`TLDR.blunt.md`](TLDR.blunt.md)
59
+
- whether it uses [`TLDR.md`](TLDR.md), [`TLDR.blunt.md`](TLDR.blunt.md), [`TLDR.accurate.md`](TLDR.accurate.md), or [`TLDR.merged.md`](TLDR.merged.md)
`--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`.
@@ -57,7 +69,7 @@ for p in ~/.claude/CLAUDE.md ~/.gemini/AGENTS.md ~/.codex/AGENTS.md \
-**TLDR.accurate.md v0.1.0:** Accuracy-first variant; prioritizes correctness and detail where brevity would harm precision.
95
112
96
113
Current prompt sizes:
97
114
@@ -101,12 +118,7 @@ Current prompt sizes:
101
118
|[`TLDR.blunt.md`](TLDR.blunt.md)| 1,487 |
102
119
|[`TLDR.accurate.md`](TLDR.accurate.md)| 1,627 |
103
120
104
-
These benchmark results were measured on earlier shipped prompts. The current prompt files were later tightened to a 1-sentence / 3-word-default / 6-word-max profile and have not yet been rerun through the full bench.
105
-
106
-
-**TLDR.md v0.13.1:** −82.1% total prose reduction, 100% average compliance (5 agents × 5 prompts).
107
-
-**TLDR.md v0.14.3:** −80.0% single-turn prose reduction; −75.1% across 8-turn coding conversations; no significant decay.
-**TLDR.accurate.md v0.1.0:** Accuracy-first variant; prioritizes correctness and detail where brevity would harm precision.
121
+
> 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.
-**Sensitive issues:** please use [GitHub security advisories](https://github.com/jqbit/TLDR/security/advisories/new).
10
+
-**Non-sensitive issues:** open a regular [issue](https://github.com/jqbit/TLDR/issues).
11
+
12
+
Aspirational response time: **within 7 days**. No guarantees — this is a personal project.
13
+
14
+
## Scope
15
+
16
+
This repo ships prompt files and an install script. The primary attack surface is the install script (`install.sh`), which is intended to be run via `curl | bash`.
17
+
18
+
**Please inspect `install.sh` before running it.**
Copy file name to clipboardExpand all lines: data/agent-locations.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,9 @@
2
2
3
3
Where to drop `TLDR.md` (or `TLDR.blunt.md`) for each supported coding-agent CLI.
4
4
5
-
> **Both variants use the same file paths.** Pick the variant you want — drop it at the path. TLDR.md = terse only. TLDR.blunt.md = terse + anti-sycophancy.
5
+
> **Both variants use the same file paths.** Pick the variant you want — drop it at the path. TLDR.md = terse only. TLDR.blunt.md = terse + anti-sycophancy. TLDR.accurate.md = terse + accuracy. TLDR.merged.md = all combined.
6
+
>
7
+
> **Most people: merged.** Pick `TLDR.merged.md` unless you have a reason not to.
6
8
7
9
## The eight files
8
10
@@ -27,16 +29,16 @@ No clone. No editing. Installs to the 7 standard coding-agent locations.
`--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`.
@@ -47,17 +49,17 @@ curl -fsSL https://raw.githubusercontent.com/jqbit/TLDR.md/main/install.sh | bas
0 commit comments