Tham khảo lệnh CLI — Altifigence Documentation

Phân tích đúng đầu ra lệnh CLI, biên nhận, lỗi có cấu trúc và trạng thái thoát.

Tổng quan

Dùng binary đã cài sau khi xác minh và cài đặt. Tài liệu tham khảo này phân biệt khám phá lệnh, kết quả thực thi, biên nhận kiểm tra trước và phản hồi dịch vụ.

Action manifest

Thành công ghi một mảng JSON. Mỗi mục có name, description, inputSchema, executes, và class. Action manifest khách hàng tích hợp có 25 action, trong đó 22 có executes: true. altifigence.analyze.run, altifigence.evolve.launch, và altifigence.verify.run chỉ tạo kế hoạch. Các lệnh con CLI native có trợ giúp lá riêng ngoài manifest khách hàng này. Phản hồi máy chủ quyết định thao tác dịch vụ có được ủy quyền và sẵn sàng hay không.

Dùng trợ giúp lá cho đối số native:

alti commands

alti xls upstream run --help
alti compute rtl-evolve --help
alti ide workspace hierarchy-plan --help
alti ide cloud search --help
alti ide service workspace replace --help

Kiểm tra trước job ngoại tuyến

Chuẩn bị mã nguồn và envelope trong Thành công đầu tiên với CLI, rồi chạy:

Schema thành công là altifigence.cli.engine-job-preflight.v1. submitted: false và server_authority_verified: false là bắt buộc: hash nguồn và hình dạng job được kiểm tra cục bộ, nhưng không có job nào được gửi hoặc thực thi. Giá trị execution_placement được yêu cầu trong envelope không thay đổi điều này.

alti --json job validate \
  --job "$ALTI_WORKSPACE/job.json" \
  --workspace-root "$ALTI_WORKSPACE" \
  --source rtl/top.sv

Hợp đồng lỗi JSON

Một lệnh --json job validate thất bại không ghi biên nhận thành công vào stdout và xuất đối tượng altifigence.cli.error.v1 vào stderr:

Dùng error.code khi có sẵn. Các họ lệnh khác có schema lỗi riêng; không giả định envelope này áp dụng cho mọi lệnh CLI.

{
  "schema": "altifigence.cli.error.v1",
  "error": {
    "code": "ENGINE_JOB_JSON_INVALID",
    "message": "The engine job JSON is invalid.",
    "retryable": false
  }
}

Trạng thái thoát

Trạng thái	Diễn giải
`0`	Lệnh được chọn đã hoàn tất; đọc kết quả để xác định nó báo mức độ sẵn sàng, kiểm tra trước, kế hoạch hay thực thi
`1`	Lỗi runtime, xác thực, truyền tải hoặc cài đặt CLI; lỗi dịch vụ có thể gồm phản hồi HTTP
`2`	Đối số không hợp lệ hoặc yêu cầu bị từ chối trước truyền tải/khởi chạy engine; engine cũng có thể trả trạng thái này
`3`	Từ chối lớp dành riêng trên đường manifest khách hàng; engine có thể dùng cùng số theo nghĩa khác
`4`	Từ chối manifest khách hàng, bao gồm đăng nhập/định danh cấp cao nhất không khả dụng hoặc thiếu chấp thuận tải nguồn lên
`126`	Lỗi khởi chạy engine hoặc xác thực đã cài
`127`	Executable engine bắt buộc không khả dụng
Trạng thái khác ngoài 0	Có thể là trạng thái riêng của engine con được truyền qua

Luôn kiểm tra trạng thái thoát trước khi phân tích stdout và giữ stderr riêng. Tệp đầu ra rỗng hoặc một phần không phải kết quả thành công. Kế hoạch đã lưu không phải giao dịch đã áp dụng và máy chủ chấp nhận không phải job hoàn thành.

Lệnh engine: những gì thực sự chạy

Các adapter XLS, compute và DDS native dùng executable anh em đóng gói cố định. Thực thi đã cài xác thực runner liên quan theo bản ghi phát hành đã ký; thêm executable khác vào PATH không sửa được executable anh em bắt buộc bị thiếu. Một số lệnh tương thích cũ giữ hành vi resolver đã ghi trong tài liệu. Xem Bề mặt lệnh.

Không có --json, stdout engine được chuyển tiếp để kế hoạch native opaque có thể lưu trực tiếp. Với --json, lời gọi engine thường tạo altifigence.local-engine-execution.v1; các trường stdout và stderr chứa luồng tiến trình con dưới dạng chuỗi. Phân tích riêng kết quả bên trong.

Với kế hoạch tệp và phân cấp, truyền toàn bộ kết quả kế hoạch native cho lệnh apply tương ứng. Không truyền envelope CLI bên ngoài hoặc chỉ digest kế hoạch. Backend native xác thực hash tệp hiện tại và các điều kiện giao dịch của nó.

Đầu ra dịch vụ và truyền liên tục

ide service trả altifigence.dds.service-receipt.v1 với operation, ok, httpStatus, và phản hồi có giới hạn body. HTTP 409 từ thao tác thay thế vẫn là xung đột và không thử lại. Phản hồi DELETE thành công rỗng được giữ rỗng; không bịa thành đối tượng JSON máy chủ.

Tìm kiếm DDS native và tìm kiếm Cloud cung cấp bằng chứng khớp/nội dung riêng. Dùng định danh do backend bạn sẽ ghi vào cung cấp; hash tính cho backend tìm kiếm khác không tự động là token CAS hợp lệ.

ide cloud terminal truyền byte terminal trên stdout và trạng thái kết nối trên stderr. Nó không phải một biên nhận JSON đơn lẻ, kể cả với cờ toàn cục --json. Giới hạn thời lượng gắn kết nối và giữ cursor nếu định kết nối lại.

--json release install và --json release uninstall xuất altifigence.cli.release-bootstrap.v1 với operation, ok, và exitCode. Chẩn đoán trình cài đặt đi vào stderr. Lỗi xác minh hoặc quyền có thể xảy ra trước khi có envelope thành công.

Thu kết quả cho tự động hóa

Chọn thư mục đầu ra mới cho mỗi lần gọi. Lưu stdout và stderr riêng, lấy trạng thái thoát ngay lập tức và chỉ phân tích schema thành công sau mã thoát không. Với envelope engine, chỉ phân tích chuỗi stdout thành tài liệu native khi hợp đồng lệnh nói nó chứa JSON.

Với quy trình plan/apply, giữ toàn bộ kế hoạch native thô và dùng cùng dự án. Rà soát tệp bị ảnh hưởng và hash hiện tại trước apply. Xung đột đòi hỏi đọc mới và kế hoạch được rà soát; không phải lý do bỏ kiểm tra hash. Xem Tự động hóa và CI để có kiểm tra cục bộ có thể tái lập.