CLI 命令接口

了解随附 alti 二进制文件如何路由命令行、本版本可访问的命名空间、各退出码的含义,以及每个命令实际运行的位置。

概览

本页索引原生 CLI、客户操作清单及各后端专用连接。本地设计工作请使用引擎命令;服务操作请使用作业与 Cloud 命令。示例适用于 0.1.9 接口。

两个解析器,一个二进制文件

原生解析器处理release, capabilities, rtl, sv, verification, trace, labs, tcl, eidb, eda, reports, physical, px, isa, ide, job, xls以及compute。它还处理analyze run以及显式 Evolve 形式capabilities, analyze, run, cx-search, measured-ppa以及artifact。其余客户命令使用内置操作清单。mcp serve启动 stdio MCP 服务器。

此路由排除的误解

eda inspect, reports parse, ide init以及列出的 Evolve 形式均路由为原生命令。其可用性不再受旧归档分发遗漏限制。引擎能力仍决定支持哪些输入或操作。

单词形式的客户evolve操作与原生evolve run和compute rtl-evolve分开。其请求 schema 不可互换。清单中的单词形式trace操作仍被原生trace命名空间遮蔽;请使用原生子命令,不要假定清单列出某项就保证相同 CLI 拼写可用。

全局标志

使用前置--json获取原生结构化输出,例如alti --json xls capabilities。将其放在命名空间前或完整原生子命令后,不要放在路由 Evolve 形式的单词之间。使用alti --help查看顶层概览,在具体子操作上使用--help查看可接受参数和限制。原生具体子命令也接受-h。

JSON 输出因命令而异。引擎封装将子进程结果包含为字符串,服务命令返回凭据,终端连接则流式传输字节。参阅命令参考.

元信息与账户命令

命令

行为

alti version, alti --version

打印 CLI 版本

alti commands

打印包含 25 个条目的客户操作清单

alti capabilities

检查已认证安装及其能力

alti auth status

报告环境配置,但不验证服务器身份

alti login, alti whoami

旧版顶层命令拒绝未验证身份,退出码为4

alti logout

旧版命令无法移除从父进程继承的凭据

alti ide cloud login

启动原生浏览器 PKCE 流程并存储私有 CLI 会话

alti ide cloud whoami

向服务器查询当前会话身份

alti ide cloud refresh, alti ide cloud logout

刷新或撤销原生 CLI 会话

alti mcp serve

以所选客户模式或本地 XLS 模式提供 stdio MCP

Cloud 会话与旧版环境凭据不同。参阅CLI 身份验证.

退出码

除非具体命令契约规定恢复操作,否则将所有非零结果视为失败。解析/准入通常返回2,运行时和 HTTP 失败返回1,引擎不可用返回127,无效安装执行或启动失败返回126。引擎可原样传递自身状态。客户清单另行使用3表示类别拒绝,使用4表示分发前拒绝。仅凭状态数字不能确定其来源。

在哪里运行

接口

执行与权限

xls, compute以及类型化本地引擎命令

当前机器上的打包原生引擎

xls upstream

当前 Linux 机器上单独安装且固定版本的 Google XLS 工具

ide workspace

所选本地目录,包括恢复和序列化原生变更

ide cloud

使用浏览器签发的 bearer 会话和服务器检查的组织/项目权限的原生 API 路由

ide service

操作者选择的旧版 DDS HTTP 服务,遵循现有服务密钥契约

job validate

仅进行离线源文件和封装对象验证

job ... --runner cloud, analyze run

已配置的 Cloud 作业服务,受就绪状态和权限限制

默认客户 MCP

Cloud 客户端分发;stdio 传输不会使执行变为本地

ALTI_MCP_MODE=local-xls MCP

固定本地 XLS 工具,不经过客户 Cloud 分发

哪些子命令带有 –runner

兼容命令rtl compile, rtl synthesize, physical run, px analyze以及isa run默认为local。在这些命令上选择cloud或private会输出分发骨架计划,并非远程执行。其--引擎参数仅适用于本地分发。

此job命令族的--runner选择 Job Service,这是不同契约。已退役的alti-engine-job适配器不在 24 个运行器的发布清单中;不要将接受的local/private语法理解为已交付服务。

如何查找本地引擎

保持已安装发布内容完整。XLS、compute、打包 RTL、原生 DDS 及类型化 PX/CX 路径都需要指定名称的同级可执行文件。安装信任检查将受保护运行器绑定到目录哈希及凭据;不存在能够修复此边界的PATH回退路径或用户提供凭据。旧版兼容解析器可能报告sibling或path;请检查实际运行操作的凭据。Icarus 等外部工具有独立主机配置。

各命名空间使用的引擎

载荷包含alti, alti-mcp以及以下 24 个引擎运行器:

命令

打包引擎

RTL、分析、SV、验证

alti-rtlc, alti-rtl, alti-rtl-analyze, alti-sv-frontend, alti-sv-immediate-review, alti-sv-interprocess-review, alti-golden-diff

ISA、Evolve

alti-cx, alti-evolve

物理设计、PX

alti-physical-runner, alti-px-runner, alti-px-sta-graph-check

跟踪、Labs

alti-trace, alti-lab

Tcl、EIDB、EDA、报告

alti-tcl, alti-tcl-local-runner, alti-eidb-local-runner, alti-eda-artifact-inspect, alti-reports

XLS 与 compute

alti-xls, alti-compute, alti-packed-cuda, alti-rtl-cuda

原生 DDS

alti-ide-workspace

alti-rtl-runner未打包。请求它的 committed-identity 兼容命令不会仅因提供帮助就获得支持。以下命令使用的桌面可执行文件ide open单独分发。

凭据封装

Schema 或输出

含义

altifigence.local-engine-execution.v1

使用--json时包含命令、可执行文件、解析方式、状态、exitCode及捕获的引擎输出流

altifigence.cli.engine-job-preflight.v1

离线验证;submitted和server_authority_verified保持 false

altifigence.cli.tcl-evaluation.v1

限定范围的已安装 Tcl 求值结果

altifigence.ide-launcher-receipt.v1

桌面进程启动状态,不能证明项目已完成加载

altifigence.dds.service-receipt.v1

旧版服务 HTTP 状态及限定大小响应体

altifigence.cli.release-bootstrap.v1

安装/卸载完成状态,辅助程序诊断输出至 stderr

Cloud 终端 stdout

流式终端字节,不是单一 JSON 凭据

引擎封装的stdout是包含原生结果的字符串。不使用--json时,可直接保存原生输出,并完整传递给对应 DDS apply 命令。切勿将编写计划缩减为仅有哈希。

环境变量

变量

范围

ALTI_TOKEN, ALTI_ORG_ID

旧版客户操作/作业客户端凭据及组织范围

ALTI_API_BASE

旧版 API 来源覆盖;默认为https://api.altifigence.com

ALTI_BYO

旧版主体类型选择;不代表执行权限

ALTI_ALLOW_SOURCE_UPLOAD

客户 MCP 操作的源文件上传授权

ALTI_MCP_MODE

customer为默认值,或显式使用local-xls

ALTI_STUDIO_ENDPOINT

明确指定的旧版 DDS 服务来源;原生 Cloud 使用自己的端点/会话参数

ALTI_STUDIO_SERVICE_SECRET

现有旧版服务认证;不是原生 Cloud bearer 会话

ALTIF_RTL_IVERILOG, ALTIF_RTL_VVP

原生 RTL 求值器使用的主机所有外部 Icarus 工具位置

原生 Cloud 使用--session-dir,默认为~/.local/state/altifigence/cloud-cli。不要将桌面会话文件复制到其中、记录令牌,或向任意端点发送服务密钥。

引擎结果

阅读实际引擎结果及其限制。GPU 发现不是 GPU 执行,内容摘要不是签名,非签核时序估算不是实现签核。下一页列出相关引擎命令.

编写脚本前确认命令

Bash
alti --version
alti --help
alti ide cloud --help
alti xls run --help

检查计划调用的准确具体子命令帮助。以下列表中名称匹配alti commands不能代替原生解析器帮助、已安装能力或运行时可用情况。请求 schema 和凭据有版本,请随脚本保留 CLI 版本。