Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit bbef54c

Browse files
author
Matthieu Nottale
committed
render: Add a long help detailing the various overrides.
1 parent f59c875 commit bbef54c

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

cmd/render.go

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,19 @@ import (
1111
)
1212

1313
var renderCmd = &cobra.Command{
14-
Use: "render <app-name> [-c <compose-files>...] [-e key=value...] [-f settings-file...]",
15-
Short: "Render the composefile for this app",
16-
Args: cobra.ExactArgs(1),
14+
Use: "render <app-name> [-c <compose-files>...] [-e key=value...] [-s settings-file...]",
15+
Short: "Render the Compose file for this app",
16+
Long: `Render generates a Compose file from the application's template and optional additional files.
17+
Override is provided in three different ways:
18+
- External Compose files or template Compose files can be specified with the -c flag.
19+
(Repeat the flag for multiple files). These files will be merged in order with
20+
the app's own Compose file.
21+
- External YAML settings files can be specified with the -s flag. All settings
22+
files are merged in order, the app's settings coming first.
23+
- Individual settings values can be passed directly on the command line with the
24+
-e flag. These value takes precedence over all settings files.
25+
`,
26+
Args: cobra.ExactArgs(1),
1727
Run: func(cmd *cobra.Command, args []string) {
1828
d := make(map[string]string)
1929
for _, v := range renderEnv {
@@ -46,5 +56,5 @@ func init() {
4656
rootCmd.AddCommand(renderCmd)
4757
renderCmd.Flags().StringArrayVarP(&renderComposeFiles, "compose-files", "c", []string{}, "Override Compose files")
4858
renderCmd.Flags().StringArrayVarP(&renderSettingsFile, "settings-files", "s", []string{}, "Override settings files")
49-
renderCmd.Flags().StringArrayVarP(&renderEnv, "env", "e", []string{}, "Override environment values")
59+
renderCmd.Flags().StringArrayVarP(&renderEnv, "env", "e", []string{}, "Override settings values")
5060
}

0 commit comments

Comments
 (0)