Repolode
Submit
SupportPages-io

SupportPages-io/wtfm

A plugin for Claude Code and Codex that writes end-user help articles from your source code, with screenshots rendered from your own UI markup.

View on GitHubWebsite
Stars
121
Forks
10
Open issues
7
Last commit
2 days ago

What is it?

WTFM is a plugin for coding agents such as Claude Code and Codex that writes end-user documentation: how-to and troubleshooting guides for people who use a product rather than build it. The agent reads the relevant source, takes routes, button labels and flows from the code, and writes the steps in plain language.

Each screen in a guide is shown with a screenshot. WTFM rebuilds mockups from the project's own markup, styles and branding, then renders them to PNG in a local headless Chromium, so no running app or manual capture is needed. Articles are saved as Markdown folders with their images beside them, and each article passes structure, copy and screenshot checks before it is saved.

The tool runs locally with your own agent subscription. Publishing to SupportPages.io is optional and only happens when you choose it. macOS and Linux are supported, with Windows usable through WSL.

Key features

  • 01Writes how-to and troubleshooting articles from the project's source code.
  • 02Renders screenshots from the project's own markup, styles and branding without running the app.
  • 03Outputs plain Markdown with images stored beside each article.
  • 04Checks structure, copy and screenshots before saving.
  • 05Works with Claude Code or Codex through a one-time setup command.

Use cases

  • Writing a guide for customers who cannot find a feature in your product.
  • Documenting admin tasks such as inviting team members or changing settings.
  • Producing illustrated troubleshooting articles for a help centre.
  • Keeping user documentation in the same repository as the product code.

Quick start

  1. 1

    Run the official install script from the README

  2. 2

    Set up your computer

    wtfm setup
  3. 3

    Set up your project

    wtfm init
  4. 4

    Ask Claude Code or Codex in your project to write an article

Things to know

  • Supports macOS and Linux only; Windows users need WSL.
  • Requires Claude Code or Codex installed and signed in, plus Git.
  • Chromium for screenshots is downloaded the first time you run setup.

In collections

Claude Code tools, skills & pluginsOpen-source AI agent frameworks & appsAI coding assistants & agentsCLI & terminal toolsStatic site generators & documentation tools

Topics

#ai-agents#technical-writing#documentation#user-documentation#screenshots#claude-code#markdown#cli#codex#help-center

FAQ

What is wtfm?
A plugin for Claude Code and Codex that writes end-user help articles from your source code, with screenshots rendered from your own UI markup. WTFM is a plugin for coding agents such as Claude Code and Codex that writes end-user documentation: how-to and troubleshooting guides for people who use a product rather than build it. The agent reads the relevant source, takes routes, button labels and flows from the code, and writes the steps in plain language.
Is wtfm free to use? What license does it have?
wtfm is open source under the Apache-2.0 license. Check the license terms before using it in commercial products.
Is wtfm still maintained?
Actively maintained. The last commit to wtfm was on Nov 5, 2026.
What can I use wtfm for?
Writing a guide for customers who cannot find a feature in your product. Documenting admin tasks such as inviting team members or changing settings. Producing illustrated troubleshooting articles for a help centre. Keeping user documentation in the same repository as the product code.
How do I install wtfm?
Run the official install script from the README Set up your computer: wtfm setup Set up your project: wtfm init Ask Claude Code or Codex in your project to write an article
Where can I get wtfm?
The source code and installation instructions are on GitHub: https://github.com/SupportPages-io/wtfm

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects