Hướng dẫn sử dụng OVoBrowser CLI

Chế độ CLI của ovoBrowser được sử dụng để khởi chạy Desktop Client và Native Automation API trong dòng lệnh. Nó tái sử dụng phiên đăng nhập tài khoản gần đây nhất trong bộ nhớ bảo mật phía máy tính để bàn và không yêu cầu người dùng ghi hộp thư, mật khẩu, Refresh Token hoặc API Key vào dòng lệnh.

I. Cảnh áp dụng

• Boot script hoặc native task scheduler để khởi động OVoBrowser API;

• Chạy Playwright, Puppeteer, Selenium hoặc kịch bản riêng mà không cần mở cửa sổ chính;

• Sửa cổng API cho các công cụ gốc;

• Để các tài khoản đã đăng nhập cung cấp giao diện chu kỳ sống môi trường, đại lý và trình duyệt.

Chế độ CLI vẫn là một cách để khởi động máy tính để bàn, không phải là dịch vụ đám mây độc lập và không vượt qua quyền tài khoản, quyền nhóm, hạn ngạch môi trường hoặc ranh giới bảo mật gốc.

II. Điều kiện sử dụng đầu tiên

1. Mở ứng dụng máy tính để bàn OvoBrowser bình thường;

2. Đăng nhập vào tài khoản yêu cầu tự động hóa;

3. Xác nhận khách hàng có thể vào giao diện chính bình thường;

4. Hoàn toàn thoát khỏi khách hàng;

5. Sử dụng lại từ dòng lệnh--cliBắt đầu.

Thông tin đăng nhập tài khoản được lưu trong kho lưu trữ an toàn của hệ điều hành. CLI không hỗ trợ và không khuyến khích các tham số sau:

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

Nếu đăng nhập đã hết hạn, tài khoản đã thoát hoặc bộ nhớ an toàn đã bị xóa, hãy đăng nhập lại bằng giao diện máy tính để bàn.

3.Tìm đường dẫn chương trình

Nếu bạn sử dụng thư mục mặc định khi cài đặt, bạn có thể sao chép từ trường đích của phím tắt trên máy tính để bànovoBrowser.exeĐường dẫn hoàn chỉnh. Đường dẫn chiếm chỗ được sử dụng dưới đây:

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

Đường dẫn thực tế phải tùy thuộc vào vị trí cài đặt máy tính hiện tại.

Khởi động chế độ CLI

Sử dụng cổng API được lưu lần cuối:

& $OvoBrowserExe --cli

Chỉ định cổng:

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

Bạn cũng có thể sử dụng viết bằng chữ:

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

Cổng phải là số nguyên 1-65535. Dịch vụ chỉ nghe127.0.0.1Không nghe lén địa chỉ mạng cục bộ hoặc địa chỉ mạng công cộng.

Sau khi CLI bắt đầu:

• Cửa sổ chính không hiển thị theo mặc định;

• Khách hàng vẫn chạy ở chế độ nền và giữ lại lối vào pallet;

• Quá trình kết xuất ẩn sẽ khôi phục phiên tài khoản trong bộ nhớ an toàn;

• Cổng API sẽ được khởi động vàenabled=truevà các cổng hiện tại được lưu vào cấu hình cục bộ;

• Lần sau khi bạn khởi động máy khách desktop bình thường, cổng sẽ tự động được khôi phục miễn là nó vẫn được kích hoạt lần trước.

V. Trạng thái khởi động đầu ra

Xuất văn bản có thể đọc:

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

Đầu ra JSON một dòng:

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

Ví dụ về JSON Field:

{
  "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"
}

Một số môi trường cài đặt Windows không giữ đầu ra chuẩn của chương trình GUI trong terminal hiện tại. Tình trạng dịch vụ phải được xác nhận thông qua kiểm tra sức khỏe, bất kể thiết bị đầu cuối có hiển thị văn bản hay không.

VI. Xác nhận cổng và phiên tài khoản có sẵn

Kiểm tra port trước:

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

Phản hồi thành công:

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

Sau đó kiểm tra xem phiên tài khoản và workspace đã khôi phục xong chưa:

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

/healthThành công chỉ có nghĩa là cổng đã được lắng nghe;/browser/listThành công có nghĩa là khách hàng ẩn đã khôi phục phiên tài khoản và có thể xử lý dữ liệu tài khoản. Khi mới khởi động, bạn có thể đợi vài giây rồi thử lại.

VII. Mối quan hệ với khởi động tự động sau khi đăng nhập

Sau khi tài khoản được khôi phục thành công bằng mật khẩu, đăng ký, đăng nhập Google/GitHub, đăng ký mời hoặc lưu phiên, API cục bộ sẽ tự động khởi chạy. Các quy tắc thực tế như sau:

• Sau khi đăng nhập thành công, API sẽ được khởi chạy và lưu.enabled=truePort hiện tại;

• Lần sau khi khởi động khách hàng có thể khôi phục cảng cửa trước thời hạn dựa trên trạng thái đã lưu, sau khi hội thoại tài khoản khôi phục còn có thể xác nhận dịch vụ đang vận hành một lần nữa;

• Nhấp vào "Stop service" trên trang "API&MCP" sẽ ngay lập tức đóng cổng hiện tại, nhưng lần đăng nhập thành công tiếp theo hoặc phục hồi phiên vẫn sẽ tự động bắt đầu;

• Sử dụng--cliCác cổng cũng được khởi động một cách rõ ràng và được lưu ở trạng thái kích hoạt;

• Sau khi khách hàng thoát hoàn toàn, tiến trình API và cổng sẽ đóng cùng nhau.

8.Khi có khách hàng

OvoBrowser chạy với một instance duy nhất. Nếu Desktop Client đã được mở, hãy thực hiện:

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

Các lệnh sẽ được xử lý cho các phiên bản hiện có và bắt đầu hoặc chuyển đổi API cục bộ sang cổng được chỉ định và sẽ không bắt đầu quá trình tài khoản thứ hai nữa. Sau khi chuyển cổng, bên gọi phải cập nhậtbaseUrl。

Ngừng dịch vụ CLI

Chế độ CLI sử dụng cùng một tiến trình như Desktop Client. Có thể dừng lại bằng cách sử dụng:

• Thoát khỏi ovoBrowser từ khay hệ thống;

• Mở cửa sổ chính một lần nữa và nhấp vào "Stop service" trên trang "API&MCP";

• Thoát khỏi tiến trình ovoBrowser bình thường.

Không sử dụng quá trình kết thúc bắt buộc như một cách dừng hàng ngày; Thoát bình thường đóng hạt nhân trình duyệt và API cục bộ và hoàn thành việc dọn dẹp cần thiết.

X. Cấu hình Postman

1. Nhập khẩuovoBrowser-Local-API.postman_collection.json；

2. Mở bộ sưu tập Variables;

3. ĐưabaseUrlThay đổi địa chỉ được sử dụng bởi CLI, ví dụ:http://127.0.0.1:50325；

4. Chạy "kiểm tra sức khỏe" trước;

5. Chạy lại "Danh sách môi trường", xác nhận phiên tài khoản đã khôi phục;

6. Gọi môi trường và giao diện proxy theo yêu cầu.

Postman không yêu cầu Bearer Token, API Key hoặcx-api-key. API cục bộ chỉ cho phép truy cập máy tính hiện tại.

11. câu hỏi thường gặp

Connection refused

Quá trình CLI không chạy, cổng được viết sai, cổng bị chiếm hoặc chương trình khởi động không thành công. Kiểm tra trong lệnh--api-portVà xác nhận địa chỉ kiểm tra sức khỏe nhất trí.

Kiểm tra sức khỏe thành công, nhưng danh sách môi trường cảnh báo khách hàng chưa sẵn sàng

Hidden client vẫn đang tiếp tục phiên đăng nhập và chờ vài giây để thử lại. Nếu liên tục thất bại, mở màn hình nền bình thường, xác nhận tài khoản không rời khỏi và có thể vào giao diện chính.

Cổng đã được sử dụng

Thay thế một cổng không sử dụng, chẳng hạn như:

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

Đăng nhập đã hết hạn

CLI không nhận mật khẩu tài khoản. Vui lòng bật máy khách đăng nhập lại bình thường và chạy CLI sau khi thoát.

Cửa sổ chính không xuất hiện sau khi thực hiện lệnh

Đây là hành vi dự kiến của mô hình CLI. Cửa sổ chính có thể được mở từ khay hoặc kiểm tra sức khỏe có thể được gọi trực tiếp.

XII. Tư vấn an toàn

• Chỉ nghe và gọi127.0.0.1；

• Không để lộ API cục bộ với mạng cục bộ hoặc mạng công cộng bằng bản đồ cổng, proxy ngược hoặc đường hầm;

• Đừng lấy mật khẩu đại lý. Cookie、 Mật khẩu tài khoản hoặc phản hồi API đầy đủ được ghi vào nhật ký công khai;

• Không lưu mật khẩu đăng nhập trong các tham số dòng lệnh, tệp hàng loạt hoặc lịch trình tác vụ;

• Đóng môi trường không còn sử dụng sau khi tự động hóa kết thúc;

• Tài khoản nhóm chỉ cấp cho kịch bản quyền mà nó thực sự cần.

13. kiểm tra nhanh thông số

Tài liệu liên quan:

• Tài liệu API.md

• Ví dụ về cuộc gọi ovobrowser-api/postman/ovobrowser-local-api.postman_collection.json

• Ví dụ về cuộc gọi ovobrowser-api/README.md