📈 GH Trending Explorer 🎲 Surprise me

← all repos

SupportPages-io / wtfm

git clone https://github.com/SupportPages-io/wtfm.git

WTFM: Write the F***ing Manual. A plugin for your coding agent that writes your user docs, screenshots included.

+16
stars, 24h · #2,318
+~112
stars, 7 days · #1,928
+58
stars, 30 days · #11,563
58
★ total · +112% this week
4
forks · 7 open issues

Star history (as recorded here)

2026-10-22 · 42 ★ 2026-10-23 · 58 ★
LanguageJavaScript
LicenseApache-2.0
Created2026-09-25 (27d ago)
Last push2d ago
Watchers0
OwnerOrganization

GitHub topics

Links

README excerpt
WTFM 
 Write the F***ing Manual. 
 A plugin for your coding agent that writes the user docs. Screenshots included.
 Install ·
 Quick start ·
 Examples ·
 CLI ·
 Publish ·
 FAQ ·
 Docs ·
 Website 
 Real output from plausible/analytics , replayed fast. A real run takes a few minutes. 
**WTFM is a plugin for your coding agent that writes your user docs.** Ask
Claude Code or Codex
for a guide and it reads your source, writes the steps in plain language, and shows every
screen with a screenshot rendered from your real templates and CSS. No running app, no
manual captures, no account.
Not API reference, not a README: docs for the people who will never read your code,
like the customer who can't find the export button, or the admin inviting their team.
> WTFM was formerly SupportPages Writer. The `supportpages` command still works as
> an alias for `wtfm`, and existing installations, settings and `SUPPORTPAGES_*`
> environment variables are unchanged.
Set it up once in your terminal, then just ask your agent:
 [code] 
 [code] 
 [code] 
> **You → Claude Code:** Write an illustrated guide to inviting a teammate.
## Features
- **Written from your source.** Routes, button labels and flows come from the code,
 not from a description you type, so the steps match what users actually see.
- **Screenshots without running the app.** Mockups are rebuilt from your own markup,
 styles and branding, then rendered to PNG in a local headless Chromium.
- **Plain Markdown output.** Each article is an `index.md` with its images beside it,
 ready to commit next to your code or drop into any docs site.
- **Checked before it's saved.** Every article passes structure, copy and screenshot
 checks first.
- **Uses the agent you already have.** Claude Code or Codex, with your own subscription
 and model settings.
- **Local-first.** Nothing is sent to SupportPages.io unless you choose to publish.
## Examples
The same loop on other open-source codebases. Each image is one screenshot from a
guide WTFM wrote from that repository's source; the apps were never run.
| immich-app/immich · SvelteKit | paperless-ngx/paperless-ngx · Angular | maybe-finance/maybe · Rails |
| --- | --- | --- |
| | | |
| How to create a new album | How to create a tag and apply it to a document | How to add a new account |
For a whole help centre, see WTFM's own docs: every
article and screenshot there was written by WTFM from this repository.
## Install
 [code] 
The installer downloads a checksum-verified release with its own Node.js, installs
the `wtfm` command into `~/.local/bin` (no `sudo`), and offers to add it to your
`PATH`. It also installs `supportpages` as an alias for `wtfm`.
**You'll need:**
- macOS or Linux, on ARM64 or x64 (on Windows, use WSL)
- Claude Code or Codex,
 installed and signed in
- Git
Chromium for screenshots is downloaded the first time you run `wtfm setup`.
**Updating:** releases check for updates once a day and install them in the background.
Run `wtfm update` to update now, or s