Команды

Справочник команд и опций xbsl: проверка исходников, серверы LSP и MCP, веб-панель, шаблоны кода.

Справочник собран из самого инструмента – это то же, что показывает xbsl --help, только на одной странице и целиком.

Без команды xbsl проверяет указанные пути: это режим по умолчанию, и его опции перечислены в первом блоке. Остальные команды адресуют другие части инструментария.

Язык вывода переключается флагом --lang, переменной XBSL_LANG или берётся из локали системы.

Без команды: проверка исходников

Линтер исходников 1С:Элемент (пары .yaml/.xbsl).

usage: xbsl [пути] [опции]        (без команды: проверка исходников)
       xbsl <команда> [опции]

Аргументы

Параметры

Команды

Опции команды: xbsl <команда> --help. Опции выше относятся к режиму проверки.

xbsl lsp

LSP-сервер xbsl (stdio)

usage: xbsl-lsp [-h] [--project-root PROJECT_ROOT] [--select SELECT] [--ignore IGNORE]
                [--enable ENABLE] [--other-system OTHER_SYSTEM] [--as-ci [AS_CI]]
                [--as-ci-job AS_CI_JOB] [--baseline BASELINE] [--templates TEMPLATES]
                [--data-dir DATA_DIR] [--lang {ru,en}]

Параметры

xbsl mcp

MCP-сервер xbsl (stdio): линт, документация Элемента и создание метаданных как инструменты агента.

usage: xbsl mcp [-h]

Параметры

Флагов нет: сервер запускается без параметров и общается по stdio. Язык замечаний – переменная XBSL_LANG (иначе локаль системы, иначе ru). xbsl-mcp запускает этот сервер за супервизором, и сессия переживает обновление движка. Регистрация в Claude Code: claude mcp add xbsl – xbsl-mcp

xbsl web

Веб-интерфейс линтера XBSL

usage: xbsl-web [-h] [--host HOST] [--port PORT]

Параметры

xbsl templates

шаблоны кода: встроенный набор и файл пользователя (формат выгрузки EDT)

usage: xbsl templates [-h] {list,export,import,save} ...

Аргументы

Параметры

xbsl templates list

usage: xbsl templates list [-h] [--format {text,json}] [--file FILE]

Параметры

xbsl templates export

usage: xbsl templates export [-h] --output OUTPUT [--custom-only] [--file FILE]

Параметры

xbsl templates import

usage: xbsl templates import [-h] [--file FILE] source

Аргументы

Параметры

xbsl templates save

usage: xbsl templates save [-h] [--file FILE]

Параметры

xbsl baseline

Список принятых замечаний: точечные правки файла.

usage: xbsl baseline [-h] {add} ...

Аргументы

Параметры

xbsl baseline add

usage: xbsl baseline add [-h] --rule ID/ГРУППА/ТИР [--reason REASON] [--baseline ФАЙЛ]
                         [--format {text,json}] [--jobs N] [--lang {ru,en}]
                         [--element-version ВЕРСИЯ] [--data-dir КАТАЛОГ]
                         paths [paths ...]

Аргументы

Параметры

xbsl self-update

обновить xbsl распаковкой колеса с PyPI

usage: xbsl self-update [-h] [--version VERSION] [--stop-holders [{servers,all}]]

Параметры

xbsl mcp-log

журнал MCP-сервера: когда серверы запускались, как завершились и кто их остановил

usage: xbsl mcp-log [-h] [--last LAST] [--json]

Параметры

xbsl fold-comments

свернуть комментарии yaml в описание узла, которое читает среда разработки: по умолчанию только показать план

usage: xbsl fold-comments [-h] [--write] [--all] [--format {text,json}] [--compact]
                          paths [paths ...]

Аргументы

Параметры

Создание метаданных

Команды создают и правят исходники: объекты, поля, маршруты, методы, формы, подсистемы. Каждая печатает результат в JSON и проверяет линтером то, что записала; --dry-run считает изменения, не трогая файлы.

xbsl new-project

создать проект: Проект.yaml + Проект.xbsl + подсистема; см. также add-subsystem и new-object – чем наполняется новый проект

usage: xbsl new-project [-h] [--representation REPRESENTATION] [--version VERSION]
                        [--compatibility COMPATIBILITY] [--subsystem SUBSYSTEM] [--library]
                        [--dry-run]
                        root vendor name

Аргументы

Параметры

xbsl new-object

создать объект конфигурации (yaml + модуль по виду); см. также add-field – его реквизиты, add-form – его формы

usage: xbsl new-object [-h] [--scope SCOPE] [--environment ENVIRONMENT] [--access ACCESS]
                       [--routes ROUTES] [--report REPORT] [--presentation PRESENTATION]
                       [--object-presentation OBJECT_PRESENTATION]
                       [--record-presentation RECORD_PRESENTATION] [--periodicity PERIODICITY]
                       [--base BASE] [--dry-run]
                       directory kind name

Аргументы

Параметры

xbsl add-field

добавить элемент в секцию объекта: реквизит, измерение, табличную часть и другие (виды перечислены у field_kind); см. также set-field-property – свойства уже существующего элемента, set-localization – тексты строки ЛокализованныеСтроки по языкам

usage: xbsl add-field [-h] [--type TYPE] [--tabular TABULAR] [--prop КЛЮЧ=ЗНАЧЕНИЕ] [--doc DOC]
                      [--dry-run]
                      yaml_path field_kind name

Аргументы

Параметры

xbsl add-route

добавить маршруты в существующий HttpСервис; см. также new-object --routes – маршруты сразу при создании сервиса

usage: xbsl add-route [-h] [--dry-run] yaml_path routes

Аргументы

Параметры

xbsl add-method

добавить метод в модуль .xbsl, не разрывая аннотации; см. также form-handlers – заготовка обработчика события компонента

usage: xbsl add-method [-h] [--params PARAMS] [--returns RETURNS] [--annotations ANNOTATIONS]
                       [--after AFTER] [--before BEFORE] [--body BODY] [--dry-run]
                       module_path name

Аргументы

Параметры

xbsl add-form

создать формы объекта и зарегистрировать в Интерфейс; см. также form-tree – дерево созданной формы, form-handlers – её обработчики

usage: xbsl add-form [-h] [--name NAME] [--path PATH] [--forms FORMS]
                     [--card-min-width CARD_MIN_WIDTH] [--card-placeholder CARD_PLACEHOLDER]
                     [--overwrite] [--dry-run]
                     root

Аргументы

Параметры

xbsl add-subsystem

создать подсистему (папка + Подсистема.yaml); см. также new-object – объект создаётся в каталоге подсистемы

usage: xbsl add-subsystem [-h] [--representation REPRESENTATION] [--no-auto-interface]
                          [--uses USES] [--dry-run]
                          parent_dir name

Аргументы

Параметры

xbsl add-dependency

подключить библиотеку к проекту (секция Библиотеки Проект.yaml); см. также project-info – какие библиотеки уже подключены

usage: xbsl add-dependency [-h] [--path PATH] [--dry-run] root vendor name version

Аргументы

Параметры

xbsl add-localization

добавить файл перевода (секция Локализация) в элемент ЛокализованныеСтроки; см. также set-localization – текст строки сразу во всех языках

usage: xbsl add-localization [-h] [--dry-run] yaml_path language

Аргументы

Параметры

xbsl set-localization

записать строку локализации во все языки сразу: в элемент и в его переводы; см. также add-localization – добавить язык, add-field – завести саму строку

usage: xbsl set-localization [-h] [--value ЯЗЫК=ТЕКСТ] [--section SECTION] [--entries-file ФАЙЛ]
                             [--entry КЛЮЧ=JSON] [--full-text] [--dry-run]
                             yaml_path [name]

Аргументы

Параметры

xbsl set-field-property

задать свойства существующего элемента секции (константы, реквизита, свойства или события компонента …); см. также add-field – добавить элемент, rename-object – переименование

usage: xbsl set-field-property [-h] --prop КЛЮЧ=ЗНАЧЕНИЕ [--tabular TABULAR] [--dry-run]
                               yaml_path field_kind name

Аргументы

Параметры

xbsl rename-object

переименовать объект (файлы, формы) и обновить ссылки по всему проекту; см. также delete-object – удалить объект целиком

usage: xbsl rename-object [-h] [--new-presentation NEW_PRESENTATION]
                          [--old-presentation OLD_PRESENTATION] [--path PATH] [--dry-run]
                          root old_name new_name

Аргументы

Параметры

xbsl delete-object

удалить объект целиком (пара yaml+xbsl, формы, строка списка) и перечислить оставшиеся упоминания; без --apply – только план; см. также rename-object – переименовать вместо удаления

usage: xbsl delete-object [-h] [--name NAME] [--path PATH] [--apply] [--dry-run] root

Аргументы

Параметры

xbsl move-object

перенести объект в другой каталог проекта – пакет подсистемы (новый каталог становится пакетом), её корень или другую подсистему; дописывает импорт нового пространства имён туда, где он теперь нужен, и переписывает полные имена; см. также rename-package – переименовать пакет

usage: xbsl move-object [-h] [--dry-run] root yaml_path target_dir

Аргументы

Параметры

xbsl rename-package

переименовать пакет подсистемы: каталог со всеми файлами и имена Подсистема::Пакет в импортах и полных именах по проекту; см. также move-object – перенести объект в пакет

usage: xbsl rename-package [-h] [--dry-run] root package_dir new_name

Аргументы

Параметры

xbsl move-resource

перенести файл ресурса или папку в другую папку того же каталога Ресурсы (несуществующая папка создаётся): ключи Ресурс{…} и значения свойств-картинок, которые указывают на перенесённые файлы, переписываются, обращения по строке перечисляются в заметках; см. также rename-resource-folder – переименовать папку

usage: xbsl move-resource [-h] [--dry-run] root resource_path target_dir

Аргументы

Параметры

xbsl rename-resource-folder

переименовать папку внутри каталога Ресурсы: файлы переносятся, ключи Ресурс{…}, которые на них указывают, переписываются по проекту, обращения по строке перечисляются в заметках; см. также move-resource – перенести ресурс в папку, delete-resource-folder – удалить папку

usage: xbsl rename-resource-folder [-h] [--dry-run] root folder_dir new_name

Аргументы

Параметры

xbsl delete-resource-folder

удалить папку внутри каталога Ресурсы со всеми файлами и перечислить ключи Ресурс{…} и обращения по строке, которые на них указывают; без --apply – только план; см. также rename-resource-folder – переименовать вместо удаления

usage: xbsl delete-resource-folder [-h] [--apply] [--dry-run] root folder_dir

Аргументы

Параметры

xbsl set-access

задать КонтрольДоступа.Разрешения объекта; см. также object-info – текущие права и их набор у этого вида

usage: xbsl set-access [-h] [--name NAME] [--path PATH] [--default DEFAULT]
                       [--permission ПРАВО=СПОСОБ] [--calc-by CALC_BY] [--dry-run]
                       root

Аргументы

Параметры

xbsl object-info

сводка объекта: реквизиты, ТЧ, формы, namespace

usage: xbsl object-info [-h] [--name NAME] [--path PATH] root

Аргументы

Параметры

xbsl project-info

обзор исходников: проекты, подсистемы, объекты

usage: xbsl project-info [-h] [--kind KIND] [--subsystem SUBSYSTEM] [--package PACKAGE]
                         [--project PROJECT] [--brief] [--reference]
                         root

Аргументы

Параметры

xbsl resource-references

найти места, которые называют файл ресурса или папку: ключи Ресурс{…}, значения свойств-картинок и обращения по строке; ответ – JSON с файлом, диапазоном и текстом строки каждого места; см. также move-resource – перенести ресурс с правкой ключей

usage: xbsl resource-references [-h] [--limit LIMIT] root resource_path

Аргументы

Параметры

xbsl unused-resources

найти файлы в каталогах Ресурсы, до которых не дошли статические ссылки, ограниченные вычисляемые пути и ссылки из достигнутых JSON/CSS/HTML/SVG/JS; результат – кандидаты для проверки, команда ничего не удаляет

usage: xbsl unused-resources [-h] [--include-protected] [--limit LIMIT] root

Аргументы

Параметры

xbsl localization-info

языки и переводы элемента ЛокализованныеСтроки (кандидаты для add-localization; тексты пишет set-localization)

usage: xbsl localization-info [-h] yaml_path

Аргументы

Параметры

xbsl form-tree

дерево компонента интерфейса (узлы, слоты, свойства со спанами); см. также form-edit – правки узлов по их ид, form-handlers – их обработчики

usage: xbsl form-tree [-h] [--at СМЕЩЕНИЕ] [--node УЗЕЛ] [--name ИМЯ] [--max-depth УРОВНЕЙ]
                      [--no-properties] [--brief]
                      yaml_path

Аргументы

Параметры

xbsl form-edit

операция конструктора форм: точечная правка yaml компонента интерфейса. Узел задаётся путём из дерева или Имя компонента, если оно в форме одно; см. также form-tree – пути узлов, которыми адресуются правки

usage: xbsl form-edit [-h] [--parent PARENT] [--slot SLOT] [--type TYPE] [--name NAME]
                      [--node NODE] [--nodes ID[,ID...]] [--new-parent NEW_PARENT]
                      [--container CONTAINER] [--new-name NEW_NAME] [--before BEFORE]
                      [--after AFTER] [--key KEY] [--value VALUE] [--value-yaml VALUE_YAML]
                      [--fragment FRAGMENT] [--fragment-file ФАЙЛ] [--new-type NEW_TYPE]
                      [--dry-run]
                      yaml_path операция

Аргументы

Параметры

xbsl form-handlers

обработчики парного модуля компонента: список методов или заготовка обработчика; см. также form-tree – ид узлов, add-method – метод вне события

usage: xbsl form-handlers [-h] [--node NODE] [--key KEY] [--method METHOD] [--signature SIGNATURE]
                          [--dry-run]
                          yaml_path

Аргументы

Параметры