Перейти к основному содержимому

Работа с CLI версией

OInt CLI - приложение для командой строки, которое позволяет использовать методы Открытого пакета интеграций независимо от 1С и OneScript

Первый запуск​

Для начала работы необходимо вызвать команду oint из командной строки/терминала. При установке из пакетов (Linux) или установщика (Windows, после перезагрузки), сделать это можно из любого места без дополнительных действий. При использовании портативной версии (исполняемого файла exe) oint необходимо запускать по полному пути к файлу. В Linux-дистрибутивах, также, предварительно нужно будет прописать chmod +x <путь к файлу>/oint

Запуск портативной версии в RHEL/Fedora/CentOS (дистрибутивы, использующие rpm-пакеты) осуществляется командой
mono <путь к файлу>/oint "$@"

demo

Справка​

После запуска приложения, вы увидите начальную страницу, где есть перечень доступных библиотек. Для того, чтобы просмотреть список доступных методов конкретной библиотеки, необходимо просто написать oint и её название. Например oint telegram. Аналогично можно узнать подробности о конкретном методе - необходимо вызвать команду oint <библиотека> <метод>, например oint telegram ОтправитьТекстовоеСообщение

Важно: Имена библиотек чувствительны к регистру и пишутся строчными буквами. Имена методов к регистру не чувствительны

demo

Использование методов​

Как и большинство других программ, нацеленных на использование в bat/sh скриптах, каждое отдельное действие Oint CLI вызывается полной строкой вызова следующего вида:

    oint <библиотека> <метод> --парам1 "Значение" --парам2 "Значение"...

Что касается параметров, то чаще всего передаваемые туда данные - строки. Это может быть текст, пути к файлам, URL и пр. Однако, в OInt есть методы, которые принимают и другие, менее очевидные виды данных. Это могут быть:

  • Даты - передаются как строки формата ISO 8601
  • Массивы - передаются как строки вида "['Знач1','Знач2','Знач3']"
  • JSON - передается как путь к файлу или строка в JSON формате с одинарными кавычками

После выполнения запрашиваемого действия, программа выводит результат и завершает работу. По умолчанию, вывод осуществляется в консоль, но вы можете перенаправить его в файл - как стандартным способом >, так и при помощи общего параметра --out. Разница между двумя этими способами заключается в кодировке сохраняемого файла: при использовании > это будет кодировка оболочки, а при использованни --out - UTF-8 (используется внутри OInt при работе). Также использование --out обязательно для методов, возвращающих двоичные данные в ответе (вроде скачивания файла из Google Drive, например)

demo

Управвляющие последовательности​

В передаваемых параметрах допустимо использование стандартных управляющих последовательностей: \n, \r, \v и \f. Они преобразуются в символы переноса строки, возврата каретки, вертикальной табуляции и перевода формы соответствеено, во всех аргументах, за исключением:

  • Параметров-массивов и параметров в формате JSON (т.е. начинающихся с { или [)
  • Путей к файлам, если файл по этому пути существует
  • Стандартного параметра --out

Для избежания преобразования управляющих последовательностей там, где его быть не должно, необходимо экранировать их вторым знаком \ (например, \n)

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