wtf-p 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +338 -0
  3. package/bin/install.js +358 -0
  4. package/bin/uninstall.js +485 -0
  5. package/commands/wtfp/analyze-bib.md +326 -0
  6. package/commands/wtfp/check-refs.md +205 -0
  7. package/commands/wtfp/create-outline.md +275 -0
  8. package/commands/wtfp/discuss-section.md +71 -0
  9. package/commands/wtfp/export-latex.md +216 -0
  10. package/commands/wtfp/help.md +342 -0
  11. package/commands/wtfp/insert-section.md +130 -0
  12. package/commands/wtfp/list-assumptions.md +109 -0
  13. package/commands/wtfp/map-project.md +197 -0
  14. package/commands/wtfp/new-paper.md +443 -0
  15. package/commands/wtfp/pause-writing.md +145 -0
  16. package/commands/wtfp/plan-revision.md +180 -0
  17. package/commands/wtfp/plan-section.md +247 -0
  18. package/commands/wtfp/polish-prose.md +177 -0
  19. package/commands/wtfp/progress.md +325 -0
  20. package/commands/wtfp/remove-section.md +147 -0
  21. package/commands/wtfp/research-gap.md +235 -0
  22. package/commands/wtfp/resume-writing.md +142 -0
  23. package/commands/wtfp/review-section.md +409 -0
  24. package/commands/wtfp/submit-milestone.md +211 -0
  25. package/commands/wtfp/write-section.md +273 -0
  26. package/package.json +40 -0
  27. package/write-the-f-paper/references/checkpoints.md +213 -0
  28. package/write-the-f-paper/references/continuation-format.md +223 -0
  29. package/write-the-f-paper/references/git-integration.md +241 -0
  30. package/write-the-f-paper/references/imrad-structure.md +212 -0
  31. package/write-the-f-paper/references/length-estimation.md +148 -0
  32. package/write-the-f-paper/references/plan-format.md +361 -0
  33. package/write-the-f-paper/references/principles.md +158 -0
  34. package/write-the-f-paper/references/questioning.md +132 -0
  35. package/write-the-f-paper/references/research-pitfalls.md +208 -0
  36. package/write-the-f-paper/templates/config.json +30 -0
  37. package/write-the-f-paper/templates/context.md +179 -0
  38. package/write-the-f-paper/templates/continue-here.md +142 -0
  39. package/write-the-f-paper/templates/data-inventory.md +142 -0
  40. package/write-the-f-paper/templates/discovery.md +146 -0
  41. package/write-the-f-paper/templates/issues.md +59 -0
  42. package/write-the-f-paper/templates/manuscript.md +253 -0
  43. package/write-the-f-paper/templates/narrative-arc.md +227 -0
  44. package/write-the-f-paper/templates/outline.md +274 -0
  45. package/write-the-f-paper/templates/phase-prompt.md +348 -0
  46. package/write-the-f-paper/templates/prior-drafts.md +204 -0
  47. package/write-the-f-paper/templates/project-context/argument-structure.md +267 -0
  48. package/write-the-f-paper/templates/project-context/bibliography.md +152 -0
  49. package/write-the-f-paper/templates/project-context/gaps.md +122 -0
  50. package/write-the-f-paper/templates/project-context/imrad.md +140 -0
  51. package/write-the-f-paper/templates/project-context/peer-review.md +152 -0
  52. package/write-the-f-paper/templates/project-context/style-guide.md +198 -0
  53. package/write-the-f-paper/templates/project-context/tools.md +170 -0
  54. package/write-the-f-paper/templates/project.md +185 -0
  55. package/write-the-f-paper/templates/research.md +384 -0
  56. package/write-the-f-paper/templates/review-comments.md +253 -0
  57. package/write-the-f-paper/templates/revision-issues.md +169 -0
  58. package/write-the-f-paper/templates/roadmap.md +187 -0
  59. package/write-the-f-paper/templates/section-archive.md +178 -0
  60. package/write-the-f-paper/templates/section-context.md +114 -0
  61. package/write-the-f-paper/templates/section.md +128 -0
  62. package/write-the-f-paper/templates/state.md +244 -0
  63. package/write-the-f-paper/templates/summary.md +277 -0
  64. package/write-the-f-paper/venues/acm-cs.yaml +102 -0
  65. package/write-the-f-paper/venues/arxiv-ml.yaml +103 -0
  66. package/write-the-f-paper/venues/ieee-cs.yaml +100 -0
  67. package/write-the-f-paper/venues/nature.yaml +81 -0
  68. package/write-the-f-paper/venues/thesis-chapter.yaml +101 -0
  69. package/write-the-f-paper/workflows/create-outline.md +462 -0
  70. package/write-the-f-paper/workflows/create-outline.wcn.md +194 -0
  71. package/write-the-f-paper/workflows/discuss-section.md +249 -0
  72. package/write-the-f-paper/workflows/discuss-section.wcn.md +63 -0
  73. package/write-the-f-paper/workflows/execute-section.md +704 -0
  74. package/write-the-f-paper/workflows/execute-section.wcn.md +219 -0
  75. package/write-the-f-paper/workflows/list-assumptions.md +183 -0
  76. package/write-the-f-paper/workflows/list-assumptions.wcn.md +42 -0
  77. package/write-the-f-paper/workflows/lit-review-phase.md +281 -0
  78. package/write-the-f-paper/workflows/lit-review-phase.wcn.md +92 -0
  79. package/write-the-f-paper/workflows/map-project.md +359 -0
  80. package/write-the-f-paper/workflows/map-project.wcn.md +73 -0
  81. package/write-the-f-paper/workflows/plan-section.md +409 -0
  82. package/write-the-f-paper/workflows/plan-section.wcn.md +236 -0
  83. package/write-the-f-paper/workflows/research-gap.md +469 -0
  84. package/write-the-f-paper/workflows/research-gap.wcn.md +119 -0
  85. package/write-the-f-paper/workflows/resume-paper.md +274 -0
  86. package/write-the-f-paper/workflows/resume-paper.wcn.md +93 -0
  87. package/write-the-f-paper/workflows/review-section.md +329 -0
  88. package/write-the-f-paper/workflows/review-section.wcn.md +91 -0
  89. package/write-the-f-paper/workflows/submit-draft.md +368 -0
  90. package/write-the-f-paper/workflows/submit-draft.wcn.md +69 -0
  91. package/write-the-f-paper/workflows/transition.md +375 -0
  92. package/write-the-f-paper/workflows/transition.wcn.md +113 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Anthony Kougkas
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,338 @@
1
+ <div align="center">
2
+
3
+ # WRITE THE F***ING PAPER
4
+
5
+ **The G.O.A.T. meta-prompting system for 10x researchers who need to submit papers/proposals YESTERDAY.**
6
+
7
+ ```bash
8
+ npx wtfp
9
+ ```
10
+
11
+ **Runs on everything. Mac, Windows, Linux. No excuses.**
12
+ *(You need LaTeX and BibTeX or you're NGMI)*
13
+
14
+ > "Bro, if you have the data, this ships the manuscript. Zero writer's block."
15
+
16
+ > "I tried Overleaf and Notion — weak sauce. This tool actually ships words."
17
+
18
+ > "Literally the most based addition to my stack. It just writes the f*ing paper."
19
+
20
+ **Used by absolute legends at Gnosis Research Center at Illinois Tech.**
21
+
22
+ [The Alpha](#the-alpha-why-i-built-this) · [The Stack](#the-stack) · [The Commands](#the-toolkit) · [The Logic](#the-logic)
23
+
24
+ </div>
25
+
26
+ ---
27
+
28
+ ## The Alpha (Why I Built This)
29
+
30
+ Yo, I'm leading the Gnosis Research Center at Illinois Tech. I got grants to win, labs to run, and exactly zero time to stare at a blinking cursor like an NPC. My PhD students? Same story.
31
+
32
+ Other tools? Garbage. **Jasper?** Hallucinates. **ChatGPT?** Sounds like a robot trying to pass a Turing test. They don't get structure. They don't respect the citations.
33
+
34
+ So I cooked up **WTF-P**. We're talking high-leverage context maxxing here. Under the hood? It's parsing BibTeX, mapping arguments, and enforcing that IMRaD structure so hard. You feed it data, it spits out submission-ready drafts.
35
+
36
+ I trust the system. It builds the frame so I can just come in and drop the knowledge.
37
+
38
+ **No more "writer's block" excuses. We are shipping papers before the deadline. Period.**
39
+
40
+ — *akougkas (Nerd ^ academic+coder)*
41
+
42
+ > Academic writing is usually chaotic evil. You ask AI for a lit review, it invents papers. Total beta move.
43
+ > **WTF-P fixes that.** It's the grounding layer that makes Claude Code academic weapon grade. Describe the hypothesis, drop the .bib, and watch it cook.
44
+
45
+ ### Who This Is For
46
+ PhDs, Postdocs, and PIs who are done playing games and need to submit the damn proposal/paper/report **right now**.
47
+
48
+ ---
49
+
50
+ ## Let's Go
51
+
52
+ ```bash
53
+ npx wtfp
54
+ ```
55
+
56
+ Boom. Done. Check `/wtfp:help` if you're lost.
57
+
58
+ <details>
59
+ <summary><strong>Headless / CI / HPC (For the devops wizards)</strong></summary>
60
+
61
+ ```bash
62
+ npx wtfp --global # Install to ~/.claude/
63
+ npx wtfp --local # Install to ./.claude/
64
+ ```
65
+ </details>
66
+
67
+ <details>
68
+ <summary><strong>Custom Location (For the organized)</strong></summary>
69
+
70
+ ```bash
71
+ # Install to a custom Claude config directory
72
+ npx wtfp --global --config-dir ~/projects/my-paper/.claude
73
+
74
+ # Or use environment variable
75
+ CLAUDE_CONFIG_DIR=~/research/.claude npx wtfp --global
76
+ ```
77
+ </details>
78
+
79
+ <details>
80
+ <summary><strong>Upgrade / Reinstall (For the cautious)</strong></summary>
81
+
82
+ When upgrading, WTF-P respects your existing files:
83
+
84
+ ```bash
85
+ # Interactive: prompts for each conflict (overwrite/skip/backup)
86
+ npx wtfp --global
87
+
88
+ # Force overwrite everything (yolo mode)
89
+ npx wtfp --global --force
90
+
91
+ # Backup all existing files before overwriting
92
+ npx wtfp --global --backup-all
93
+ ```
94
+ </details>
95
+
96
+ <details>
97
+ <summary><strong>Uninstall (For the tidy)</strong></summary>
98
+
99
+ ```bash
100
+ # Interactive uninstall
101
+ npx wtf-p-uninstall --global
102
+
103
+ # Preview what would be removed
104
+ npx wtf-p-uninstall --global --dry-run
105
+
106
+ # Backup before removing
107
+ npx wtf-p-uninstall --global --backup
108
+
109
+ # Also clean up backup files from prior installs
110
+ npx wtf-p-uninstall --global --clean-backups
111
+ ```
112
+
113
+ Only WTF-P files are removed. Your `CLAUDE.md`, `settings.json`, and other configs stay intact.
114
+ </details>
115
+
116
+ <details>
117
+ <summary><strong>Dev Mode (For the builders)</strong></summary>
118
+
119
+ Clone it, build it, break it:
120
+
121
+ ```bash
122
+ git clone https://github.com/akougkas/wtfp.git
123
+ cd wtfp
124
+ node bin/install.js --local
125
+ ```
126
+ </details>
127
+
128
+ ### Pro Move: God Mode
129
+ WTF-P is designed for flow state. Don't let permissions slow you down.
130
+
131
+ ```bash
132
+ claude --dangerously-skip-permissions
133
+ ```
134
+
135
+ > [!TIP]
136
+ > This is the way. Stopping to approve `cat research_notes.txt` 50 times is strictly for amateurs.
137
+
138
+ ---
139
+
140
+ ## The Workflow
141
+
142
+ ### 1. The Setup
143
+ ```bash
144
+ /wtfp:new-paper
145
+ ```
146
+ It grills you until it gets the alpha—your research questions, methods, findings. Creates `MANUSCRIPT.md`.
147
+
148
+ ### 2. The Skeleton
149
+ ```bash
150
+ /wtfp:create-outline
151
+ ```
152
+ Generates:
153
+ - `OUTLINE.md` — The IMRaD backbone.
154
+ - `ARGUMENT.md` — The logic flow.
155
+ - `REFS.md` — Citations mapped to sections. **No hallucinations allowed.**
156
+
157
+ ### 3. The Grind
158
+ ```bash
159
+ /wtfp:plan-section 1 # Atomic planning
160
+ /wtfp:write-section # Agent swarm execution
161
+ ```
162
+ Each section runs in a fresh subagent context. 200k tokens of pure synthesis. No degradation. It reads only what it needs. Surgical precision.
163
+
164
+ ### 4. The Finish
165
+ ```bash
166
+ /wtfp:polish-prose # De-robotize the text
167
+ /wtfp:check-refs # BibTeX audit
168
+ /wtfp:export-latex # LaTeX injection
169
+ ```
170
+ Ship the draft to your advisor. Get roasted. Iterate. The system is modular—you never get stuck in a monolithic doc.
171
+
172
+ ---
173
+
174
+ ## Resurrecting Dead Papers
175
+
176
+ Got a paper rotting in a drawer? We're bringing it back to life.
177
+
178
+ ### 1. Context Maxxing
179
+ ```bash
180
+ /wtfp:map-project
181
+ ```
182
+ Spawns agents to raid your directory. Creates `.planning/context/`:
183
+
184
+ | Document | The Vibe |
185
+ | :--- | :--- |
186
+ | `LIT_REVIEW.md` | Your .bib analysis. |
187
+ | `CURRENT_DRAFT.md` | The half-baked stuff you wrote 6 months ago. |
188
+ | `DATA_SUMMARY.md` | Your results/figures decoded. |
189
+ | `STYLE_GUIDE.md` | Nature/IEEE specs. |
190
+ | `GAPS.md` | Where you messed up. |
191
+
192
+ ### 2. Re-Init
193
+ ```bash
194
+ /wtfp:new-paper
195
+ ```
196
+ Same as fresh, but now it knows your history.
197
+
198
+ ### 3. Grind
199
+ `/wtfp:create-outline` → `/wtfp:plan-section` → `/wtfp:write-section`
200
+
201
+ ---
202
+
203
+ ## Why It Crushes
204
+
205
+ ### Context Maxxing
206
+ Claude Code is cracked if you give it the right juice. Most profs just dump a PDF and pray.
207
+ WTF-P handles the prompt engineering:
208
+
209
+ | File | Function |
210
+ | :--- | :--- |
211
+ | `MANUSCRIPT.md` | The Vision. Always active. |
212
+ | `OUTLINE.md` | The Backbone. |
213
+ | `FLOW.md` | The Rhetoric. |
214
+ | `DRAFT_PLAN.md` | The Battle Plan. |
215
+ | `CRITIQUE.md` | Reviewer #2 Simulator. |
216
+
217
+ ### XML Prompts (The Secret Sauce)
218
+ We use structured XML so Claude doesn't go off the rails:
219
+
220
+ ```xml
221
+ <section type="synthesis">
222
+ <title>3.2 Neural Architecture Search</title>
223
+ <inputs>
224
+ <file>data/results_table_3.csv</file>
225
+ </inputs>
226
+ <citations>
227
+ <cite>vaswani2017attention</cite>
228
+ </citations>
229
+ <instruction>
230
+ Describe the modified ResNet block.
231
+ Tone: Objective, technical, gigabrain.
232
+ </instruction>
233
+ </section>
234
+ ```
235
+ Precise. No hallucinations. Pure signal.
236
+
237
+ ### Subagent Swarm
238
+ Writing 10k words? Context windows get full. The AI gets dumb.
239
+ WTF-P prevents this. Every section = Fresh Agent.
240
+
241
+ | Section | Context | Quality |
242
+ | :--- | :--- | :--- |
243
+ | Intro | Fresh | 🔥 |
244
+ | Methods | Fresh | 🔥 |
245
+ | Discussion | Fresh | 🔥 |
246
+
247
+ No degradation. Walk away, come back to a finished Methods section.
248
+
249
+ ### Atomic Commits
250
+ Every draft gets a git commit instantly:
251
+ ```text
252
+ abc123f text(intro): complete problem statement
253
+ def456g text(methods): draft experimental setup
254
+ ```
255
+
256
+ > [!NOTE]
257
+ > **Benefits:** Version control for your thesis. If a draft is mid, `git revert`.
258
+
259
+ ### WCN Mode (Lite Context)
260
+ Running on smaller models? Limited context window? Free-tier Claude?
261
+
262
+ WCN (Workflow Compression Notation) cuts workflow tokens by **35-50%** with zero quality loss. Verified on Haiku and Sonnet.
263
+
264
+ ```bash
265
+ # Switch to compressed workflows
266
+ ./tools/wcn/swap-workflows.sh wcn
267
+
268
+ # Switch back to verbose
269
+ ./tools/wcn/swap-workflows.sh verbose
270
+ ```
271
+
272
+ | Mode | create-outline | plan-section | Best For |
273
+ | :--- | :--- | :--- | :--- |
274
+ | Verbose | 13,029 chars | 13,655 chars | Opus, unlimited plans |
275
+ | WCN | 6,676 chars | 8,863 chars | Haiku, Sonnet, free tiers |
276
+
277
+ > [!TIP]
278
+ > WCN uses structured notation (`[step:]`, `IF→`, `RUN:`) that smaller models parse just as well. You lose nothing but tokens.
279
+
280
+ ---
281
+
282
+ ## The Toolkit
283
+
284
+ ### Setup & Planning
285
+ | Command | Payload |
286
+ | :--- | :--- |
287
+ | `/wtfp:new-paper` | Start the grind. Picks venue template (ACM/IEEE/ML/Nature). |
288
+ | `/wtfp:create-outline` | Build the skeleton from venue structure. |
289
+ | `/wtfp:map-project` | Analyze the ruins of old drafts. |
290
+ | `/wtfp:analyze-bib` | BibTeX intelligence. Cluster topics, find seminal works, map citations to sections. |
291
+ | `/wtfp:discuss-section [N]` | Gather section context before planning. |
292
+
293
+ ### Writing & Execution
294
+ | Command | Payload |
295
+ | :--- | :--- |
296
+ | `/wtfp:plan-section [N]` | Tactical planning. |
297
+ | `/wtfp:write-section` | Execute the draft. |
298
+ | `/wtfp:progress` | Stats check. |
299
+ | `/wtfp:insert-section [N]` | Add missing sauce. |
300
+ | `/wtfp:remove-section [N]` | Kill your darlings. |
301
+ | `/wtfp:research-gap` | Find the holes in literature. |
302
+ | `/wtfp:list-assumptions` | Logic check. |
303
+
304
+ ### Review & Polish
305
+ | Command | Payload |
306
+ | :--- | :--- |
307
+ | `/wtfp:review-section [N]` | Reviewer personas: Hostile, Area Chair, Editor, Mentor. |
308
+ | `/wtfp:plan-revision [N]` | Fix the damage. |
309
+ | `/wtfp:polish-prose` | De-robotize the text. Kill AI-speak. |
310
+ | `/wtfp:check-refs` | BibTeX audit. Find missing/unused citations. |
311
+
312
+ ### Export & State
313
+ | Command | Payload |
314
+ | :--- | :--- |
315
+ | `/wtfp:export-latex` | Generate .tex (The final boss). |
316
+ | `/wtfp:submit-milestone` | Version lock. |
317
+ | `/wtfp:pause-writing` | Save state. |
318
+ | `/wtfp:resume-writing` | Load state. |
319
+ | `/wtfp:help` | RTFM. |
320
+
321
+ ### Venue Templates
322
+ | Template | Structure |
323
+ | :--- | :--- |
324
+ | `acm-cs` | Intro → Background → Approach → Eval → Related → Conclusion |
325
+ | `ieee-cs` | Intro → Background/Related → Design → Impl → Eval → Conclusion |
326
+ | `arxiv-ml` | Intro → Related → Prelim → Method → Experiments → Conclusion |
327
+ | `nature` | Intro → Methods → Results → Discussion (classic IMRaD) |
328
+ | `thesis` | Flexible chapter structure for dissertations |
329
+
330
+ ---
331
+
332
+ ## License
333
+ MIT License. Open source, open science.
334
+
335
+ <div align="center">
336
+ <br>
337
+ <strong>Claude Code is powerful. WTF-P makes it tenured.</strong>
338
+ </div>