From ae975a818d98d3f2a9c195fb2d27644e268566af Mon Sep 17 00:00:00 2001 From: Martin Jirku Date: Wed, 17 Jan 2024 21:42:48 +0100 Subject: [PATCH] docs(cli): introduce examples in the kompose command Signed-off-by: Martin Jirku --- cmd/convert.go | 3 +++ cmd/root.go | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/cmd/convert.go b/cmd/convert.go index f9d6d867..ebe34ca3 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 docker-voting.yml convert + kompose -f docker-compose.yml -f docker-guestbook.yml convert + kompose --provider openshift --file docker-voting.yml 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..18d0b259 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -53,6 +53,10 @@ 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.`, + Example: ` kompose --file docker-voting.yml convert + kompose -f docker-compose.yml -f docker-guestbook.yml convert + kompose --provider openshift --file docker-voting.yml 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