Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Интерфейс командной строки

Интерфейс командной строки позволяет выполнять действия над решением и его проектами с помощью консольных команд, не открывая его в Alpha.DevStudio. Используя интерфейс командной строки, можно запускать выполнение действий из скриптов или из других программ, автоматизировать выполнение таких действий.

Для выполнения консольных команд используется утилита работы с командной строкой devstudio.cli. Эта утилита представляет собой файл:

  • devstudio.cli.exe в папке C:\Program Files\Automiq\Alpha.DevStudio (для ОС Windows);
  • devstudio.cli в папке /opt/Automiq/Alpha.DevStudio/bin (для ОС Linux).

Чтобы выполнить консольную команду:

  1. Откройте командную строку в папке установки Alpha.DevStudio.

    • В ОС Windows:

      Запустите командную строку из меню Пуск и перейдите в папку установки:

      cd "C:\Program Files\Automiq\Alpha.DevStudio"

      Или перейдите в папку установки и вызовите контекстное меню с зажатой клавишей Shift: откроется расширенное контекстное меню, в котором можно открыть командную строку из текущего местоположения. В Windows для работы с командной строкой по умолчанию используется приложение PowerShell.

    • В ОС Linux:

      Запустите терминал и выполните команду от имени пользователя (не от имени root):

      cd /opt/Automiq/Alpha.DevStudio/bin

      Если вы вошли в систему от имени root, то войти от имени другого пользователя можно по команде:

      su - user

      где user – имя пользователя.

  2. Выполните консольную команду.

    • В ОС Windows:

      devstudio.cli <COMMAND> [PARAMETERS]

      или

      devstudio.cli [PARAMETERS] <COMMAND>

      где:

      • <COMMAND> – команда.
      • [PARAMETERS] – список параметров, переданных команде.

      Если вы выполняете команду в PowerShell из текущей папки, то перед командой укажите .\.

      Консольная команда в ОС Windows:

      devstudio.cli compile --solution-path C:\Projects\My-project\My-solution.solution
    • В ОС Linux:

      ./devstudio.cli <COMMAND> [PARAMETERS]

      где:

      • <COMMAND> – команда.
      • [PARAMETERS] – список параметров, переданных команде.

      Консольная команда в ОС Linux:

      ./devstudio.cli compile --solution-path /home/user/Projects/My-solution.solution

Действия, которые можно выполнить из командной строки

С помощью интерфейса командной строки можно выполнить:

Консольный вывод

Вся информация выводится в стандартный поток вывода stdout.

Поток вывода stderr не используется: сообщения об ошибках выводятся в поток stdout. Сделано это, чтобы сохранить порядок вывода сообщений для удобства анализа.

Формат вывода зависит от значения параметра --output-format, переданного команде:

  • plain
  • json

Если параметр не указан, информация выводится в формате plain.

Консольная команда в ОС Windows:

devstudio.cli compile
  --solution-path C:\Projects\My-project\My-solution.solution
  --output-format json

Консольная команда в ОС Linux:

./devstudio.cli compile
  --solution-path /home/user/Projects/My-solution.solution
  --output-format json

Формат plain

Если выбран формат plain, информация выводится в виде, предназначенном для восприятия человеком. Выводиться будут только сообщения; возвращаемые командами данные выводиться не будут.

Структура сообщения:

[SOURCE] MESSAGE-TYPE: UNIT, ELEMENT, TEXT

где:

  • SOURCE – источник сообщения. Например, название консольной команды.
  • MESSAGE-TYPE – тип сообщения: error, warning, info или hint.
  • UNIT – наименование юнита. Например, имя проекта.
  • ELEMENT – полный путь (относительно юнита) к элементу, ассоциированному с сообщением.
  • TEXT – текст сообщения.
[compile] warning: My-project, Domain.host,
  Доступ к сетевому узлу Domain по адресу 127.0.0.1 будет невозможен.
[compile] info: My-project,
  Компиляция My-project успешно завершена (длительность: 00:00:00.4555504).

Формат json

Если выбран формат json, информация выводится в виде, предназначенном для разбора компьютером. Выводиться будут как сообщения, так и возвращаемые командами данные. Каждое сообщение или блок данных выводится в виде отдельного json-объекта, каждый json-объект выводится на новой строке. Все спецсимволы внутри строк экранируются в соответствии со спецификацией JSON.

Структура сообщения:

{
  "source": "источник сообщения",
  "message": {
    "type": "тип сообщения",
    "unit": "наименование юнита",
    "element": "полный путь к элементу",
    "text": "текст сообщения" 
  }
}

Переносы строк и отступы добавлены в структуру сообщения для удобства восприятия. В выводе консольной команды описанная выше структура выводится в одну строку.

Консольный вывод в формате JSON:

{
  "source": "compile",
  "message": {
    "element": "Domain.host",
    "text": "Доступ к сетевому узлу Domain по адресу 127.0.0.1 будет невозможен",
    "type": "warning",
    "unit": "My-project"
  }
}
{
  "source": "compile",
  "message": {
    "element": "",
    "text": "Компиляция My-project успешно завершена (длительность: 00:00:00.4555504).",
    "type": "info",
    "unit": "My-project"
  }
}

Описания структур данных, возвращаемых командами, приведены в описаниях этих команд.

Квалификаторы элементов

В параметрах команд и возвращаемых ими результатах для идентификации элементов используются квалификаторы. Квалификатор – строка, однозначно идентифицирующая элемент в решении:

UNIT_NAME/LOCAL_ELEMENT_QUALIFIER

где

  • UNIT_NAME – имя проекта/модуля.
  • LOCAL_ELEMENT_QUALIFIER – локальный квалификатор элемента: путь от корня проекта/модуля до определения элемента, в качестве разделителя используется точка ..

Квалификатор элемента Domain.host.Server в проекте My-project: My-project/Domain.host.Server.

Вызов справки

Для получения списка доступных команд, вызовите утилиту с параметром -h или --help.

  • В ОС Windows:

    devstudio.cli --help
  • В ОС Linux:

    ./devstudio.cli --help

Для вывода справки по команде, вызовите эту команду с параметром -h или --help.

  • В ОС Windows:

    devstudio.cli <COMMAND> --help
  • В ОС Linux:

    ./devstudio.cli <COMMAND> --help

Вывод справки по команде compile в ОС Windows:

devstudio.cli compile --help

Вывод справки по команде compile в ОС Linux:

./devstudio.cli compile --help