Ovobrowser
Показать весь каталог руководств

Руководство по использованию режима OvoBrowser CLI

Запустите ovoBrowser, локальный API и сеанс сохраненной учетной записи в фоновом режиме командной строки, а также проверьте порты, статус и часто задаваемые вопросы.

Использование режима OvoBrowser CLI

Режим OvoBrowser CLI используется для загрузки настольных клиентов и API локальной автоматизации в командной строке. Он повторно использует последний сеанс учетной записи, зарегистрированный в безопасном хранилище рабочего стола, и не требует от пользователя записывать почтовый ящик, пароль, файл Refresh Token или API Key в командную строку.

I. Сценарий применения

  • Загрузочный сценарий или локальный планировщик задач для запуска API ovoBrowser;

  • Запустите Playwright, Puppeteer, Selenium или собственный сценарий без открытия основного окна;

  • Установить порт API для собственных инструментов;

  • Позволяет уже зарегистрированным учетным записям предоставлять интерфейсы среды, прокси - сервера и жизненного цикла браузера.

Режим CLI по - прежнему является способом запуска для настольных клиентов, не является независимым облачным сервисом и не обходит права учетной записи, права команды, экологические квоты или границы безопасности.

II. Предпосылки первого использования

  1. Открыть рабочий стол OvoBrowser;

  2. Регистрация учетных записей, необходимых для автоматизации;

  3. Убедитесь, что клиент может нормально войти в основной интерфейс;

  4. Полностью отказаться от клиента;

  5. Использовать из командной строки--cliЗапуск.

Регистрационные данные хранятся в безопасном хранилище операционной системы. CLI не поддерживает и не рекомендует использовать следующие параметры:

--username
--password
--token
--api-key

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

III. Найти путь к программе

Если при установке используется каталог по умолчанию, его можно скопировать из поля « целей» комбинации клавиш рабочего столаovoBrowser.exeПолный путь. Использовать путь заполнения:

$OvoBrowserExe = "C:\Program Files\ovoBrowser\ovoBrowser.exe"

Фактический путь должен быть основан на месте установки текущего компьютера.

Запуск модели CLI

Использовать последний сохраненный порт API:

& $OvoBrowserExe --cli

Укажите порт:

& $OvoBrowserExe --cli --api-port 50325

Также можно использовать уравнение:

& $OvoBrowserExe --cli --api-port=50325

Порт должен быть целым числом от 1 до 65535. Услуги только прослушивание.127.0.0.1Он не прослушивает адреса локальной или публичной сети.

После запуска CLI:

  • Главное окно не отображается по умолчанию;

  • Клиент все еще работает в фоновом режиме и сохраняет вход в лоток;

  • Скрытый процесс рендеринга восстанавливает сеансы учетной записи в защищенном хранилище;

  • Порт API будет запущен и будетenabled=true& Сохранить текущий порт в конфигурации;

  • При следующем нормальном запуске клиента рабочего стола порт будет автоматически восстановлен до тех пор, пока последний остается включенным.

V. Экспорт состояния запуска

Вывод читаемого текста:

& $OvoBrowserExe --cli --api-port 50325 --cli-print

Выход одной строки JSON:

& $OvoBrowserExe --cli --api-port 50325 --cli-json

Пример поля JSON:

{
  "success": true,
  "mode": "cli",
  "running": true,
  "host": "127.0.0.1",
  "port": 50325,
  "url": "http://127.0.0.1:50325",
  "pid": 12345,
  "account": "stored-session"
}

Некоторые среды установки Windows не сохраняют стандартный вывод программы GUI в текущем терминале. Независимо от того, отображает ли терминал текст или нет, статус обслуживания должен быть подтвержден медицинским осмотром.

Подтверждение наличия портов и учетных записей

Проверьте порт:

$BaseUrl = "http://127.0.0.1:50325"
Invoke-RestMethod -Method Post -Uri "$BaseUrl/health" -ContentType "application/json" -Body "{}"

Успешный ответ:

{
  "success": true,
  "data": {
    "running": true,
    "version": "0.4.3"
  }
}

Затем проверьте, восстановлены ли сеансы учетной записи и рабочие области:

Invoke-RestMethod -Method Post -Uri "$BaseUrl/browser/list" -ContentType "application/json" -Body '{"page":0,"pageSize":1}'

/healthУспех означает только, что порт прослушивается;/browser/listУспех означает, что скрытый клиент восстановил сеанс учетной записи и может обрабатывать данные учетной записи. При запуске можно подождать несколько секунд, чтобы повторить попытку.

VII. Связь с автоматическим запуском после входа в систему

После успешного восстановления учетной записи с помощью пароля, регистрации, входа в систему Google / GitHub, приглашения к регистрации или сохранения сеанса локальный API запускается автоматически. Практические правила таковы:

  • После успешного входа в систему запускается API и сохраняетсяenabled=true& Текущий порт;

  • При следующем запуске клиент может восстановить порт заранее в соответствии с сохраненным состоянием, а после восстановления учетной записи он может подтвердить, что служба работает;

  • Нажмите « Стоп - сервис» на странице « API & MCP», чтобы немедленно закрыть текущий порт, но следующий успешный вход или восстановление сеанса все равно будет запущено автоматически;

  • использовать--cliПорт также будет открыто запущен и сохранен как активный;

  • После полного выхода клиента процесс API и порт закрываются вместе.

8 Когда уже есть примеры клиентов

OvoBrowser работает с одним экземпляром. Если клиент рабочего стола уже открыт, выполните:

& $OvoBrowserExe --cli --api-port 51234

Команды передаются на обработку существующих экземпляров и запускают или переключают локальный API на указанный порт без запуска второго набора процессов учетной записи. После переключения порта вызывающая сторона должна обновитьbaseUrlА.

IX. Остановить услуги CLI

Режим CLI использует тот же процесс, что и клиент рабочего стола. Остановить можно следующим образом:

  • Выход из & ovoBrowser; из системного лотка

  • Откройте главное окно снова и нажмите « Стоп - сервис» на странице « API & MCP»;

  • Обычный выход из процесса ovoBrowser.

Не используйте процесс принудительного завершения как ежедневный способ остановки; Нормальный выход отключает ядро браузера и локальный API и завершает необходимую очистку.

X. Настройка Postman

  1. импортovoBrowser-Local-API.postman_collection.json*

  2. Открыть коллекцию Variables;

  3. положитьbaseUrlАдрес, используемый для CLI, напримерhttp://127.0.0.1:50325*

  4. Сначала запустите "проверку здоровья";

  5. Повторно запустить « Список среды» и подтвердить, что сеанс учетной записи восстановлен;

  6. Вызовите интерфейс среды и прокси по требованию.

Postman не требует Bearer Token, API Key илиx-api-key. Локальный API позволяет доступ только к текущему компьютеру.

XI. Часто задаваемые вопросы

Connection refused

Процесс CLI не запущен, порт написан неправильно, порт занят или программа не запускается. Проверить в команде--api-portИ подтвердить, что адрес медицинского осмотра совпадает.

Проверка здоровья прошла успешно, но список среды указывает на то, что клиент не готов

Скрытый клиент все еще восстанавливает сеанс входа в систему, ожидая повторной попытки в течение нескольких секунд. Если вы продолжаете потерпеть неудачу, нормально откройте клиент рабочего стола и убедитесь, что учетная запись не вышла и может войти в основной интерфейс.

Порт занят.

Заменить незанятый порт, например:

& $OvoBrowserExe --cli --api-port 51234

Регистрация просрочена

CLI не получает пароль учетной записи. Пожалуйста, откройте обычно клиент для повторного входа и выполните CLI после выхода.

Главное окно не появляется после выполнения команды

Это ожидаемое поведение модели CLI. Главное окно можно открыть из лотка или вызвать медицинский осмотр напрямую.

XII. Рекомендации по безопасности

  • Только прослушивание и вызов.127.0.0.1*

  • Не используйте отображение порта, обратный прокси - сервер или туннель для воздействия локальных API на локальную или общедоступную сеть;

  • Не используйте пароль агента, Cookie、 Пароль учетной записи или полный ответ API записывается в публичный журнал;

  • Не сохранять пароль входа в параметры командной строки, файлы пакетной обработки или программы планирования задач;

  • Закрытие среды после завершения автоматизации;

  • Учетная запись команды предоставляет только те права, которые действительно необходимы скрипту.

XIII. Оперативная проверка параметров

параметробъяснение
--cliЗапуск клиента и локального API
--api-port <port>Укажите локальный порт API, диапазон 1 - 65535
--cli-printВыход читаемого состояния запуска
--cli-jsonВыход однострочного состояния запуска JSON
--cli-helpЭкспорт помощи CLI

Соответствующие документы:

  • Документация API.md

  • Пример кода вызова ovobrowser - api / postman / ovoBrowser - Local - API.postman collection.json

  • Пример кода вызова ovobrowser - api / readme.md