seiso CLI
Линтер и соглашение для Markdown-документов проекта, написанных ИИ: у каждого факта один дом, у страницы один вид.
- 195 ★ репозитория
- Последний коммит
- MIT
Минимальный доступ
Почему такой уровень
- Утилита читает Markdown репозитория и пишет только файл `seiso.toml`.
Установка
- Работает в
В терминале, через SkillFoxx CLI
npx skillfoxx add cli/seisoОпределит агенты на машине, покажет уровень доступа и зафиксирует версию.
Другие способы установки
Доступ и проверки
Как мы проверяемМинимальный доступИнструмент ничего не запускает и не ходит в сеть.
- Утилита читает Markdown репозитория и пишет только файл `seiso.toml`.
Это чужой код. Посмотрите файлы в репозитории перед установкой.
Что делает
seiso задает единое соглашение об организации Markdown в репозитории, как rustfmt для кода Rust. Каждый документ объявляет один вид, например `howto`, `reference` или `adr`, и содержит только то, для чего этот вид нужен. Факт живет в одном месте, остальные страницы ссылаются на него. Правила проверяют документы по спецификации: быстро меняющиеся значения вроде версий и счетчиков на долгоживущих страницах, указатели без файла или символа, обращения к заказчику и рассказ о том, как писалась страница. Каждое замечание называет место и способ исправления, так что агент чинит большую часть находок по выводу. Команда `seiso init` пишет стартовый `seiso.toml`, `seiso check` запускает стабильные правила, а `--preview` включает опытные.
Для кого. Командам, где агенты пишут документацию быстрее, чем люди успевают ее читать, и страницы устаревают и противоречат друг другу.
Подходит, если
- В README и в `docs/` версия указана в трех местах, и две из них отстали.
- Агент переписал документацию, и надо поймать страницы без ясного вида: смесь how-to и обоснований.
- Проверку документов подключают к CI и к хуку Claude Code после правок.
- Новому репозиторию нужна стартовая раскладка видов документов командой `seiso init`.
Не подходит, если
- Нужна проверка орфографии и форматирования Markdown: ими занимаются другие инструменты.
- Надо определить, звучит ли текст как написанный машиной.
- Документы не относятся к проекту и не требуют вида и источника.
Пример запроса к агенту
Запусти seiso check по репозиторию и исправь найденные нарушения по подсказкам, а спорные решения о хозяине факта вынеси мне.Ограничения
Соглашение пока предварительное: спецификация версионируется отдельно и до 1.0.0 может меняться. Стабильные правила идут по умолчанию, остальные работают только под `--preview`, дают ложные срабатывания и не годятся для барьеров CI. Выводы `seiso init` надо просмотреть до применения. Утилита не угадывает, звучит ли текст машинным, и не проверяет написание. Суждения вроде выбора страницы-хозяина факта записываются в замечании как решение человека.
Как отключить. Удалите бинарник командой `cargo uninstall seiso`, `uv tool uninstall seiso` или `npm uninstall -g @scarletkc/seiso`. Файл `seiso.toml` и записи в хуках и CI удалите вручную.
Частые вопросы
Как поставить seiso?
`cargo install seiso`. Альтернативы: `uv tool install seiso` или `pipx install seiso` и `npm install -g @scarletkc/seiso`. Пакеты PyPI и npm содержат готовые бинарники для macOS, Linux и Windows.
Какие виды документов есть?
Например `howto`, `reference` и `adr`. Как-то правило: инструкция дает шаги, обоснование устройства уходит в ADR.
Как узнать, что значит правило?
Командой `seiso rule <CODE>`: она объясняет правило с примерами. `seiso rule --all` перечисляет правила со статусом.
Как подключить к Claude Code?
В руководстве по интеграциям описаны хуки Claude Code, pre-commit и CI. Файл `.pre-commit-hooks.yaml` лежит в репозитории.
Что делает `seiso parse`?
Показывает модель документов без запуска правил, чтобы разобраться, как seiso прочитал Markdown.
Обсуждение
Вопросов и отзывов пока нет.
Похожие
CLI-инструментыПорт docling на Rust превращает PDF, Office, HTML и сканы в Markdown и JSON одним бинарником, с режимом MCP-сервера
CLI проверяет и форматирует Markdown, чтобы агент сначала показал нарушения, затем применил согласованные исправления.
Семь скиллов простого языка по мотивам ISO 24495: юридические тексты, техническое письмо, аудит документов и стиль ответов агента
Скилл-конвейер документов: что угодно в markdown, markdown в аккуратный html и docx уровня издательства, html обратно в markdown
CLI и скилл выгружают документы, таблицы и вики Feishu и Lark в Markdown, а агенту дают читать и дописывать их.
CLI и скилл: агент публикует отчеты как HTML-документы, команда их комментирует, а каждая версия сохраняется
Коротко о README
Реализация вынесена отдельно от спецификации соглашения, у нее есть примеры и руководство по внедрению на сайте проекта. Правила проходят критерии продвижения, прежде чем становятся стабильными.