Skip to content
SHC Docs

shc preset

manage app and vapp presets

Reference for the preset command group (module modules/app). Source: modules/app/commands/preset.go.

Presets are versioned variable bundles an app ships next to its definition — apps/<name>/preset.yaml for the app itself and apps/<name>/<vapp>.vpreset.yaml per vapp. At install time a preset is applied with shc install <app> --preset NAME[@VERSION]; this command group is the read-only catalog view over those bundles. See Presets (app development) for the file format and resolution rules.

CommandPurpose
preset ls <app>list presets defined in an app (app presets + every vapp’s presets)
preset show <app> <preset-spec>show resolved vars for a preset; spec is NAME[@VERSION], no version = the preset’s default
preset versions <app> <preset>list available versions for a preset
preset search [<query>]search presets across all apps by name, description, or tag
FlagTypeHelp
--app-dirstroverride app directory (default: search apps_dir)
FlagTypeHelp
--app-dirstroverride app directory
--vappstrvapp name (omit to use the parent app’s preset.yaml)
FlagTypeHelp
--app-dirstroverride app directory
--vappstrvapp name (omit to use the parent app’s preset.yaml)
FlagTypeHelp
--appstrrestrict search to a single app
--vappstrrestrict search to a single vapp
--tagstrmatch only presets whose meta.tags contain this tag
--categorystrmatch only presets whose meta.category equals this
--limitintcap the number of results (0 = unlimited)
--remoteboolforce remote (daemon) search instead of local scan

ls/show/versions read the on-disk apps tree locally. search scans locally when an apps tree is available and otherwise (or with --remote) asks the daemon via /api/method/shc.preset.search, so a remote operator can grep the catalog without the apps/ tree mounted.

Terminal window
# What presets does the wordpress app ship?
shc preset ls wordpress
# Resolved vars for the woocommerce plugin preset (default version)
shc preset show wordpress woocommerce --vapp plugin
# Pin a version explicitly
shc preset show wordpress woocommerce@latest --vapp plugin
# Which versions exist?
shc preset versions wordpress woocommerce --vapp plugin
# Find anything spam-related across the whole catalog
shc preset search spam