1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-11-28 09:08:38 +02:00

Опечатки доков CLI

This commit is contained in:
Anton Titovets 2024-05-29 10:31:13 +03:00 committed by GitHub
parent c3945950f1
commit ef7cc18878
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -16,27 +16,27 @@ sidebar_position: 2
## Справка
После запуска приложения, вы уидите начальную страницу, где есть перечень доступных библиотек. Для того, чтобы просмотреть список доступных методов конкретной библиотеки, необходимо просто написать `oint` и её название. Например `oint telegram`. Аналогично можно узнать подробности о конкретном методе - необходимо вызвать команду `oint <библиотека> <метод>`, например `oint telegram ОтправитьТекстовоеСообщение`
После запуска приложения, вы увидите начальную страницу, где есть перечень доступных библиотек. Для того, чтобы просмотреть список доступных методов конкретной библиотеки, необходимо просто написать `oint` и её название. Например `oint telegram`. Аналогично можно узнать подробности о конкретном методе - необходимо вызвать команду `oint <библиотека> <метод>`, например `oint telegram ОтправитьТекстовоеСообщение`
>**Важно:** Имена библиотек чувствительны к регистру и пишутся строчными буквами. Имена методов к регистру не чувствительны
![demo](./img/3.gif)
## Использование методов
Как и большинство других программ, нацеленных на использование в bat/sh скриптах, каждое отдельное действие Oint CLI вызывается полной строкой вызова следующего вдиа:
Как и большинство других программ, нацеленных на использование в bat/sh скриптах, каждое отдельное действие Oint CLI вызывается полной строкой вызова следующего вида:
```powershell
oint <библиотека> <метод> --парам1 "Значение" --парам2 "Значение"...
```
Что касается праметров, то чаще всего передаваемые туда данные - строки. Это может быть текст, пути к файлам, URL и пр. Однако, в OInt есть методы, которые принимают и другие, менее очевидные виды данных. Это могут быть:
Что касается параметров, то чаще всего передаваемые туда данные - строки. Это может быть текст, пути к файлам, URL и пр. Однако, в OInt есть методы, которые принимают и другие, менее очевидные виды данных. Это могут быть:
+ Даты - передаются как строки формата ISO 8601
+ Массивы - передаются как строки вида `"['Знач1','Знач2','Знач3']"`
+ JSON - передается как путь к файлу
После выполнения запрашиваемого действия, программа выводит результат и завершает работу. По умолчанию, вывод осуществляется в консоль, но вы можете перенаправить его в файл - как стандартным способом `>`, так и при помощи общего параметра `--out`. Разница между двумя этими способами заключается в кодировке сохраняемого файла: при использовании `>` это будет кодировка оболочки, а при использованни `--out` - UTF-8 (используется внутри OInt при работе). Также использование `--out` обязательно для методов, возвращающийх двоичные данные в ответе (вроде скачивания файла из Google Drive, например)
После выполнения запрашиваемого действия, программа выводит результат и завершает работу. По умолчанию, вывод осуществляется в консоль, но вы можете перенаправить его в файл - как стандартным способом `>`, так и при помощи общего параметра `--out`. Разница между двумя этими способами заключается в кодировке сохраняемого файла: при использовании `>` это будет кодировка оболочки, а при использованни `--out` - UTF-8 (используется внутри OInt при работе). Также использование `--out` обязательно для методов, возвращающих двоичные данные в ответе (вроде скачивания файла из Google Drive, например)
![demo](./img/2.gif)
Всю дальнейшую информацию, которая может понадобиться вам для работы, вы сможете найти в других разделах данной документации, а также во встроенной справке OInt CLI
Всю дальнейшую информацию, которая может понадобиться вам для работы, вы сможете найти в других разделах данной документации, а также во встроенной справке OInt CLI