aggrega plugin
Memeriksa plugin Wasm yang dapat diresolusikan CLI
Sinopsis
aggrega pluginDeskripsi
Work with the WebAssembly plugins this CLI can resolve.
All of Aggrega's provider-specific and policy-specific behaviour lives in Wasmplugins rather than in the binary, so this is where you see which ones arereachable, add or remove a workspace binding, and check a guest before youpublish it.
Plugins reach the CLI two ways. Some are compiled into the binary and resolvewith 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 themachine-owned records in a Plugin entity with its .wasm, and generate Plugincatalog entities from a guest's own metadata.Subperintah
| Perintah | Deskripsi |
|---|---|
aggrega plugin add | Menemukan plugin dengan tipe yang disebutkan di registry dan menambahkannya |
aggrega plugin gen-catalog | Menghasilkan entitas katalog Plugin dari describe() milik guest ditambah overlay yang ditulis manual |
aggrega plugin list | Mencantumkan plugin yang dapat di-resolve CLI beserta metadata describe()-nya |
aggrega plugin remove | Menghapus plugin terkonfigurasi dengan tipe yang disebutkan |
aggrega plugin run-local | Memuat guest .wasm lokal dan memanggil salah satu export-nya |
aggrega plugin sync | Menyinkronkan catatan yang dikelola mesin milik plugin (fungsi host, perintah CLI) dalam file entitasnya dengan .wasm-nya |
Deskripsi aggrega plugin add
Find a plugin of the named type in the configured registry and add it to yourconfiguration.
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 configurationunless --global is passed, so outside a workspace it is refused before theregistry 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-rundoes everything the plain command does except write: it hands back theconfiguration the write would have produced, creating and modifying nothing. Theanswer names the file that content is for — which matters here, because a--global attachment targets the config shared across every workspace. A callerthat keeps its own document model puts the content there, where it is visiblebefore 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 documentcarries the identity a write would have written.
Under --dry-run standard output carries that content and nothing else, so it staysparseable; a version substitution is announced on standard error instead. The clitype does not accept --dry-run: what it records is the content digest of the bytesit verified, which is a record the machine maintains rather than content youedit.Flag aggrega plugin add
| Flag | Default | Deskripsi |
|---|---|---|
--accept-capabilities | false | Menerima capability yang dideklarasikan plugin cli tanpa prompt interaktif (hanya tipe cli) |
--capability | — | Capability yang dilayani binding provider (wajib untuk, dan hanya berlaku dengan, tipe provider) |
--dry-run | false | Melakukan segalanya kecuali menulis: mengembalikan konfigurasi yang dihasilkan sebagai konten, dengan menyebutkan file tujuannya, dan tidak membuat atau mengubah apa pun. Tanpa flag ini, lampiran ditulis ke file konfigurasi yang di-resolve. Tidak diterima dengan tipe cli. |
--global | false | Menulis lampiran ke konfigurasi global yang digunakan bersama oleh setiap workspace. |
--role | — | Peran lampiran governance: annotation-transform, label-transform, ir-verdict, atau render-verdict (wajib untuk, dan hanya berlaku dengan, tipe governance) |
--workspace | false | Menulis lampiran ke konfigurasi workspace proyek ini. Lampiran provider atau socket secara default ditulis di sini; plugin cli secara default ditulis ke konfigurasi global. |
--yes | false | Melewati prompt konfirmasi capability cli untuk penggunaan non-interaktif (hanya tipe cli) |
Deskripsi 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 theentity can never promise a capability the binary does not provide. The entity'sidentity (metadata.name), runtime limits, and provider block come from an authoredper-plugin overlay; the entity version is the guest's describe() self-reportversion. The plugin-level description, when the guest reports one, is emitted asmetadata.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.yamland carries a generated-output banner. The leading pluginType segment keeps twosame-named plugins in different sockets apart, since a bare plugin name is uniqueonly within its own socket. Regenerating over unchanged inputs yieldsbyte-identical files.
A generated entity is a catalog document you own and go on editing, so --dry-rundoes everything gen-catalog does except write: it hands the content back, creatingand modifying nothing, and the answer names the file each document is for. Acaller that keeps its own document model — an editor, for instance — puts thecontent there, where it is visible before it is saved and can be amended orundone. Every other behaviour is the write's — the same guests are read and thesame 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 aterminal has nowhere better to put them.Flag aggrega plugin gen-catalog
| Flag | Default | Deskripsi |
|---|---|---|
--dry-run | false | Melakukan segalanya kecuali menulis: mengembalikan entitas yang dihasilkan sebagai konten, dengan menyebutkan file tujuan masing-masing, dan tidak membuat atau mengubah apa pun. Setiap perilaku lain adalah perilaku penulisan, sehingga pilihan yang akan ditolak oleh penulisan juga ditolak di sini. Tanpa flag ini, entitas ditulis di bawah —output-dir. |
--from-embedded | false | menghasilkan entitas untuk setiap guest yang disematkan dalam biner ini |
--output-dir | — | direktori tempat entitas yang dihasilkan ditulis (wajib) |
--overlay | — | direktori (—from-embedded) atau file (—plugin) overlay yang ditulis manual (wajib) |
--plugin | — | menghasilkan satu entitas untuk guest .wasm di jalur ini |
Deskripsi aggrega plugin list
List every Wasm plugin the CLI can see and, for each, its self-reporteddescribe() metadata.
Two groups are printed. Embedded built-ins are the provider and linter guestscompiled into the binary; they resolve with no filesystem, cache, or networkaccess. Configured plugins are the workspace bindings — the provider and linterbindings 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 astatus of its own — ready, unresolved, describe-failed, or digest-drift whenits bytes changed since it was pinned at install.
The default output is a scannable table with one row per plugin, showing itstype, name, served capabilities, and version. The output is read-only anddeterministic. A plugin that fails to resolve or describe is listed with itsfailure status rather than halting the whole listing.
With -o json, the output is a structured object carrying the full per-plugindetail — type, name, version, commit, capabilities, input kinds, boundaryassembly, exports, origin, readiness, and any resolve or describe error —grouped as embedded and configured. It is suitable for programmaticconsumption and documentation generation.Flag aggrega plugin list
| Flag | Default | Deskripsi |
|---|---|---|
--output, -o | table | Format output: table|json. |
Deskripsi aggrega plugin remove
Remove a configured plugin of the named type from a config file so it no longerparticipates.
The type is one of provider, governance, linter, importer, or cli — the sameset 'plugin add' accepts. The query identifies the entry to remove: the plugin'sshort 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 bindingserves. A query that matches nothing halts and leaves the config untouched, so atypo never silently removes the wrong plugin.
A provider or socket attachment defaults to this project's workspace config; a clicommand defaults to the global config shared across every workspace. --global and--workspace force the file the removal targets, overriding the default.Flag aggrega plugin remove
| Flag | Default | Deskripsi |
|---|---|---|
--global | false | Menghapus dari konfigurasi global yang digunakan bersama oleh setiap workspace. |
--workspace | false | Menghapus dari konfigurasi workspace proyek ini. Lampiran provider atau socket secara default ada di sini; perintah cli secara default ada di konfigurasi global. |
Deskripsi aggrega plugin run-local
Load a .wasm guest from a filesystem path, call one of its declaredexports with an optional payload, and write the guest's answer to stdout.
The guest is addressed directly by --plugin path; it is not resolved throughthe workspace plugin cascade. The export named by --export must be one theguest advertises in its describe() self-report, or the call is rejected beforethe guest runs.
The command has two forms. The artifact form takes no positional argument andloads the guest bare. The entity form takes a Plugin entity file as its onepositional argument: the entity is schema-validated, and its declaredmetadata.pluginType and export contract are cross-checked against the guest'sdescribe() 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 valuebeginning with @ reads the payload bytes from a file (--with @input.json); anyother value is taken as a literal inline JSON payload (--with '{"k":1}'). When--with is omitted, the export receives the minimal empty JSON object {}. Theresolved payload is validated as JSON before the guest runs, so malformed inputis reported up front.
An export a socket calls with a payload reads it in a binary encoding ratherthan 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 noflag selects it: the resolved payload is converted into the encoding the namedexport reads before the guest is called. The conversion reads the payload'sshape from the export's name, so it covers each export a socket calls bydefault; an entry function an attachment or a pipeline step names under a nameof its own receives the payload as written. The authored payload stays JSONeither way.
The answer is converted the same way in reverse. An export a socket callsanswers in that binary encoding, so its answer is read as the export's outputshape and written to stdout as indented JSON; an answer that is not that shapeis reported as an error naming the export rather than printed. A cli_runexport's answer, and an entry function under a name of its own, are written tostdout exactly as the guest wrote them. When the guest exits non-zero, what itwrote is passed through unchanged.
In the artifact form, --type optionally names a plugin type the guest'sdescribe() self-report must agree with, or the load is rejected before theguest 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 failureinside the plugin is distinguishable from a failure of aggrega itself.Flag aggrega plugin run-local
| Flag | Default | Deskripsi |
|---|---|---|
--export | — | export terdeklarasi yang akan dipanggil |
--plugin | — | jalur sistem file ke artefak .wasm |
--type | — | tipe plugin yang harus cocok dengan laporan diri describe() milik guest |
--with | — | payload untuk export: JSON inline, atau @ |
Deskripsi 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 maycall, derived from the plugin's .wasm import section, and the top-level commands aCLI plugin contributes, read from the plugin's describe() self-report. Both areground truth in the binary. This command reads the .wasm, derives thehost-function set in canonical form and the command mirror in describe()-declaredorder, and aligns the entity's spec.runtime.hostFunctions and spec.commands withthem — creating the runtime block when the file has none. Only those blockschange; every comment, blank line, and other field is preserved byte-for-byte. Aplugin that imports no host functions or contributes no commands records anexplicit empty list, so each field is always present and reviewable.
The write is idempotent: re-running when the records already match the .wasmleaves the file untouched. Commit the result; publish (aggrega push) then onlyverifies the committed records against the .wasm and refuses to publish a filewhose records are out of sync with its binary.Flag aggrega plugin sync
| Flag | Default | Deskripsi |
|---|---|---|
--plugin | — | Jalur ke artefak .wasm plugin yang import dan describe()-nya menentukan fungsi host dan perintah yang dicatat |
Apa yang dilakukan entri importer
aggrega plugin add importer menulis identitas plugin dan versi terbaru yang dipublikasikan untuknya, atau versi yang Anda sebutkan sebagai <name>:<version> — importer/<name>:<version> — ke dalam daftar plugins.importer. Entri tersebut melampirkan importer yang disebutkannya: impor yang meminta format yang diiklankan importer menjalankan importer tersebut, pada versi tersebut, bahkan ketika importer lain di katalog Anda juga mengiklankan format itu, dan hanya importer tersebut yang menerima apa yang dibawa entri di bawah with. Importer mana yang mengubah sumber menjadi draf menjelaskan entri ini secara lengkap.
Importer dilampirkan oleh satu entri, sehingga menambahkan importer yang sudah disebutkan dalam daftar plugins.importer file yang sedang ditulis — pada versi apa pun, atau melalui rentang — tidak menambahkan entri kedua. Sebagai gantinya, perintah ini memindahkan entri tersebut ke versi yang di-resolve-nya: entri tetap berada di posisinya dalam daftar dan mempertahankan semua yang dibawanya di bawah with. Menambahkan importer pada versi yang sudah disebutkan entrinya membiarkan entri apa adanya.
Perintah plugin CLI dan flag-nya
Setiap kali aggrega dimulai, ia menambahkan satu perintah untuk setiap perintah yang dikontribusikan plugin cli yang dikonfigurasi, dengan membaca perintah dan flag-nya dari laporan diri describe() plugin — dari cache describe ketika cache tersebut menyimpan digest plugin yang di-pin, dan jika tidak, dengan meminta deskripsi dari plugin. Setiap flag yang dideklarasikan dideklarasikan pada perintahnya, sehingga aggrega help <command> mencantumkannya seperti mencantumkan flag perintah bawaan; plugin tetap menerima argumennya tanpa di-parse dan membaca flag-nya sendiri.
Digest yang di-pin berada di samping referensi plugin dalam daftar plugins.cli konfigurasi, ditulis sebagai sha256: diikuti 64 digit heksadesimal huruf kecil — ejaan yang dicatat oleh aggrega plugin add cli. Digest yang dieja dengan cara lain, seperti heksadesimal polos tanpa prefiks sha256:, ditolak saat file konfigurasi dimuat, dengan menyebutkan file dan entrinya; sampai diperbaiki, tidak ada perintah plugin terkonfigurasi yang ditambahkan, dan peringatan di error standar membawa penolakan tersebut.
Sebelum menambahkan perintah apa pun dari sebuah plugin, aggrega memeriksa setiap flag yang dideklarasikan masing-masing perintah. Plugin yang deklarasinya gagal akan dilewati: tidak ada perintahnya yang ditambahkan, satu peringatan di error standar menyebutkan plugin, perintah, flag, dan apa yang salah dengannya, dan setiap perintah lain — bawaan atau dari plugin lain — berjalan seperti biasa:
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 digitDeklarasi flag lolos ketika:
- flag memiliki nama, dan tidak ada flag lain dari perintah yang sama yang memilikinya;
- bentuk singkatnya, jika ada, adalah satu huruf atau digit ASCII yang tidak digunakan flag lain dari perintah yang sama;
- baik nama maupun bentuk singkatnya tidak menggunakan ulang flag yang sudah dimiliki setiap perintah
aggrega—--help,-h, dan flag global; - tipenya, jika mendeklarasikan satu, adalah
string,bool, atauint— flag tanpa tipe adalah flag string; - nilai default-nya, jika mendeklarasikan satu, adalah nilai dari tipenya.
Pelewatan ini diulang, beserta peringatannya, pada setiap pemanggilan sampai konfigurasi melakukan pin pada versi plugin yang deklarasinya lolos. Bidang-bidang yang dibawa deklarasi flag dijelaskan di bawah spec.commands pada halaman entitas Plugin.
Menghasilkan entitas, dan menyinkronkan catatan: dua jenis tindakan yang berbeda
Dua dari subperintah ini menghasilkan file, dan apa yang dihasilkannya bukan jenis hal yang sama.
plugin gen-catalog — entitas yang dihasilkan adalah milik Anda untuk diedit
aggrega plugin gen-catalog menghasilkan entitas katalog Plugin. Entitas adalah dokumen katalog: Anda menyimpannya, meninjaunya, dan terus mengeditnya bersama sisa katalog Anda. Karena ini adalah konten milik Anda, perintah ini dapat menyerahkannya kepada Anda alih-alih menaruhnya di disk.
--dry-run melakukan semua yang dilakukan gen-catalog kecuali menulis. Opsi ini mengembalikan entitas yang dihasilkan sebagai konten — tidak ada file yang dibuat, tidak ada direktori yang dibuat — dan setiap dokumen dalam jawaban menyebutkan file tujuannya, sehingga pemanggil tahu di mana masing-masing harus diletakkan. Pemanggil yang memiliki model dokumennya sendiri, seperti editor, menaruh konten di sana, tempat Anda melihatnya sebelum disimpan dan dapat mengubah atau membatalkannya. Tanpa flag ini, entitas ditulis di bawah --output-dir, karena pemanggil di terminal tidak memiliki tempat yang lebih baik untuk menaruhnya.
Konten yang dikembalikan dan byte yang ditulis adalah konten yang sama: --dry-run mengembalikan apa yang akan dihasilkan penulisan, bukan pratinjau yang disusun secara terpisah. Setiap perilaku lain juga merupakan perilaku penulisan — guest yang sama dibaca, overlay yang sama dicocokkan, dan --output-dir wajib dalam kedua cara, karena setiap dokumen yang dikembalikan tetap menyebutkan file tujuannya dan jalur tersebut disusun darinya.
Setiap entitas disusun dan divalidasi sebelum satu pun dikirimkan, sehingga satu kali jalan menghasilkan seluruh himpunan atau tidak menghasilkan apa pun. Overlay yang menghentikan pembuatan — yang hilang, atau yang identitasnya tidak cocok dengan guest yang digabungkan dengannya — tidak meninggalkan output yang tertulis sebagian untuk dibersihkan.
plugin sync — catatan yang dikelola mesin adalah milik compiler
aggrega plugin sync menyelaraskan catatan yang dikelola mesin milik plugin dengan modulnya: himpunan fungsi host yang diturunkan dari bagian import modul, dan cerminan perintah yang dibaca dari laporan diri plugin itu sendiri. Keduanya adalah kebenaran dasar di dalam biner, bukan nilai yang dipilih seseorang.
Perintah ini selalu menulis, dan tidak menawarkan --dry-run. Hal itu berlaku meskipun perintah ini menulis ke dalam file entitas yang Anda tulis — batasnya ditarik pada konten, bukan pada file. Catatan yang dikelola compiler tentang dirinya sendiri bukan milik Anda untuk diedit, sehingga tidak ada yang perlu ditinjau sebelum catatan tersebut diterapkan; dokumen di sekitarnya tetap tidak tersentuh byte demi byte, dan hanya blok-blok tersebut yang berubah.