Skip to content

edgible template

Browse and deploy apps from the Edgible catalog

Aliases: ls

List published catalog templates

Terminal window
edgible template list [flags]
FlagDescription
--category <category>Filter by category
--search <query>Filter by free-text query (name/description)
--status <status>Filter by verification status

Examples

Terminal window
edgible template list
edgible template list --category productivity
edgible template list --search kuma --json
edgible template list --status verified

Aliases: info

Show a template manifest summary, parameters, and requirements

Terminal window
edgible template get <name> [flags]
FlagDescription
--version <version>Show a specific version (default: latest)
--device <id>Show requirements against a specific device

Examples

Terminal window
edgible template get uptime-kuma
edgible template get nextcloud --version 1.2.0
edgible template get nextcloud --device dev-vm-01

Deploy a catalog template to a device

Terminal window
edgible template deploy <name> [flags]
FlagDescription
--device <id>Target serving device (prompted if omitted)
--name <name>Application name (default: the template name)
--version <version>Template version to deploy (default: latest)
--param <key=value>Set a parameter value (repeatable)
--params-file <path>Read parameter values from a JSON or dotenv file
-y, --yesNever prompt; fail when a required value is missing
--out-file <path>Write the rendered canonical document to a file (”-” for stdout)
--dry-runRender a preview only; nothing is created

Examples

Terminal window
edgible template deploy uptime-kuma --device dev-vm-01
edgible template deploy nextcloud --device dev-vm-01 --param dataSize=20Gi
edgible template deploy nextcloud --device dev-vm-01 --params-file ./nextcloud.env --yes
edgible template deploy nextcloud --device dev-vm-01 --dry-run --out-file -
edgible template deploy nextcloud --device dev-vm-01 --out-file ./nextcloud.yaml

Notes

A secret parameter takes the name of an existing organization secret (name or name:key), never its value. List them with edgible secret list. A --dry-run document is a preview, not a deployable one. Generated secret parameters carry a placeholder, so a real deploy is what creates them.

Re-render a template-deployed application onto a newer template version

Terminal window
edgible template upgrade <application> [flags]
FlagDescription
--version <version>Target template version (default: latest)
--param <key=value>Set a parameter value (repeatable)
--params-file <path>Read parameter values from a JSON or dotenv file
-y, --yesNon-interactive: skip the confirmation and never prompt; fail closed on a missing required value

Examples

Terminal window
edgible template upgrade nextcloud
edgible template upgrade app-1a2b3c --version 1.3.0
edgible template upgrade nextcloud --version 1.3.0 --param smtpHost=mail.example.com --yes

Notes

Carried parameters keep their stored values; only newly declared parameters are asked for. The upgrade cuts a new release — roll back with edgible application rollback <version>. Without a terminal to confirm on (scripts, CI), --yes is required.

Change a template-deployed application’s parameter answers (same template version)

Terminal window
edgible template configure <application> [flags]
FlagDescription
--param <key=value>Set a parameter value (repeatable)
--params-file <path>Read parameter values from a JSON or dotenv file
-y, --yesNon-interactive: apply only the explicit —param/—params-file changes
--showPrint the stored parameter answers and exit without changing anything

Examples

Terminal window
edgible template configure nextcloud --show
edgible template configure nextcloud
edgible template configure nextcloud --param dataSize=50Gi --yes
edgible template configure app-1a2b3c --params-file ./answers.env --yes

Notes

Interactively, every applicable parameter is re-asked with its stored answer preset. A parameter hidden by a visibleIf condition is neither asked nor accepted. Turning its controlling toggle back on asks it again. Values are validated against the template’s declared constraints before anything is written. A configure that changes no answers does nothing; use edgible stack deploy for other edits. The configure cuts a new release — roll back with edgible application rollback <version>.

Cut an application’s link to its catalog template

Terminal window
edgible template eject <application> [flags]
FlagDescription
-y, --yesNon-interactive: skip the confirmation
--out-file <path>Write the ejected canonical document to a file (”-” for stdout) before applying

Examples

Terminal window
edgible template eject nextcloud --out-file ./nextcloud.edgible.yml
edgible template eject app-1a2b3c --yes

Notes

The running workload is unchanged; only the link to the catalog template is cut, so template configure and template upgrade no longer apply. Manage the application with edgible stack deploy from then on. Rolling back to a pre-eject release restores the template link.