Возврат Start
@ -26,7 +26,8 @@ sidebar_class_name: NachaloRaboty
|
||||
<a href="https://openintegrations.dev/docs/Google_Sheets/"><img src={require('../../static/img/APIs/GoogleSheets.png').default} width="32"/></a>
|
||||
<a href="https://openintegrations.dev/docs/Slack/"><img src={require('../../static/img/APIs/Slack.png').default} width="32"/></a>
|
||||
<a href="https://openintegrations.dev/docs/Airtable/"><img src={require('../../static/img/APIs/Airtable.png').default} width="32"/></a>
|
||||
<a href="https://openintegrations.dev/docs/Dropbox/"><img src={require('../../static/img/APIs/Dropbox.png').default} width="32"/></a>
|
||||
<a href="https://openintegrations.dev/docs/Dropbox/"><img src={require('../../static/img/APIs/Dropbox.png').default} width="32"/></a>
|
||||
<a href="https://openintegrations.dev/docs/Bitrix24/"><img src={require('../../static/img/APIs/Bitrix24.png').default} width="32"/></a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
42
docs/ru/md/Start/CLI_version.md
Normal file
@ -0,0 +1,42 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Работа с CLI версией
|
||||
|
||||
**OInt CLI** - приложение для командой строки, которое позволяет использовать методы Открытого пакета интеграций независимо от 1С и OneScript. Для его работы требуется **.Net Framework 4.8** или сопоставимый **Mono Runtime** (при использовании deb и rpm пакетов устанавливается автоматически)
|
||||
|
||||
## Первый запуск
|
||||
|
||||
Для начала работы необходимо вызвать команду `oint` из командной строки/терминала. При установке из пакетов (Linux) или установщика (Windows, после перезагрузки), сделать это можно из любого места без дополнительных действий. При использовании портативной версии (исполняемого файла exe) `oint` необходимо запускать по полному пути к файлу. В Linux-дистрибутивах, также, предварительно нужно будет прописать `chmod +x <путь к файлу>/oint`
|
||||
|
||||
Запуск портативной версии в RHEL/Fedora/CentOS (дистрибутивы, использующие rpm-пакеты) осуществляется командой <br/>`mono <путь к файлу>/oint "$@"`
|
||||
|
||||
![demo](./img/1.gif)
|
||||
|
||||
## Справка
|
||||
|
||||
После запуска приложения, вы увидите начальную страницу, где есть перечень доступных библиотек. Для того, чтобы просмотреть список доступных методов конкретной библиотеки, необходимо просто написать `oint` и её название. Например `oint telegram`. Аналогично можно узнать подробности о конкретном методе - необходимо вызвать команду `oint <библиотека> <метод>`, например `oint telegram ОтправитьТекстовоеСообщение`
|
||||
|
||||
>**Важно:** Имена библиотек чувствительны к регистру и пишутся строчными буквами. Имена методов к регистру не чувствительны
|
||||
|
||||
![demo](./img/3.gif)
|
||||
|
||||
## Использование методов
|
||||
Как и большинство других программ, нацеленных на использование в bat/sh скриптах, каждое отдельное действие Oint CLI вызывается полной строкой вызова следующего вида:
|
||||
|
||||
```powershell
|
||||
oint <библиотека> <метод> --парам1 "Значение" --парам2 "Значение"...
|
||||
```
|
||||
|
||||
Что касается параметров, то чаще всего передаваемые туда данные - строки. Это может быть текст, пути к файлам, URL и пр. Однако, в OInt есть методы, которые принимают и другие, менее очевидные виды данных. Это могут быть:
|
||||
|
||||
+ Даты - передаются как строки формата ISO 8601
|
||||
+ Массивы - передаются как строки вида `"['Знач1','Знач2','Знач3']"`
|
||||
+ JSON - передается как путь к файлу
|
||||
|
||||
После выполнения запрашиваемого действия, программа выводит результат и завершает работу. По умолчанию, вывод осуществляется в консоль, но вы можете перенаправить его в файл - как стандартным способом `>`, так и при помощи общего параметра `--out`. Разница между двумя этими способами заключается в кодировке сохраняемого файла: при использовании `>` это будет кодировка оболочки, а при использованни `--out` - UTF-8 (используется внутри OInt при работе). Также использование `--out` обязательно для методов, возвращающих двоичные данные в ответе (вроде скачивания файла из Google Drive, например)
|
||||
|
||||
![demo](./img/2.gif)
|
||||
|
||||
Всю дальнейшую информацию, которая может понадобиться вам для работы, вы сможете найти в других разделах данной документации, а также во встроенной справке OInt CLI
|
53
docs/ru/md/Start/Release-variants.md
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Про варианты релизов
|
||||
|
||||
Открытый пакет интеграций - это проект с тремя путями развития: 1С, OneScript и CLI. Основная версия - 1С, которая далее автоматически трансформируется в пакет для OneScript, а из него - в CLI приложение. Каждый из этих путей имеет свои варианты распространения - всего их 8: 3 для 1С, 4 для CLI и 1 для OneScript. Здесь приведены описания каждого из них
|
||||
|
||||
>Ссылка на последний релиз: [Тык!](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest)
|
||||
|
||||
## 1С:Enterprise
|
||||
Данные варианты релизов - различные формы поставки расширения для платформы 1С:Предприятие
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/1.png').default} width="86" align="left"/>
|
||||
**OpenIntegrations_x.x.x.cfe** - стандартный вариант поставки расширения конфигурации 1С:Предприятие. Для начала работы достаточно загрузить его в список расширений вашей конкретной конфигурации. Разработка ведется в режиме совместимости 1С 8.3.9
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/2.png').default} width="86" align="left"/>
|
||||
**XML.zip** - это zip-архив, который содержит в себе файлы стандартной выгрузки расширения 1С "в файлы". Аналогично варианту с CFE, распакованный архив можно использовать для загрузки расширения через панель Расширений конфигурации в конкретном проекте
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/3.png').default} width="86" align="left"/>
|
||||
**EDT.zip** - это zip-архив, который содержит в себе файлы проекта расширения EDT. Этот вариант поставки предназначен для быстрого старта работы с ОПИ в тех случаях, когда разработка основной конфигурации ведется с использованием 1C Enterprise Development Tools
|
||||
|
||||
<br/>
|
||||
|
||||
## CLI
|
||||
Данные варианты релизов - различные формы поставки OInt CLI - кросплатформенного приложения для терминала/командной строки, реализующего полный функционал библиотеки ОПИ без привязки к тех. стеку 1С/OS. Системные требования OInt - системные требования OneScript: **.Net Framework 4.8 (Windows)** или **сопоставимая версия Mono (Linux)**
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'20px'}} src={require('./img/5.png').default} width="86" align="left"/>
|
||||
**oint.exe** - исполняемый файл, который, несмотря на Windows-ориентированное расширение, является кросплатформенным. Для запуска требуется .Net Framework 4.8 или Mono совместимой версии. В Windows и Debian-based дистрибутивах данное приложение запускается просто через командную строку/терминал, а в дистрибутивах, основанных на RHEL - через ```mono oint.exe "$@"```
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'20px'}} src={require('./img/6.png').default} width="86" align="left"/>
|
||||
**oint_x.x.x_installer.exe** - это Windows-установщик. Рекомендуемый способ установки для ОС Windows, так как при его использовании автоматически создается каталог программы и прописывается PATH (после презагрузки компьютера). Это позволяет в дальнейшем запускать приложение из любого места, просто написав `oint` в командной строке
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/7.png').default} width="86" align="left"/>
|
||||
**oint_x.x.x_all.deb** - это DEB-пакет, предназанченный для установки OInt в Debian/Ubuntu дистрибутивах. При его использовании зависимости Mono устанавливаются автоматически, следовательно никаких дополнительных действий для начала работы не требуется
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'16px'}} src={require('./img/8.png').default} width="86" align="left"/>
|
||||
**oint-x.x.x-1.el7.x86_64.rpm** - это RPM-пакет, предназанченный для установки OInt в RHEL/Fedora/CentOS дистрибутивах. При его использовании зависимости Mono устанавливаются автоматически, следовательно никаких дополнительных действий для начала работы не требуется. Также не требуется запуск через `mono`, как в случае с exe
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
## OneScript
|
||||
Данные варианты релизов предназначены для использования в OneScript-проектах
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'16px'}} src={require('./img/4.png').default} width="86" align="left"/>
|
||||
**oint-x.x.x.ospx** - это OSPX пакет, предназначенный для установки через пакетный менеджер OPM. Вы можете использовать его для оффлайн установки при помощи команды
|
||||
``` opm install -f "./OInt-x.x.x.ospx" ```.
|
||||
Если отсутствие интернета на машине не предполагается, гораздо проще установить OInt напрямую из хаба пакетов. Скачивания файла для этого не требуется, достаточно выполнить команду ``` opm install oint ```
|
||||
|
||||
|
||||
|
||||
<br/>
|
BIN
docs/ru/md/Start/img/1.gif
Normal file
After Width: | Height: | Size: 72 KiB |
BIN
docs/ru/md/Start/img/1.png
Normal file
After Width: | Height: | Size: 7.1 KiB |
BIN
docs/ru/md/Start/img/2.gif
Normal file
After Width: | Height: | Size: 93 KiB |
BIN
docs/ru/md/Start/img/2.png
Normal file
After Width: | Height: | Size: 5.8 KiB |
BIN
docs/ru/md/Start/img/3.gif
Normal file
After Width: | Height: | Size: 244 KiB |
BIN
docs/ru/md/Start/img/3.png
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
docs/ru/md/Start/img/4.png
Normal file
After Width: | Height: | Size: 22 KiB |
BIN
docs/ru/md/Start/img/5.png
Normal file
After Width: | Height: | Size: 2.0 KiB |
BIN
docs/ru/md/Start/img/6.png
Normal file
After Width: | Height: | Size: 3.5 KiB |
BIN
docs/ru/md/Start/img/7.png
Normal file
After Width: | Height: | Size: 6.7 KiB |
BIN
docs/ru/md/Start/img/8.png
Normal file
After Width: | Height: | Size: 7.7 KiB |