Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

aggrega plugin

Przegląda wtyczki Wasm, które CLI potrafi rozwiązać

Składnia

aggrega plugin

Opis

Work with the WebAssembly plugins this CLI can resolve.
All of Aggrega's provider-specific and policy-specific behaviour lives in Wasm
plugins rather than in the binary, so this is where you see which ones are
reachable, add or remove a workspace binding, and check a guest before you
publish it.
Plugins reach the CLI two ways. Some are compiled into the binary and resolve
with no filesystem, cache or network access. The rest are workspace bindings in
.aggrega-config.yaml, resolved through the plugin cascade. "aggrega plugin list"
shows both groups together.
The subcommands below cover the whole life of a binding: list what is reachable,
add and remove bindings, run a local guest export directly, sync the
machine-owned records in a Plugin entity with its .wasm, and generate Plugin
catalog entities from a guest's own metadata.

Podpolecenia

PolecenieOpis
aggrega plugin addZnajduje w rejestrze wtyczkę podanego typu i dodaje ją
aggrega plugin gen-catalogGeneruje encje katalogu Plugin z describe() gościa oraz utworzonej nakładki
aggrega plugin listWyświetla wtyczki, które CLI potrafi rozwiązać, wraz z ich metadanymi describe()
aggrega plugin removeUsuwa skonfigurowaną wtyczkę podanego typu
aggrega plugin run-localŁaduje lokalnego gościa .wasm i wywołuje jeden z jego eksportów
aggrega plugin syncSynchronizuje rekordy wtyczki zarządzane maszynowo (funkcje hosta, polecenia CLI) w jej pliku encji z jej plikiem .wasm

Opis aggrega plugin add

Find a plugin of the named type in the configured registry and add it to your
configuration.
Examples:
aggrega plugin add cli moo # add the moo command
aggrega plugin add cli moo:0.2.4 # a specific version
aggrega plugin add governance rego --role render-verdict
Arguments:
<type> The plugin socket to add for. One of: provider, governance,
linter, importer, or cli. The governance type requires --role.
<query> The plugin's name, optionally followed by :<version> to add that
version rather than the latest published one. The name is looked
up directly first. Where no plugin of the chosen type has that name,
it is matched as a case-insensitive substring against the plugin
names of that type, which reads the registry's whole catalog and
must resolve to exactly one plugin — otherwise the command lists the
candidates so you can narrow it. A query naming a version is never
matched that way. The provider type takes no version.
What add writes depends on the type:
- A socket type (governance, linter, importer) pins the version the query
names, or else the latest published version, and adds the bare plugin
identity (<type>/<name>:<version>) to the plugins.<type> list. The latest
is never taken from pre-release versions, so a plugin that publishes only
those is added by naming one. A governance entry also records its --role,
one of annotation-transform, label-transform, ir-verdict, or render-verdict.
An importer the plugins.importer list already names keeps its one entry,
moved to the pinned version with its place and what it carries under with.
- The provider type adds a plugins.providers entry naming the plugin by its
bare identity (provider/<name>) with no version; --capability names the
capability the binding serves, preserving existing settings. The version is
the one the Recipe pins, or else the highest available, and the lockfile
records the one a pull chose.
- The cli type fetches the plugin from the registry, verifies it, and caches
its bytes, then pins it into the plugins.cli list as a top-level aggrega
command — no separate pull step. Its resolved reference and the content
digest of the verified bytes are recorded so the command runs those exact
bytes, resolving from the local cache on later runs with no further network
access. A cli plugin defaults to the global config, so its command is
available in every workspace; --workspace pins it to this project instead.
It needs no workspace: run outside one, its bytes are cached in the
machine-wide cache rather than in the folder you ran it in. Its declared
capabilities are confirmed before installing, and --accept-capabilities or
--yes skips that prompt for non-interactive use.
A provider or socket attachment is written to a workspace's own configuration
unless --global is passed, so outside a workspace it is refused before the
registry is reached; so is anything else that can be refused without it.
A provider or socket attachment is configuration you go on editing, so --dry-run
does everything the plain command does except write: it hands back the
configuration the write would have produced, creating and modifying nothing. The
answer names the file that content is for — which matters here, because a
--global attachment targets the config shared across every workspace. A caller
that keeps its own document model puts the content there, where it is visible
before it is saved and can be amended or undone. The registry is still searched,
and for a socket type the version still resolved, since the returned document
carries the identity a write would have written.
Under --dry-run standard output carries that content and nothing else, so it stays
parseable; a version substitution is announced on standard error instead. The cli
type does not accept --dry-run: what it records is the content digest of the bytes
it verified, which is a record the machine maintains rather than content you
edit.

Flagi aggrega plugin add

FlagaDomyślnieOpis
--accept-capabilitiesfalseAkceptuje zadeklarowane uprawnienia wtyczki cli bez interaktywnego monitu (tylko typ cli)
--capability—Uprawnienie obsługiwane przez powiązanie dostawcy (wymagane dla typu provider i dozwolone tylko z nim)
--dry-runfalseWykonuje wszystko poza zapisem: zwraca wynikową konfigurację jako treść, wskazując plik, którego dotyczy, i niczego nie tworzy ani nie modyfikuje. Bez tej flagi dołączenie jest zapisywane do rozwiązanego pliku konfiguracyjnego. Niedozwolone z typem cli.
--globalfalseZapisuje dołączenie do globalnej konfiguracji współdzielonej przez wszystkie obszary robocze.
--role—Rola dołączenia governance: annotation-transform, label-transform, ir-verdict lub render-verdict (wymagana dla typu governance i dozwolona tylko z nim)
--workspacefalseZapisuje dołączenie do konfiguracji obszaru roboczego tego projektu. Dołączenie provider lub socket domyślnie trafia tutaj; wtyczka cli domyślnie trafia do konfiguracji globalnej.
--yesfalsePomija monit potwierdzenia uprawnień cli przy użyciu nieinteraktywnym (tylko typ cli)

Opis aggrega plugin gen-catalog

Generate one Plugin entity per selected Wasm guest.
Each entity's contract fields — pluginType, abiVersion, capabilities, exports,
and contract — are derived from the guest's describe() self-report, so the
entity can never promise a capability the binary does not provide. The entity's
identity (metadata.name), runtime limits, and provider block come from an authored
per-plugin overlay; the entity version is the guest's describe() self-report
version. The plugin-level description, when the guest reports one, is emitted as
metadata.description and omitted cleanly when it does not.
Two selection modes:
--from-embedded generate an entity for every guest embedded in this binary.
The overlay path is a directory; each overlay is matched to
a guest by its metadata.name identity, and, where overlays
in several socket directories (<socket>/<name>.yaml)
declare one name, by the directory naming the guest's
socket.
--plugin <f.wasm> generate a single entity for one non-embedded guest. The
overlay path is a single overlay file.
The output is written under <output-dir>/<pluginType>/<name>/<version>/plugin.yaml
and carries a generated-output banner. The leading pluginType segment keeps two
same-named plugins in different sockets apart, since a bare plugin name is unique
only within its own socket. Regenerating over unchanged inputs yields
byte-identical files.
A generated entity is a catalog document you own and go on editing, so --dry-run
does everything gen-catalog does except write: it hands the content back, creating
and modifying nothing, and the answer names the file each document is for. A
caller that keeps its own document model — an editor, for instance — puts the
content there, where it is visible before it is saved and can be amended or
undone. Every other behaviour is the write's — the same guests are read and the
same overlays matched — so a selection gen-catalog would refuse is refused under
--dry-run too. Without the flag the entities are written, because a caller at a
terminal has nowhere better to put them.

Flagi aggrega plugin gen-catalog

FlagaDomyślnieOpis
--dry-runfalseWykonuje wszystko poza zapisem: zwraca wygenerowane encje jako treść, wskazując plik, którego dotyczy każda z nich, i niczego nie tworzy ani nie modyfikuje. Całe pozostałe zachowanie jest takie jak przy zapisie, więc wybór, który zapis by odrzucił, jest odrzucany również tutaj. Bez tej flagi encje są zapisywane w —output-dir.
--from-embeddedfalsegeneruje encję dla każdego gościa osadzonego w tym pliku binarnym
--output-dir—katalog, w którym zapisywane są wygenerowane encje (wymagane)
--overlay—katalog utworzonej nakładki (—from-embedded) lub plik (—plugin) (wymagane)
--plugin—generuje pojedynczą encję dla gościa .wasm pod tą ścieżką

Opis aggrega plugin list

List every Wasm plugin the CLI can see and, for each, its self-reported
describe() metadata.
Two groups are printed. Embedded built-ins are the provider and linter guests
compiled into the binary; they resolve with no filesystem, cache, or network
access. Configured plugins are the workspace bindings — the provider and linter
bindings and the CLI-extension commands — resolved through the plugin cascade.
Each plugin's type appears in the TYPE column, so a CLI-extension command
(type cli) is legible alongside the socket plugins; a CLI plugin also carries a
status of its own — ready, unresolved, describe-failed, or digest-drift when
its bytes changed since it was pinned at install.
The default output is a scannable table with one row per plugin, showing its
type, name, served capabilities, and version. The output is read-only and
deterministic. A plugin that fails to resolve or describe is listed with its
failure status rather than halting the whole listing.
With -o json, the output is a structured object carrying the full per-plugin
detail — type, name, version, commit, capabilities, input kinds, boundary
assembly, exports, origin, readiness, and any resolve or describe error —
grouped as embedded and configured. It is suitable for programmatic
consumption and documentation generation.

Flagi aggrega plugin list

FlagaDomyślnieOpis
--output, -otableFormat wyjścia: table|json.

Opis aggrega plugin remove

Remove a configured plugin of the named type from a config file so it no longer
participates.
The type is one of provider, governance, linter, importer, or cli — the same
set 'plugin add' accepts. The query identifies the entry to remove: the plugin's
short name (matched against 'add's short name so remove is symmetric with add),
its full pinned reference, or, for the provider type, the capability the binding
serves. A query that matches nothing halts and leaves the config untouched, so a
typo never silently removes the wrong plugin.
A provider or socket attachment defaults to this project's workspace config; a cli
command defaults to the global config shared across every workspace. --global and
--workspace force the file the removal targets, overriding the default.

Flagi aggrega plugin remove

FlagaDomyślnieOpis
--globalfalseUsuwa z globalnej konfiguracji współdzielonej przez wszystkie obszary robocze.
--workspacefalseUsuwa z konfiguracji obszaru roboczego tego projektu. Dołączenie provider lub socket domyślnie dotyczy tej konfiguracji; polecenie cli domyślnie dotyczy konfiguracji globalnej.

Opis aggrega plugin run-local

Load a .wasm guest from a filesystem path, call one of its declared
exports with an optional payload, and write the guest's answer to stdout.
The guest is addressed directly by --plugin path; it is not resolved through
the workspace plugin cascade. The export named by --export must be one the
guest advertises in its describe() self-report, or the call is rejected before
the guest runs.
The command has two forms. The artifact form takes no positional argument and
loads the guest bare. The entity form takes a Plugin entity file as its one
positional argument: the entity is schema-validated, and its declared
metadata.pluginType and export contract are cross-checked against the guest's
describe() before the guest runs. In both forms the guest bytes come from
--plugin; the entity carries no artifact path.
The payload is supplied with --with, and it is always written as JSON. A value
beginning with @ reads the payload bytes from a file (--with @input.json); any
other value is taken as a literal inline JSON payload (--with '{"k":1}'). When
--with is omitted, the export receives the minimal empty JSON object {}. The
resolved payload is validated as JSON before the guest runs, so malformed input
is reported up front.
An export a socket calls with a payload reads it in a binary encoding rather
than as JSON; a CLI plugin's cli_run export is the exception, and reads JSON.
Which encoding an export reads is fixed by the socket that export serves, so no
flag selects it: the resolved payload is converted into the encoding the named
export reads before the guest is called. The conversion reads the payload's
shape from the export's name, so it covers each export a socket calls by
default; an entry function an attachment or a pipeline step names under a name
of its own receives the payload as written. The authored payload stays JSON
either way.
The answer is converted the same way in reverse. An export a socket calls
answers in that binary encoding, so its answer is read as the export's output
shape and written to stdout as indented JSON; an answer that is not that shape
is reported as an error naming the export rather than printed. A cli_run
export's answer, and an entry function under a name of its own, are written to
stdout exactly as the guest wrote them. When the guest exits non-zero, what it
wrote is passed through unchanged.
In the artifact form, --type optionally names a plugin type the guest's
describe() self-report must agree with, or the load is rejected before the
guest runs; when omitted, no type expectation is imposed. In the entity form
--type is rejected, because the entity's metadata.pluginType supplies the type.
The guest's clean exit code becomes this command's exit status, so a failure
inside the plugin is distinguishable from a failure of aggrega itself.

Flagi aggrega plugin run-local

FlagaDomyślnieOpis
--export—zadeklarowany eksport do wywołania
--plugin—ścieżka w systemie plików do artefaktu .wasm
--type—typ wtyczki, z którym musi się zgadzać samoopis describe() gościa
--with—ładunek dla eksportu: JSON podany bezpośrednio lub @, aby odczytać go z pliku; domyślnie {}, gdy pominięty

Opis aggrega plugin sync

Sync a plugin's machine-owned records in a Plugin entity file with its .wasm.
Two records are not authored by hand: the set of host functions a plugin may
call, derived from the plugin's .wasm import section, and the top-level commands a
CLI plugin contributes, read from the plugin's describe() self-report. Both are
ground truth in the binary. This command reads the .wasm, derives the
host-function set in canonical form and the command mirror in describe()-declared
order, and aligns the entity's spec.runtime.hostFunctions and spec.commands with
them — creating the runtime block when the file has none. Only those blocks
change; every comment, blank line, and other field is preserved byte-for-byte. A
plugin that imports no host functions or contributes no commands records an
explicit empty list, so each field is always present and reviewable.
The write is idempotent: re-running when the records already match the .wasm
leaves the file untouched. Commit the result; publish (aggrega push) then only
verifies the committed records against the .wasm and refuses to publish a file
whose records are out of sync with its binary.

Flagi aggrega plugin sync

FlagaDomyślnieOpis
--plugin—Ścieżka do artefaktu .wasm wtyczki, którego importy i describe() określają zapisywane funkcje hosta i polecenia

Co robi wpis importera

aggrega plugin add importer zapisuje tożsamość wtyczki i najnowszą opublikowaną dla niej wersję albo wersję podaną jako <name>:<version> — importer/<name>:<version> — na liście plugins.importer. Ten wpis dołącza wskazany w nim importer: import żądający formatu, który importer deklaruje, uruchamia ten importer w tej wersji, nawet jeśli inne importery w katalogu również deklarują ten format, i tylko ten importer otrzymuje to, co wpis zawiera pod with. Pełny opis wpisu zawiera sekcja Który importer przekształca źródło w szkice.

Importer jest dołączany jednym wpisem, więc dodanie importera, który lista plugins.importer zapisywanego pliku już wskazuje — w dowolnej wersji lub przez zakres — nie dodaje drugiego wpisu. Zamiast tego polecenie przenosi ten wpis na rozwiązaną wersję: wpis zachowuje swoje miejsce na liście i wszystko, co zawiera pod with. Dodanie importera w wersji, którą jego wpis już wskazuje, pozostawia wpis bez zmian.

Polecenia wtyczki CLI i ich flagi

Przy każdym uruchomieniu aggrega dodaje po jednym poleceniu dla każdego polecenia, które wnosi skonfigurowana wtyczka cli, odczytując polecenia i ich flagi z samoopisu describe() wtyczki — z pamięci podręcznej opisów, gdy przechowuje ona przypięty skrót wtyczki, a w przeciwnym razie przez opisanie wtyczki. Każda zadeklarowana flaga jest deklarowana w swoim poleceniu, tak aby aggrega help <command> wyświetlało ją tak samo, jak wyświetla flagi polecenia wbudowanego; wtyczka nadal otrzymuje swoje argumenty nieprzetworzone i sama odczytuje własne flagi.

Przypięty skrót znajduje się obok odwołania do wtyczki na liście plugins.cli konfiguracji i jest zapisywany jako sha256:, po którym następują 64 cyfry szesnastkowe zapisane małymi literami — w takiej postaci, jaką zapisuje aggrega plugin add cli. Skrót zapisany w jakikolwiek inny sposób, na przykład jako same cyfry szesnastkowe bez prefiksu sha256:, jest odrzucany podczas wczytywania pliku konfiguracji, z podaniem pliku i wpisu; dopóki nie zostanie poprawiony, nie jest dodawane polecenie żadnej skonfigurowanej wtyczki, a odrzucenie zgłasza ostrzeżenie na standardowym wyjściu błędów.

Zanim doda którekolwiek z poleceń wtyczki, aggrega sprawdza każdą flagę, którą deklaruje każde z nich. Wtyczka, której deklaracje nie przechodzą sprawdzenia, jest pomijana: żadne z jej poleceń nie zostaje dodane, jedno ostrzeżenie na standardowym wyjściu błędów podaje wtyczkę, polecenie, flagę i to, co jest z nią nie tak, a każde inne polecenie — wbudowane lub pochodzące z innej wtyczki — działa jak zwykle:

warning: CLI plugin "oci://hub.aggrega.ai/plugin/cli/greet:1.2.0" was not added as a command: its command "greet" declares the flag "--verbose" with the shorthand "vv"; a shorthand is a single ASCII letter or digit

Deklaracja flagi przechodzi sprawdzenie, gdy:

  • flaga ma nazwę i żadna inna flaga tego samego polecenia nie ma tej nazwy;
  • jej skrót, jeśli go ma, jest pojedynczą literą lub cyfrą ASCII, której nie używa żadna inna flaga tego samego polecenia;
  • ani jej nazwa, ani skrót nie powtarzają flagi, którą ma już każde polecenie aggrega — --help, -h i flag globalnych;
  • jej typ, jeśli go deklaruje, to string, bool lub int — flaga bez typu jest flagą tekstową;
  • jej wartość domyślna, jeśli ją deklaruje, jest wartością jej typu.

Pominięcie, wraz z ostrzeżeniem, powtarza się przy każdym wywołaniu, dopóki konfiguracja nie przypnie wersji pluginu, której deklaracje przechodzą sprawdzenie. Pola, które zawiera deklaracja flagi, opisano w sekcji spec.commands na stronie encji Plugin w dokumentacji.

Generowanie encji i synchronizacja rekordów: dwa różne rodzaje działań

Dwa z tych podpoleceń tworzą plik, a to, co tworzą, nie jest tego samego rodzaju.

plugin gen-catalog — wygenerowane encje można dalej edytować

aggrega plugin gen-catalog tworzy encje katalogu typu Plugin. Encja jest dokumentem katalogu: należy ją zapisać, przejrzeć i dalej edytować razem z resztą katalogu. Ponieważ jest to treść należąca do użytkownika, polecenie może ją przekazać zamiast zapisywać na dysku.

--dry-run wykonuje wszystko, co robi gen-catalog, z wyjątkiem zapisu. Zwraca wygenerowane encje jako treść — nie jest tworzony żaden plik ani katalog — a każdy dokument w odpowiedzi wskazuje plik, dla którego jest przeznaczony, dzięki czemu wywołujący wie, gdzie należy umieścić każdy z nich. Wywołujący, który utrzymuje własny model dokumentów, na przykład edytor, umieszcza tam tę treść, gdzie można ją zobaczyć przed zapisaniem oraz poprawić lub cofnąć. Bez tej flagi encje są zapisywane w --output-dir, ponieważ wywołujący w terminalu nie ma lepszego miejsca, by je umieścić.

Zwracana treść i zapisywane bajty to ta sama treść: --dry-run zwraca to, co zapis by utworzył, a nie osobno składany podgląd. Każde inne zachowanie również jest takie samo jak przy zapisie — odczytywane są te same moduły gościa, dopasowywane te same nakładki, a --output-dir jest wymagane w obu przypadkach, ponieważ każdy zwracany dokument nadal wskazuje plik, dla którego jest przeznaczony, a ta ścieżka jest z niego składana.

Każda encja jest składana i walidowana, zanim którakolwiek z nich zostanie dostarczona, więc uruchomienie tworzy albo cały zestaw, albo nic. Nakładka, która zatrzymuje generowanie — brakująca lub taka, której tożsamość nie zgadza się z modułem gościa, z którym jest scalana — nie pozostawia częściowo zapisanych wyników do posprzątania.

plugin sync — rekordy zarządzane maszynowo należą do kompilatora

aggrega plugin sync uzgadnia rekordy pluginu zarządzane maszynowo z jego modułem: zestaw funkcji hosta wyprowadzony z sekcji importu modułu oraz lustro poleceń odczytane z własnego samoopisu pluginu. Oba stanowią stan faktyczny zawarty w pliku binarnym, a nie wartości wybierane przez kogokolwiek.

Zawsze zapisuje i nie oferuje --dry-run. Dotyczy to także sytuacji, gdy zapisuje do pliku encji utworzonego przez użytkownika — granica przebiega według treści, a nie według pliku. Rekordów, które kompilator utrzymuje na własny temat, nie edytuje użytkownik, więc nie ma czego przeglądać przed ich zapisaniem; otaczający dokument pozostaje nietknięty bajt po bajcie, a zmieniają się tylko te bloki.