shc addon
manage app and vapp add-ons
Reference for the addon command group (module modules/app). Source: modules/app/commands/addon.go.
Add-ons are versioned variable bundles an app package ships beside its
definition, one file per add-on, at
apps/<bucket>/<app>/addons/<name>.addon.yaml, where the filename stem
is the add-on’s identity. An add-on that declares vapp: <name>
configures that vApp; one with no
vapp: key configures the app itself. At install time an add-on is
named, not flagged: shc install <app>/<addon>[@<version>]. The vApp
segment never appears in the command (the add-on file declares its own
vapp:), so both kinds install with the same spelling. This
command group is the read-only catalogue view over those bundles. See
Add-ons (app development) for the
file format and resolution rules.
Subcommands
Section titled “Subcommands”| Command | Purpose |
|---|---|
addon ls <app> | list every add-on the package publishes (app add-ons + every vApp’s) |
addon show <app>/<addon>[@<version>] | show resolved vars for an add-on; no version = the add-on’s default. Takes the same one token shc install takes; two positional arguments are refused |
addon versions <app>/<addon> | list available versions for an add-on |
There is no addon search. Its predecessor (preset search) was a local
disk walk whose --remote flag reached an endpoint doing the SAME local
disk walk on the daemon’s side, so an entry published by a repository was
unfindable by the command whose whole job was finding entries. Searching
the synced catalogue is
shc catalog search; the three verbs here are
deliberately on-disk: they answer questions about a package you have.
addon ls
Section titled “addon ls”| Flag | Type | Help |
|---|---|---|
--app-dir | str | override app directory (default: search apps_dir) |
addon show
Section titled “addon show”| Flag | Type | Help |
|---|---|---|
--app-dir | str | override app directory |
--vapp | str | vapp name (omit for an add-on that declares no vapp:) |
addon versions
Section titled “addon versions”| Flag | Type | Help |
|---|---|---|
--app-dir | str | override app directory |
--vapp | str | vapp name (omit for an add-on that declares no vapp:) |
Every subcommand in this group reads the on-disk apps tree locally. None
of them consults the daemon or the synced catalogue. To search what a
repo sync has indexed, use shc catalog search.
Examples
Section titled “Examples”# What add-ons does the wordpress package ship?shc addon ls wordpress
# Resolved vars for the woocommerce plugin add-on (default version)shc addon show wordpress/woocommerce --vapp plugin
# Pin a version explicitlyshc addon show wordpress/woocommerce@latest --vapp plugin
# Which versions exist?shc addon versions wordpress/woocommerce --vapp plugin
# An add-on that configures the app itself has no vapp: key, so no --vappshc addon show <app>/<addon>
# Find anything spam-related across the SYNCED catalogueshc catalog search spam