Интерфейс командной строки утилиты ring

При установке 1C:EDT также устанавливается утилита ring, входящая в состав платформы «1С:Предприятие 8». С ее помощью вы можете выполнять ряд операций, автоматизирующих ваш процесс разработки. Все команды, предназначенные для работы 1C:EDT находятся в модуле edt этой утилиты.

Стандартно утилита ring находится в каталоге:

Чтобы получить справку по всем командам интерфейса командной строки, выполните:

ring edt@2021.3.1:x86_64 help

где 2021.3.1:x86_64 — версия интересующего вас модуля edt.

Получить список всех установленных модулей (с версиями) можно командой:

ring help modules

Список версий платформы

Чтобы получить список поддерживаемых версий платформы используйте команду platform-versions. Она имеет один параметр:

--edt-location
Каталог, содержащий нужную версию 1C:EDT. Если параметр не задан, то используется либо версия по умолчанию, либо самая ранняя установка, связанная с модулем edt
Примечание: Для выполнения любого действия с 1C:EDT инициализируется контейнер с OSGi, которому требуется рабочая область. Поэтому при выполнении этой команды будет создана временная рабочая область в temp-каталоге пользователя. Она будет удалена после выполнения команды.

Например:

ring edt@2021.3.1:x86_64 platform-versions

Список версий 1C:EDT

Чтобы получить список установленных версий 1C:EDT используйте команду list из подсистемы locations. Она не имеет параметров.

Например:

ring edt@2021.3.1:x86_64 locations list

Назначить версию 1C:EDT по умолчанию

Чтобы назначить версию 1C:EDT по умолчанию для данного модуля используйте команду set-default из подсистемы locations.

Она имеет один параметр — путь к установленной версии 1C:EDT. Используйте значение @none чтобы сбросить установку по умолчанию

Например:

ring edt@2021.3.1:x86_64 locations set-default C:\Program Files\1C\1CE\components\1c-edt-2021.3.1+18-x86_64

Оптимизировать формат хранения данных проекта

Чтобы оптимизировать формат хранения данных проекта используйте команду clean-up-source из подсистемы workspace. Она имеет следующие параметры:

--workspace-location
Обязательный параметр. Каталог рабочей области
--edt-location
Каталог, содержащий нужную версию 1C:EDT. Если параметр не задан, то используется либо версия по умолчанию, либо самая ранняя установка, связанная с модулем edt
--project
Каталог проекта, который нужно оптимизировать. Одновременно можно использовать только один параметр: project или project-name.
--project-name
Имя проекта в текущей рабочей области, который нужно оптимизировать. Одновременно можно использовать только один аргумент: project или project-name.

Пример:

ring edt@2021.3.1:x86_64 workspace clean-up-source --workspace-location C:\projects\2021.3.0

Экспорт проекта в xml-выгрузку конфигурации

Чтобы конвертировать проект из файлового представления 1C:EDT в xml-выгрузку конфигурации используйте команду export из подсистемы workspace. Она имеет следующие параметры:

--workspace-location
Обязательный параметр. Каталог рабочей области
--configuration-files
Обязательный параметр. Каталог, в который следует поместить xml-выгрузку конфигурации
--edt-location
Каталог, содержащий нужную версию 1C:EDT. Если параметр не задан, то используется либо версия по умолчанию, либо самая ранняя установка, связанная с модулем edt
--project
Каталог проекта, который нужно экспортировать. Одновременно можно использовать только один аргумент: project или project-name
--project-name
Имя проекта в текущей рабочей области, который следует экспортировать. Одновременно можно использовать только один аргумент: project или project-name

Пример выполнения:

ring edt@2021.3.1:x86_64 workspace export --project D:/project-1 --configuration-files d:/XML-1/ --workspace-location D:/workspace

Импорт xml-выгрузки конфигурации в проект

Чтобы конвертировать xml-выгрузку конфигурации в файловое представление 1C:EDT используйте команду import из подсистемы workspace. Она имеет следующие параметры:

--workspace-location
Обязательный параметр. Каталог рабочей области
--configuration-files
Обязательный параметр. Каталог, содержащий xml-выгрузку конфигурации
--edt-location
Каталог, содержащий нужную версию 1C:EDT. Если параметр не задан, то используется либо версия по умолчанию, либо самая ранняя установка, связанная с модулем edt
--project
Каталог проекта, в который следует импортировать проект в формате 1C:EDT. Одновременно можно использовать только один аргумент: project или project-name
--project-name
Имя проекта в текущей рабочей области, в который следует импортировать проект в формате 1C:EDT. Одновременно можно использовать только один аргумент: project или project-name
--version
Версия платформы «1С:Предприятие 8». Если не указана, то будет подобрана согласно версии xml-выгрузки конфигурации
--base-project-name
Имя базового проекта. Допустимо только для зависимых проектов

Примеры выполнения:

ring edt@2021.3.1:x86_64 workspace import --configuration-files d:/XML-1/ --project D:/project-1 --workspace-location D:/workspace
ring edt@2021.3.1:x86_64 workspace import --configuration-files d:/XML-2/ --project D:/project-2 --base-project-name project-1 --workspace-location D:/workspace
ring edt@2021.3.1:x86_64 workspace import --configuration-files d:/XML-2/ --project D:/project-2 --base-project-name project-1 --version 8.3.11 --workspace-location D:/workspace

Проверка проекта

Чтобы проверить проект используйте команду validate из подсистемы workspace. Она имеет следующие параметры:

--workspace-location
Обязательный параметр. Каталог рабочей области
--edt-location
Каталог, содержащий нужную версию 1C:EDT. Если параметр не задан, то используется либо версия по умолчанию, либо самая ранняя установка, связанная с модулем edt
--file
Обязательный параметр. Файл для записи результатов валидации в формате TSV. Если файл уже существует, будет выдана ошибка
--project-list
Список каталогов, откуда загрузить проекты в формате 1C:EDT для проверки. Одновременно можно использовать только один аргумент: project-list или project-name-list
--project-name-list
Список имен проектов в текущей рабочей области, откуда загрузить проекты в формате 1C:EDT для проверки. Одновременно можно использовать только один аргумент: project-list или project-name-list

Пример выполнения:

ring edt@2021.3.1:x86_64 workspace validate --project-list D:/project-1 D:/project-2 --file D:/validation-result.txt --workspace-location D:/workspace