Dòng lệnh
restorm [--open <chemin>] [--run <cible>] [options]Các đối số
Section titled “Các đối số”| Đối số | Bí danh | Kiểu | Mặc định | Vai trò |
|---|---|---|---|---|
--open <chemin> | -o | chuỗi | — | Tệp hoặc thư mục cần mở lúc khởi động. Bắt buộc khi dùng --run |
--run <cible> | chuỗi | — | Chạy kịch bản có tên đó rồi thoát. Kích hoạt chế độ dòng lệnh | |
--by <name|id> | danh sách | name | Cách --run chỉ định kịch bản | |
--headless | luận lý | false | Không có cửa sổ nào. Nếu không có nó, cửa sổ sẽ hiện ra trong lúc chạy | |
--param nom=valeur | lặp lại được | — | Cung cấp một tham số cho kịch bản | |
--all-logs | luận lý | false | Bao gồm cả các mục của cỗ máy, chứ không chỉ mục của hành động Log | |
--out <fichier> | chuỗi | — | Ghi nhật ký thêm vào một tệp, theo thời gian thực | |
--clear-settings | -cls | luận lý | false | Đặt lại các tùy chọn trước khi khởi chạy |
--inactive-window | luận lý | false | Hiện cửa sổ mà không đưa tiêu điểm vào nó | |
--quiet | -q | luận lý | — | Rút gọn đầu ra chỉ còn nhật ký chạy. Được thêm tự động khi có --run |
--mcp-session-name <nom> | chuỗi | tự động | Đặt tên cho phiên MCP (xem thêm biến RESTORM_MCP_SESSION_NAME) | |
--help | -h | Hiển thị phần trợ giúp | ||
--version | -v | Hiển thị phiên bản |
Mã thoát
Section titled “Mã thoát”| Mã | Ý nghĩa |
|---|---|
0 | Kịch bản đã kết thúc đúng đắn |
1 | Thất bại, bị hủy, hoặc lỗi của cỗ máy |
2 | Không tìm thấy đích, tệp --out không truy cập được, hoặc --run mà không có --open |
3 | Quyền bị từ chối — thiếu token, token không hợp lệ hoặc bị thu hồi, gói không đủ, hoặc điểm kiểm tra không liên lạc được |
Biến môi trường
Section titled “Biến môi trường”| Biến | Vai trò |
|---|---|
RESTORM_TOKEN | Token của tổ chức (rstk_…) mà chế độ chạy headless yêu cầu |
RESTORM_MCP_SESSION_NAME | Tương đương với --mcp-session-name |
Các bí mật kiểu biến môi trường cũng được đọc trong môi trường của tiến trình: đây là cơ chế được khuyến nghị trong tích hợp liên tục.
Mở một dự án:
restorm --open ./api.restormChạy một kịch bản và hiển thị cửa sổ (tiện để quan sát):
restorm --open ./api.restorm --run "Tests de fumée"Chạy không cửa sổ, có tham số và nhật ký đầy đủ:
RESTORM_TOKEN=rstk_… restorm \ --open ./api.restorm \ --run "Tests de fumée" \ --headless \ --all-logs \ --out ./run.log \ --param baseUrl=https://staging.exemple.test \ --param Ids='[1,2,3]' \ --param Env=stagingXem Chạy headless và CI để biết định dạng đầu ra, cách chuyển đổi tham số và các ví dụ pipeline.