AFDocs CLI
AFDocs проверяет сайт документации на удобство для ИИ-агентов: 28 проверок по семи группам и оценка до 100 баллов.
- 111 ★ репозитория
- Последний коммит
- MIT
Минимальный доступ
Почему такой уровень
- Утилита отправляет HTTP-запросы к проверяемым сайтам, хотя и ограничивает частоту.
Установка
- Работает в
В терминале, через SkillFoxx CLI
npx skillfoxx add cli/afdocsОпределит агенты на машине, покажет уровень доступа и зафиксирует версию.
Другие способы установки
Доступ и проверки
Как мы проверяемМинимальный доступИнструмент ничего не запускает и не ходит в сеть.
- Утилита отправляет HTTP-запросы к проверяемым сайтам, хотя и ограничивает частоту.
Это чужой код. Посмотрите файлы в репозитории перед установкой.
Что делает
Консольная утилита, которая проверяет сайт документации по спецификации Agent-Friendly Documentation. Команда `npx afdocs check https://docs.example.com --format scorecard` выставляет общий балл и баллы по категориям: находимость контента, доступность в Markdown, размер страниц и обрезка длинных страниц и другие, всего 28 проверок. Для провалов выдаются подсказки по исправлению, например про файл `llms.txt` и директиву в HTML. Отчет бывает в виде таблицы оценок, есть помощники для vitest в CI и программный API на TypeScript. AFDocs лежит в основе Agent Score от Fern и нескольких сервисов оценки документации. Утилита делает HTTP-запросы к проверяемому сайту с паузой 200 мс между запросами, ограничением числа соединений и учетом `Retry-After`.
Для кого. Авторам и владельцам документации продуктов и API, которые хотят, чтобы ИИ-агенты находили и читали их страницы.
Подходит, если
- Перед релизом документации проверяют, видит ли агент `llms.txt` и страницы в Markdown.
- В CI хотят замерять оценку документации и не пропускать падение.
- Нужен список приоритетных исправлений вместо общих советов.
- Сравнивают несколько сайтов документации по одним и тем же проверкам.
Не подходит, если
- Нужна проверка человеческой читаемости и дизайна документации.
- Запросы к чужому сайту без разрешения недопустимы.
- Нужна стабильность CLI: проект на ранней стадии 0.x.
Пример запроса к агенту
Запусти `afdocs check https://docs.example.com --format scorecard` и покажи общий балл и три самых важных исправления.Ограничения
Проект на ранней стадии 0.x, идентификаторы проверок, флаги CLI и формат вывода могут меняться между минорными версиями. Реализует версию 0.6.0 спецификации от 13 сентября 2026. Нужен Node.js 22 или новее. Утилита отправляет HTTP-запросы к проверяемому сайту, поэтому проверяйте только свои сайты или сайты, на которые есть разрешение. Оценка отражает только критерии спецификации и не заменяет проверку читабельности для людей. Результат зависит от доступности сайта в момент проверки: закрытые разделы, редиректы и ограничения на частоту запросов могут занизить балл.
Как отключить. Удалите глобальный пакет командой `npm uninstall -g afdocs` или уберите его из devDependencies. Утилита не меняет проверяемые сайты и не оставляет фоновых процессов.
Частые вопросы
Как запустить проверку?
Выполните `npx afdocs check https://docs.example.com --format scorecard`. Установки не требуется.
Как поставить глобально или в проект?
`npm install -g afdocs` глобально или `npm install -D afdocs` как dev-зависимость для CI.
Сколько проверок и какие категории?
28 проверок по семи группам, например находимость контента, доступность Markdown, размер страницы и обрезка длинных страниц.
Насколько нагружает сайт?
Пауза 200 мс между запросами по умолчанию, ограничение числа соединений и учет `Retry-After`.
Для чего нужен Agent Score?
Сервис Fern на основе AFDocs выставляет оценку удобства документации для агентов.
Обсуждение
Вопросов и отзывов пока нет.
Похожие
CLI-инструментыМногоагентный генератор документации: анализирует репозиторий и собирает README и конфиги для ИИ-ассистентов
CLI и скилл: агент публикует отчеты как HTML-документы, команда их комментирует, а каждая версия сохраняется
Плагин помогает агенту поддерживать документацию проекта, решения и результаты проверок между сессиями
CLI на Python: 13 ИИ-агентов читают дата-рум сделки M&A по девяти областям и дают отчет с проверкой цитат по источнику
Набор скиллов для академических работ: рецензия статьи, план анализа, заявка на грант, проверка кода и слайды.
CLI и навык публикуют локальный HTML или Markdown по постоянной ссылке с версиями и комментариями к выделенному тексту.
Коротко о README
README показывает быстрый запуск с примером отчета, установку, ссылки на полную документацию с описанием оценок и проверок, список сервисов на базе AFDocs и правила ответственного использования.