Schemat gniazda Aggrega Wasm CLI
Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.
Identyfikator schematu: https://aggrega.ai/schemas/wasm-cli-v1beta1.schema.json
Kształt danych przesyłanych, który konsumuje wtyczka CLI (CLIRunInput). Wtyczka CLI rozszerza zestaw poleceń narzędzia wiersza poleceń aggrega: host przypisuje podpolecenie do gościa Wasm i przekazuje mu wektor argumentów wywołania; gość wykonuje się i zwraca kod wyjścia procesu jako swoją całkowitoliczbową wartość zwracaną. Standardowe wyjście i standardowe wyjście błędów przepływają przez funkcje hosta, a nie przez ładunek przesyłany, dlatego to gniazdo deklaruje wyłącznie kształt wejścia. Typ ładunku dla Go, Rust i TypeScript jest generowany z tego schematu do pakietów plugin-ABI, więc trzy języki odczytują i zapisują jeden format przesyłany; gość importuje go z tych pakietów albo przez swój zestaw narzędzi dla wtyczek, który go reeksportuje.
Jeden z następujących kształtów
CLIRunInput
Definicje
CLIRunInput
Ładunek, który host przekazuje wtyczce CLI przy każdym wywołaniu: wektor argumentów następujących po nazwie rozpoznanego podpolecenia. Gość analizuje te tokeny jako własne flagi i argumenty pozycyjne, dokładnie tak, jak samodzielny program wiersza poleceń odczytuje argumenty następujące po jego nazwie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
command | string | tak | Nazwa rozpoznanego podpolecenia, do którego host skierował to wywołanie. Wtyczka udostępniająca kilka poleceń kieruje się tą nazwą, aby wybrać zachowanie do uruchomienia; wtyczka z jednym poleceniem otrzymuje tu nazwę własnego polecenia. Host ustala nazwę z wiersza poleceń przed wywołaniem gościa i przekazuje ją dosłownie. |
args | string[] | tak | Wektor argumentów, który otrzymuje gość, w kolejności wywołania — tokeny następujące w wierszu poleceń po nazwie rozpoznanego podpolecenia. Kolejność jest zachowywana, dzięki czemu ładunek jest identyczny bajt po bajcie w kolejnych uruchomieniach dla identycznego wejścia. |
Dodatkowe właściwości są niedozwolone.