diff --git a/cmd/convert.go b/cmd/convert.go index f9d6d867..002004e1 100644 --- a/cmd/convert.go +++ b/cmd/convert.go @@ -79,6 +79,9 @@ var ( var convertCmd = &cobra.Command{ Use: "convert", Short: "Convert a Docker Compose file", + Example: ` kompose --file compose.yaml convert + kompose -f first.yaml -f second.yaml convert + kompose --provider openshift --file compose.yaml convert`, PreRun: func(cmd *cobra.Command, args []string) { // Check that build-config wasn't passed in with --provider=kubernetes diff --git a/cmd/root.go b/cmd/root.go index 68c0a9f6..bebdf803 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -50,9 +50,13 @@ var ( // RootCmd root level flags and commands var RootCmd = &cobra.Command{ - Use: "kompose", - Short: "A tool helping Docker Compose users move to Kubernetes", - Long: `Kompose is a tool to help users who are familiar with docker-compose move to Kubernetes.`, + Use: "kompose", + Short: "A tool helping Docker Compose users move to Kubernetes", + Long: `Kompose is a tool to help users who are familiar with docker-compose move to Kubernetes.`, + Example: ` kompose --file compose.yaml convert + kompose -f first.yaml -f second.yaml convert + kompose --provider openshift --file compose.yaml convert + kompose completion bash`, SilenceErrors: true, // PersistentPreRun will be "inherited" by all children and ran before *every* command unless // the child has overridden the functionality. This functionality was implemented to check / modify