Схема сокета Aggrega Wasm CLI
Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.
Ідентифікатор схеми: https://aggrega.ai/schemas/wasm-cli-v1beta1.schema.json
Формат передавання, який споживає плагін CLI (CLIRunInput). Плагін CLI розширює набір команд інструмента командного рядка aggrega: хост зіставляє підкоманду з гостьовим модулем Wasm і передає йому вектор аргументів виклику; гостьовий модуль виконується і повертає код завершення процесу як своє цілочислове значення, що повертається. Стандартний вивід і стандартний потік помилок проходять через функції хоста, а не через корисне навантаження, тому цей сокет оголошує лише формат вхідних даних. Тип корисного навантаження для Go, Rust і TypeScript генерується з цієї схеми в пакети plugin-ABI, тож усі три мови читають і записують ті самі дані передавання; гостьовий модуль імпортує його з цих пакетів або через свій набір для плагінів, який його реекспортує.
Одна з наведених нижче форм
CLIRunInput
Визначення
CLIRunInput
Корисне навантаження, яке хост передає плагіну CLI під час кожного виклику: вектор аргументів, що йдуть після імені визначеної підкоманди. Гостьовий модуль розбирає ці токени як власні прапорці та позиційні аргументи — так само, як окрема програма командного рядка читає аргументи після свого імені.
| Властивість | Тип | Обов’язкова | Опис |
|---|---|---|---|
command | string | так | Ім’я визначеної підкоманди, на яку хост спрямував цей виклик. Плагін, що додає кілька команд, маршрутизує за цим ім’ям, щоб вибрати поведінку для виконання; плагін з однією командою отримує тут ім’я власної команди. Хост визначає ім’я з командного рядка перед викликом гостьового модуля і передає його дослівно. |
args | string[] | так | Вектор аргументів, який отримує гостьовий модуль, у порядку виклику — токени, що йдуть після імені визначеної підкоманди в командному рядку. Порядок зберігається, тому корисне навантаження побайтово ідентичне між запусками з ідентичними вхідними даними. |
Додаткові властивості не дозволені.