CLI-инструмент для создания README-файлов репозитория с помощью LLM или офлайн, без API-ключа.
SupportPages-io/wtfm
Плагин для Claude Code и Codex, который пишет справочные статьи для пользователей по исходному коду и создаёт скриншоты на основе разметки интерфейса.
- Звёзды
- 121
- Форки
- 10
- Открытые issues
- 7
- Последний коммит
- позавчера
Что это?
WTFM — плагин для coding-агентов, таких как Claude Code и Codex, который пишет пользовательскую документацию: инструкции и руководства по устранению неполадок для тех, кто пользуется продуктом, а не разрабатывает его. Агент читает нужные части исходного кода, берёт из него маршруты, подписи кнопок и последовательности действий, а затем описывает шаги простым языком.
К каждому экрану в руководстве прилагается скриншот. WTFM воссоздаёт макеты на основе разметки, стилей и фирменного оформления самого проекта, а затем рендерит их в PNG в локальном headless Chromium — запускать приложение или делать скриншоты вручную не нужно. Статьи сохраняются в папках с файлами Markdown и изображениями рядом; перед сохранением каждая статья проходит проверки структуры, текста и скриншотов.
Инструмент работает локально и использует вашу подписку на агента. Публикация на SupportPages.io необязательна и происходит только по вашему выбору. Поддерживаются macOS и Linux; в Windows инструмент можно использовать через WSL.
Ключевые возможности
- 01Пишет инструкции и руководства по устранению неполадок на основе исходного кода проекта.
- 02Создаёт скриншоты на основе разметки, стилей и фирменного оформления проекта, не запуская приложение.
- 03Сохраняет результат в формате Markdown, а изображения размещает рядом с соответствующими статьями.
- 04Проверяет структуру, текст и скриншоты перед сохранением.
- 05Работает с Claude Code или Codex и настраивается одной командой.
Сценарии использования
- Написать руководство для клиентов, которые не могут найти нужную функцию в продукте.
- Описать административные задачи, например приглашение участников команды или изменение настроек.
- Подготовить иллюстрированные статьи по устранению неполадок для центра поддержки.
- Хранить пользовательскую документацию в том же репозитории, что и код продукта.
Быстрый старт
- 1
Запустите официальный скрипт установки из README
- 2
Настройте компьютер
wtfm setup - 3
Настройте проект
wtfm init - 4
Попросите Claude Code или Codex написать статью в вашем проекте
Что важно знать
- Поддерживаются только macOS и Linux; пользователям Windows нужен WSL.
- Требуется установленный Claude Code или Codex с выполненным входом, а также Git.
- Chromium для создания скриншотов загружается при первом запуске настройки.
В подборках
Темы
Частые вопросы
- Что такое wtfm?
- Плагин для Claude Code и Codex, который пишет справочные статьи для пользователей по исходному коду и создаёт скриншоты на основе разметки интерфейса. WTFM — плагин для coding-агентов, таких как Claude Code и Codex, который пишет пользовательскую документацию: инструкции и руководства по устранению неполадок для тех, кто пользуется продуктом, а не разрабатывает его. Агент читает нужные части исходного кода, берёт из него маршруты, подписи кнопок и последовательности действий, а затем описывает шаги простым языком.
- wtfm можно использовать бесплатно? Какая у него лицензия?
- wtfm распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
- wtfm всё ещё поддерживается?
- Активно поддерживается. Последний коммит в wtfm — 5 нояб. 2026 г..
- Для чего можно использовать wtfm?
- Написать руководство для клиентов, которые не могут найти нужную функцию в продукте. Описать административные задачи, например приглашение участников команды или изменение настроек. Подготовить иллюстрированные статьи по устранению неполадок для центра поддержки. Хранить пользовательскую документацию в том же репозитории, что и код продукта.
- Как установить wtfm?
- Запустите официальный скрипт установки из README Настройте компьютер: wtfm setup Настройте проект: wtfm init Попросите Claude Code или Codex написать статью в вашем проекте
- Где скачать wtfm?
- Исходный код и инструкции по установке — на GitHub: https://github.com/SupportPages-io/wtfm
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Похожие проекты
Локальный браузерный интерфейс для проверки планов агентов, Markdown, HTML и diff кода: добавляйте пометки и отправляйте отзывы обратно агентам.
Бесплатная веб-база знаний для самостоятельного размещения на PHP и MySQL, с редактором статей и необязательным API только для чтения в формате JSON.
Rust CLI для управления git worktree по имени ветки, созданный для параллельной работы нескольких AI-агентов над кодом.
CLI-приложение для запуска и переключения между сессиями ИИ-агентов для программирования в Git worktree и разных проектах — без tmux.
CLI и TUI для установки, отбора и распространения библиотеки навыков для AI-агентов программирования; в комплекте — подборка автора.