CLICommand referenceappcustom

app custom

Commands, arguments, and options for synq app custom.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

synq app custom

Manage this organization's custom app definitions

synq app custom [options] [command]
SubcommandPurpose
list|ls
add <file>Validate and save a custom app definition
get|export <id>Print a custom template's JSON (for editing or export)
update <id> <file>Replace an existing custom template (its id cannot change)
validate <file>Check a template without saving it (errors and warnings with paths)
from-compose <file>Convert a compose file into template services, config fields and endpoints
from-project <project>Draft a template from an existing project (secret values are never copied)
remove|rm <id>Remove a custom catalog definition

synq app custom add

Validate and save a custom app definition

synq app custom add [options] <file>
ArgumentMeaning
fileAppTemplate JSON file

synq app custom from-compose

Convert a compose file into template services, config fields and endpoints

synq app custom from-compose [options] <file>
ArgumentMeaning
filedocker-compose YAML file

synq app custom from-project

Draft a template from an existing project (secret values are never copied)

synq app custom from-project [options] <project>
ArgumentMeaning
projectProject ID

synq app custom get

Print a custom template's JSON (for editing or export)

synq app custom get|export [options] <id>
ArgumentMeaning
idCustom app ID

synq app custom list

Use this command with the arguments below.

synq app custom list|ls [options]

synq app custom remove

Remove a custom catalog definition

synq app custom remove|rm [options] <id>
ArgumentMeaning
idCustom app ID

synq app custom update

Replace an existing custom template (its id cannot change)

synq app custom update [options] <id> <file>
ArgumentMeaning
idCustom app ID
fileAppTemplate JSON file

synq app custom validate

Check a template without saving it (errors and warnings with paths)

synq app custom validate [options] <file>
ArgumentMeaning
fileAppTemplate JSON file

On this page