From d41759ff153662a4db5ea20a8e8492413956b9f4 Mon Sep 17 00:00:00 2001 From: balopat Date: Wed, 13 Mar 2019 14:34:43 -0700 Subject: [PATCH 1/2] added subcommands to the cli reference --- cmd/skaffold/man/man.go | 31 ++- docs/content/en/docs/references/cli/_index.md | 182 +++++++----------- 2 files changed, 93 insertions(+), 120 deletions(-) diff --git a/cmd/skaffold/man/man.go b/cmd/skaffold/man/man.go index d5b66c036d0..c18f7563408 100644 --- a/cmd/skaffold/man/man.go +++ b/cmd/skaffold/man/man.go @@ -18,6 +18,7 @@ package main import ( "fmt" + "github.com/spf13/cobra" "os" "text/template" @@ -26,7 +27,7 @@ import ( ) const manTemplate = ` -### skaffold {{.Name}} +### {{.UseLine}} {{.Short}} @@ -39,18 +40,30 @@ const manTemplate = ` func main() { command := cmd.NewSkaffoldCommand(os.Stdout, os.Stderr) for _, command := range command.Commands() { - tmpl, err := template.New("test").Parse(manTemplate) - if err != nil { - panic(err) - } - err = tmpl.Execute(os.Stdout, command) - if err != nil { - panic(err) - } + printCommand(command) + } +} + +func printCommand(command *cobra.Command) { + command.DisableFlagsInUseLine = true + tmpl, err := template.New("test").Parse(manTemplate) + if err != nil { + panic(err) + } + err = tmpl.Execute(os.Stdout, command) + if err != nil { + panic(err) + } + if len(command.Flags().Args()) > 0 { fmt.Println("Env vars:") fmt.Println("") command.LocalFlags().VisitAll(func(flag *pflag.Flag) { fmt.Printf("* `%s` (same as --%s)\n", cmd.FlagToEnvVarName(flag), flag.Name) }) } + if command.HasSubCommands() { + for _, subCommand := range command.Commands() { + printCommand(subCommand) + } + } } diff --git a/docs/content/en/docs/references/cli/_index.md b/docs/content/en/docs/references/cli/_index.md index ef1ea40d020..97de98cafbf 100644 --- a/docs/content/en/docs/references/cli/_index.md +++ b/docs/content/en/docs/references/cli/_index.md @@ -60,7 +60,7 @@ Builds the artifacts ``` Usage: - skaffold build [flags] + skaffold build Flags: -b, --build-image stringArray Choose which artifacts to build. Artifacts with image names that contain the expression will be built only. Default is to build sources for all artifacts @@ -84,29 +84,14 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_BUILD_IMAGE` (same as --build-image) -* `SKAFFOLD_CACHE_ARTIFACTS` (same as --cache-artifacts) -* `SKAFFOLD_CACHE_FILE` (same as --cache-file) -* `SKAFFOLD_DEFAULT_REPO` (same as --default-repo) -* `SKAFFOLD_ENABLE_RPC` (same as --enable-rpc) -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_NAMESPACE` (same as --namespace) -* `SKAFFOLD_OUTPUT` (same as --output) -* `SKAFFOLD_PROFILE` (same as --profile) -* `SKAFFOLD_QUIET` (same as --quiet) -* `SKAFFOLD_RPC_PORT` (same as --rpc-port) -* `SKAFFOLD_SKIP_TESTS` (same as --skip-tests) -* `SKAFFOLD_TOOT` (same as --toot) - -### skaffold completion + +### skaffold completion SHELL Output shell completion for the given shell (bash or zsh) ``` Usage: - skaffold completion SHELL [flags] + skaffold completion SHELL Global Flags: --color int Specify the default output color in ANSI escape codes (default 34) @@ -114,8 +99,6 @@ Global Flags: ``` -Env vars: - ### skaffold config @@ -138,8 +121,66 @@ Use "skaffold config [command] --help" for more information about a command. ``` -Env vars: +### skaffold config list + +List all values set in the global Skaffold config + +``` +Usage: + skaffold config list + +Flags: + -a, --all Show values for all kubecontexts + -c, --config string Path to Skaffold config + -k, --kube-context string Kubectl context to set values against + +Global Flags: + --color int Specify the default output color in ANSI escape codes (default 34) + -v, --verbosity string Log level (debug, info, warn, error, fatal, panic) (default "warning") + + +``` + +### skaffold config set + +Set a value in the global Skaffold config + +``` +Usage: + skaffold config set + +Flags: + -c, --config string Path to Skaffold config + -g, --global Set value for global config + -k, --kube-context string Kubectl context to set values against + +Global Flags: + --color int Specify the default output color in ANSI escape codes (default 34) + -v, --verbosity string Log level (debug, info, warn, error, fatal, panic) (default "warning") + + +``` + +### skaffold config unset + +Unset a value in the global Skaffold config + +``` +Usage: + skaffold config unset + +Flags: + -c, --config string Path to Skaffold config + -g, --global Set value for global config + -k, --kube-context string Kubectl context to set values against + +Global Flags: + --color int Specify the default output color in ANSI escape codes (default 34) + -v, --verbosity string Log level (debug, info, warn, error, fatal, panic) (default "warning") + + +``` ### skaffold delete @@ -147,7 +188,7 @@ Delete the deployed resources ``` Usage: - skaffold delete [flags] + skaffold delete Flags: --cache-artifacts Set to true to enable caching of artifacts. @@ -167,18 +208,6 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_CACHE_ARTIFACTS` (same as --cache-artifacts) -* `SKAFFOLD_CACHE_FILE` (same as --cache-file) -* `SKAFFOLD_DEFAULT_REPO` (same as --default-repo) -* `SKAFFOLD_ENABLE_RPC` (same as --enable-rpc) -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_NAMESPACE` (same as --namespace) -* `SKAFFOLD_PROFILE` (same as --profile) -* `SKAFFOLD_RPC_PORT` (same as --rpc-port) -* `SKAFFOLD_SKIP_TESTS` (same as --skip-tests) -* `SKAFFOLD_TOOT` (same as --toot) ### skaffold deploy @@ -186,7 +215,7 @@ Deploys the artifacts ``` Usage: - skaffold deploy [flags] + skaffold deploy Flags: --cache-artifacts Set to true to enable caching of artifacts. @@ -209,21 +238,6 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_CACHE_ARTIFACTS` (same as --cache-artifacts) -* `SKAFFOLD_CACHE_FILE` (same as --cache-file) -* `SKAFFOLD_DEFAULT_REPO` (same as --default-repo) -* `SKAFFOLD_ENABLE_RPC` (same as --enable-rpc) -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_IMAGES` (same as --images) -* `SKAFFOLD_LABEL` (same as --label) -* `SKAFFOLD_NAMESPACE` (same as --namespace) -* `SKAFFOLD_PROFILE` (same as --profile) -* `SKAFFOLD_RPC_PORT` (same as --rpc-port) -* `SKAFFOLD_SKIP_TESTS` (same as --skip-tests) -* `SKAFFOLD_TAIL` (same as --tail) -* `SKAFFOLD_TOOT` (same as --toot) ### skaffold dev @@ -231,7 +245,7 @@ Runs a pipeline file in development mode ``` Usage: - skaffold dev [flags] + skaffold dev Flags: --cache-artifacts Set to true to enable caching of artifacts. @@ -259,26 +273,6 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_CACHE_ARTIFACTS` (same as --cache-artifacts) -* `SKAFFOLD_CACHE_FILE` (same as --cache-file) -* `SKAFFOLD_CLEANUP` (same as --cleanup) -* `SKAFFOLD_DEFAULT_REPO` (same as --default-repo) -* `SKAFFOLD_ENABLE_RPC` (same as --enable-rpc) -* `SKAFFOLD_EXPERIMENTAL_GUI` (same as --experimental-gui) -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_LABEL` (same as --label) -* `SKAFFOLD_NAMESPACE` (same as --namespace) -* `SKAFFOLD_PORT_FORWARD` (same as --port-forward) -* `SKAFFOLD_PROFILE` (same as --profile) -* `SKAFFOLD_RPC_PORT` (same as --rpc-port) -* `SKAFFOLD_SKIP_TESTS` (same as --skip-tests) -* `SKAFFOLD_TAIL` (same as --tail) -* `SKAFFOLD_TOOT` (same as --toot) -* `SKAFFOLD_TRIGGER` (same as --trigger) -* `SKAFFOLD_WATCH_IMAGE` (same as --watch-image) -* `SKAFFOLD_WATCH_POLL_INTERVAL` (same as --watch-poll-interval) ### skaffold diagnose @@ -286,7 +280,7 @@ Run a diagnostic on Skaffold ``` Usage: - skaffold diagnose [flags] + skaffold diagnose Flags: -f, --filename string Filename or URL to the pipeline file (default "skaffold.yaml") @@ -298,10 +292,6 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_PROFILE` (same as --profile) ### skaffold fix @@ -309,7 +299,7 @@ Converts old Skaffold config to newest schema version ``` Usage: - skaffold fix [flags] + skaffold fix Flags: -f, --filename string Filename or URL to the pipeline file (default "skaffold.yaml") @@ -321,10 +311,6 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_OVERWRITE` (same as --overwrite) ### skaffold init @@ -332,7 +318,7 @@ Automatically generate Skaffold configuration for deploying an application ``` Usage: - skaffold init [flags] + skaffold init Flags: --analyze Print all discoverable Dockerfiles and images in JSON format to stdout @@ -349,14 +335,6 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_ANALYZE` (same as --analyze) -* `SKAFFOLD_ARTIFACT` (same as --artifact) -* `SKAFFOLD_COMPOSE_FILE` (same as --compose-file) -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_FORCE` (same as --force) -* `SKAFFOLD_SKIP_BUILD` (same as --skip-build) ### skaffold run @@ -364,7 +342,7 @@ Runs a pipeline file ``` Usage: - skaffold run [flags] + skaffold run Flags: --cache-artifacts Set to true to enable caching of artifacts. @@ -387,21 +365,6 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_CACHE_ARTIFACTS` (same as --cache-artifacts) -* `SKAFFOLD_CACHE_FILE` (same as --cache-file) -* `SKAFFOLD_DEFAULT_REPO` (same as --default-repo) -* `SKAFFOLD_ENABLE_RPC` (same as --enable-rpc) -* `SKAFFOLD_FILENAME` (same as --filename) -* `SKAFFOLD_LABEL` (same as --label) -* `SKAFFOLD_NAMESPACE` (same as --namespace) -* `SKAFFOLD_PROFILE` (same as --profile) -* `SKAFFOLD_RPC_PORT` (same as --rpc-port) -* `SKAFFOLD_SKIP_TESTS` (same as --skip-tests) -* `SKAFFOLD_TAG` (same as --tag) -* `SKAFFOLD_TAIL` (same as --tail) -* `SKAFFOLD_TOOT` (same as --toot) ### skaffold version @@ -409,7 +372,7 @@ Print the version information ``` Usage: - skaffold version [flags] + skaffold version Flags: -o, --output *flags.TemplateFlag Format output with go-template. For full struct documentation, see https://godoc.org/github.com/GoogleContainerTools/skaffold/pkg/skaffold/version#Info (default {{.Version}} @@ -421,6 +384,3 @@ Global Flags: ``` -Env vars: - -* `SKAFFOLD_OUTPUT` (same as --output) From 18266e1ea25714d79d25185e871391c61c77ffb4 Mon Sep 17 00:00:00 2001 From: balopat Date: Wed, 13 Mar 2019 20:00:03 -0700 Subject: [PATCH 2/2] lint --- cmd/skaffold/man/man.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cmd/skaffold/man/man.go b/cmd/skaffold/man/man.go index c18f7563408..a72d9d2f449 100644 --- a/cmd/skaffold/man/man.go +++ b/cmd/skaffold/man/man.go @@ -18,10 +18,11 @@ package main import ( "fmt" - "github.com/spf13/cobra" "os" "text/template" + "github.com/spf13/cobra" + "github.com/GoogleContainerTools/skaffold/cmd/skaffold/app/cmd" "github.com/spf13/pflag" )