本页面由机器翻译。阅读英文原文。
Aggrega Wasm CLI Socket schema
自动生成的参考文档。请勿手动编辑——请从发布的 JSON Schema 重新生成。
Schema id:https://aggrega.ai/schemas/wasm-cli-v1beta1.schema.json
CLI 插件所消费的线路形态(CLIRunInput)。CLI 插件用于扩展 aggrega 命令行工具的命令集:宿主将子命令解析到一个 Wasm guest,并将本次调用的参数向量交给它;guest 执行后以整数返回值的形式返回进程退出码。标准输出和标准错误通过宿主函数传递,而不是通过线路载荷传递,因此该 socket 只声明输入形态。Go、Rust 和 TypeScript 的载荷类型由此 schema 生成到 plugin-ABI 包中,因此三种语言读写同一种线路数据;guest 从这些包中导入它,或通过重新导出它的插件工具包导入。
以下形态之一
CLIRunInput
定义
CLIRunInput
宿主在每次调用时交给 CLI 插件的载荷:位于已解析子命令名之后的参数向量。guest 将这些词元解析为自己的标志和位置参数,与独立命令行程序读取其名称之后的参数的方式完全相同。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
command | string | 是 | 宿主为本次调用分派的已解析子命令名。提供多个命令的插件根据此名称进行路由,以选择要运行的行为;单命令插件在此处收到其自身的命令名。宿主在调用 guest 之前从命令行解析该名称,并原样传递。 |
args | string[] | 是 | guest 接收的参数向量,按调用顺序排列——即命令行上位于已解析子命令名之后的词元。顺序会被保留,因此相同输入的多次运行所产生的载荷字节完全相同。 |
不允许其他属性。